blob: e989ecb44a65962e887666cb4c595c05f85697ca [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 Torvalds6326c712012-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 Torvalds6326c712012-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/*
Sage Weilf0023bc2011-10-28 10:02:42 -0700359 * dentry_lru_(add|del|prune|move_tail) 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);
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700376 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | 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.
383 */
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700384static void dentry_lru_del(struct dentry *dentry)
385{
386 if (!list_empty(&dentry->d_lru)) {
Dave Chinner19156842013-08-28 10:17:55 +1000387 spin_lock(&dentry->d_sb->s_dentry_lru_lock);
Nick Piggin23044502011-01-07 17:49:31 +1100388 __dentry_lru_del(dentry);
Dave Chinner19156842013-08-28 10:17:55 +1000389 spin_unlock(&dentry->d_sb->s_dentry_lru_lock);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700390 }
391}
392
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000393static void dentry_lru_move_list(struct dentry *dentry, struct list_head *list)
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700394{
Dave Chinner19156842013-08-28 10:17:55 +1000395 spin_lock(&dentry->d_sb->s_dentry_lru_lock);
Christoph Hellwiga4633352010-10-10 05:36:26 -0400396 if (list_empty(&dentry->d_lru)) {
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700397 dentry->d_flags |= DCACHE_LRU_LIST;
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000398 list_add_tail(&dentry->d_lru, list);
Christoph Hellwiga4633352010-10-10 05:36:26 -0400399 dentry->d_sb->s_nr_dentry_unused++;
Dave Chinner62d36c72013-08-28 10:17:54 +1000400 this_cpu_inc(nr_dentry_unused);
Christoph Hellwiga4633352010-10-10 05:36:26 -0400401 } else {
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000402 list_move_tail(&dentry->d_lru, list);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700403 }
Dave Chinner19156842013-08-28 10:17:55 +1000404 spin_unlock(&dentry->d_sb->s_dentry_lru_lock);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700405}
406
Miklos Szeredid52b9082007-05-08 00:23:46 -0700407/**
408 * d_kill - kill dentry and return parent
409 * @dentry: dentry to kill
Randy Dunlapff5fdb62011-01-22 20:16:06 -0800410 * @parent: parent dentry
Miklos Szeredid52b9082007-05-08 00:23:46 -0700411 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200412 * The dentry must already be unhashed and removed from the LRU.
Miklos Szeredid52b9082007-05-08 00:23:46 -0700413 *
414 * If this is the root of the dentry tree, return NULL.
Nick Piggin23044502011-01-07 17:49:31 +1100415 *
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100416 * dentry->d_lock and parent->d_lock must be held by caller, and are dropped by
417 * d_kill.
Miklos Szeredid52b9082007-05-08 00:23:46 -0700418 */
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100419static struct dentry *d_kill(struct dentry *dentry, struct dentry *parent)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200420 __releases(dentry->d_lock)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100421 __releases(parent->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100422 __releases(dentry->d_inode->i_lock)
Miklos Szeredid52b9082007-05-08 00:23:46 -0700423{
Miklos Szeredid52b9082007-05-08 00:23:46 -0700424 list_del(&dentry->d_u.d_child);
Trond Myklebustc83ce982011-03-15 13:36:43 -0400425 /*
426 * Inform try_to_ascend() that we are no longer attached to the
427 * dentry tree
428 */
Miklos Szeredib161dfa62012-09-17 22:31:38 +0200429 dentry->d_flags |= DCACHE_DENTRY_KILLED;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100430 if (parent)
431 spin_unlock(&parent->d_lock);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700432 dentry_iput(dentry);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100433 /*
434 * dentry_iput drops the locks, at which point nobody (except
435 * transient RCU lookups) can reach this dentry.
436 */
Miklos Szeredid52b9082007-05-08 00:23:46 -0700437 d_free(dentry);
OGAWA Hirofumi871c0062008-10-16 07:50:27 +0900438 return parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700439}
440
David Howellsc6627c62011-06-07 14:09:20 +0100441/*
442 * Unhash a dentry without inserting an RCU walk barrier or checking that
443 * dentry->d_lock is locked. The caller must take care of that, if
444 * appropriate.
445 */
446static void __d_shrink(struct dentry *dentry)
447{
448 if (!d_unhashed(dentry)) {
449 struct hlist_bl_head *b;
450 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
451 b = &dentry->d_sb->s_anon;
452 else
453 b = d_hash(dentry->d_parent, dentry->d_name.hash);
454
455 hlist_bl_lock(b);
456 __hlist_bl_del(&dentry->d_hash);
457 dentry->d_hash.pprev = NULL;
458 hlist_bl_unlock(b);
459 }
460}
461
Nick Piggin789680d2011-01-07 17:49:30 +1100462/**
463 * d_drop - drop a dentry
464 * @dentry: dentry to drop
465 *
466 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
467 * be found through a VFS lookup any more. Note that this is different from
468 * deleting the dentry - d_delete will try to mark the dentry negative if
469 * possible, giving a successful _negative_ lookup, while d_drop will
470 * just make the cache lookup fail.
471 *
472 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
473 * reason (NFS timeouts or autofs deletes).
474 *
475 * __d_drop requires dentry->d_lock.
476 */
477void __d_drop(struct dentry *dentry)
478{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700479 if (!d_unhashed(dentry)) {
David Howellsc6627c62011-06-07 14:09:20 +0100480 __d_shrink(dentry);
Linus Torvaldsdea36672011-04-24 07:58:46 -0700481 dentry_rcuwalk_barrier(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +1100482 }
483}
484EXPORT_SYMBOL(__d_drop);
485
486void d_drop(struct dentry *dentry)
487{
Nick Piggin789680d2011-01-07 17:49:30 +1100488 spin_lock(&dentry->d_lock);
489 __d_drop(dentry);
490 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100491}
492EXPORT_SYMBOL(d_drop);
493
Nick Piggin77812a12011-01-07 17:49:48 +1100494/*
495 * Finish off a dentry we've decided to kill.
496 * dentry->d_lock must be held, returns with it unlocked.
497 * If ref is non-zero, then decrement the refcount too.
498 * Returns dentry requiring refcount drop, or NULL if we're done.
499 */
Linus Torvalds0d984392013-09-08 13:46:52 -0700500static inline struct dentry *dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100501 __releases(dentry->d_lock)
502{
Nick Piggin873feea2011-01-07 17:50:06 +1100503 struct inode *inode;
Nick Piggin77812a12011-01-07 17:49:48 +1100504 struct dentry *parent;
505
Nick Piggin873feea2011-01-07 17:50:06 +1100506 inode = dentry->d_inode;
507 if (inode && !spin_trylock(&inode->i_lock)) {
Nick Piggin77812a12011-01-07 17:49:48 +1100508relock:
509 spin_unlock(&dentry->d_lock);
510 cpu_relax();
511 return dentry; /* try again with same dentry */
512 }
513 if (IS_ROOT(dentry))
514 parent = NULL;
515 else
516 parent = dentry->d_parent;
517 if (parent && !spin_trylock(&parent->d_lock)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100518 if (inode)
519 spin_unlock(&inode->i_lock);
Nick Piggin77812a12011-01-07 17:49:48 +1100520 goto relock;
521 }
Nick Piggin31e6b012011-01-07 17:49:52 +1100522
Linus Torvalds0d984392013-09-08 13:46:52 -0700523 /*
524 * The dentry is now unrecoverably dead to the world.
525 */
526 lockref_mark_dead(&dentry->d_lockref);
527
Sage Weilf0023bc2011-10-28 10:02:42 -0700528 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700529 * inform the fs via d_prune that this dentry is about to be
530 * unhashed and destroyed.
531 */
Yan, Zheng590fb512013-08-13 15:42:02 +0800532 if ((dentry->d_flags & DCACHE_OP_PRUNE) && !d_unhashed(dentry))
Yan, Zheng61572bb2013-04-15 14:13:21 +0800533 dentry->d_op->d_prune(dentry);
534
535 dentry_lru_del(dentry);
Nick Piggin77812a12011-01-07 17:49:48 +1100536 /* if it was on the hash then remove it */
537 __d_drop(dentry);
538 return d_kill(dentry, parent);
539}
540
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541/*
542 * This is dput
543 *
544 * This is complicated by the fact that we do not want to put
545 * dentries that are no longer on any hash chain on the unused
546 * list: we'd much rather just get rid of them immediately.
547 *
548 * However, that implies that we have to traverse the dentry
549 * tree upwards to the parents which might _also_ now be
550 * scheduled for deletion (it may have been only waiting for
551 * its last child to go away).
552 *
553 * This tail recursion is done by hand as we don't want to depend
554 * on the compiler to always get this right (gcc generally doesn't).
555 * Real recursion would eat up our stack space.
556 */
557
558/*
559 * dput - release a dentry
560 * @dentry: dentry to release
561 *
562 * Release a dentry. This will drop the usage count and if appropriate
563 * call the dentry unlink method as well as removing it from the queues and
564 * releasing its resources. If the parent dentries were scheduled for release
565 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567void dput(struct dentry *dentry)
568{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700569 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 return;
571
572repeat:
Waiman Long98474232013-08-28 18:24:59 -0700573 if (lockref_put_or_lock(&dentry->d_lockref))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700576 /* Unreachable? Get rid of it */
577 if (unlikely(d_unhashed(dentry)))
578 goto kill_it;
579
580 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100582 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 }
Nick Piggin265ac902010-10-10 05:36:24 -0400584
Jeff Layton39e3c952012-11-28 11:30:53 -0500585 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400586 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400587
Waiman Long98474232013-08-28 18:24:59 -0700588 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100589 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 return;
591
Miklos Szeredid52b9082007-05-08 00:23:46 -0700592kill_it:
Linus Torvalds0d984392013-09-08 13:46:52 -0700593 dentry = dentry_kill(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700594 if (dentry)
595 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700597EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598
599/**
600 * d_invalidate - invalidate a dentry
601 * @dentry: dentry to invalidate
602 *
603 * Try to invalidate the dentry if it turns out to be
604 * possible. If there are other dentries that can be
605 * reached through this one we can't delete it and we
606 * return -EBUSY. On success we return 0.
607 *
608 * no dcache lock.
609 */
610
611int d_invalidate(struct dentry * dentry)
612{
613 /*
614 * If it's already been dropped, return OK.
615 */
Nick Pigginda502952011-01-07 17:49:33 +1100616 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 if (d_unhashed(dentry)) {
Nick Pigginda502952011-01-07 17:49:33 +1100618 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 return 0;
620 }
621 /*
622 * Check whether to do a partial shrink_dcache
623 * to get rid of unused child entries.
624 */
625 if (!list_empty(&dentry->d_subdirs)) {
Nick Pigginda502952011-01-07 17:49:33 +1100626 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 shrink_dcache_parent(dentry);
Nick Pigginda502952011-01-07 17:49:33 +1100628 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 }
630
631 /*
632 * Somebody else still using it?
633 *
634 * If it's a directory, we can't drop it
635 * for fear of somebody re-populating it
636 * with children (even though dropping it
637 * would make it unreachable from the root,
638 * we might still populate it if it was a
639 * working directory or similar).
Al Viro50e69632011-11-07 16:39:57 +0000640 * We also need to leave mountpoints alone,
641 * directory or not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 */
Waiman Long98474232013-08-28 18:24:59 -0700643 if (dentry->d_lockref.count > 1 && dentry->d_inode) {
Al Viro50e69632011-11-07 16:39:57 +0000644 if (S_ISDIR(dentry->d_inode->i_mode) || d_mountpoint(dentry)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 return -EBUSY;
647 }
648 }
649
650 __d_drop(dentry);
651 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 return 0;
653}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700654EXPORT_SYMBOL(d_invalidate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100656/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100657static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658{
Waiman Long98474232013-08-28 18:24:59 -0700659 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660}
661
Nick Piggindc0474b2011-01-07 17:49:43 +1100662static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100663{
Waiman Long98474232013-08-28 18:24:59 -0700664 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100665}
666
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100667struct dentry *dget_parent(struct dentry *dentry)
668{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700669 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100670 struct dentry *ret;
671
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700672 /*
673 * Do optimistic parent lookup without any
674 * locking.
675 */
676 rcu_read_lock();
677 ret = ACCESS_ONCE(dentry->d_parent);
678 gotref = lockref_get_not_zero(&ret->d_lockref);
679 rcu_read_unlock();
680 if (likely(gotref)) {
681 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
682 return ret;
683 dput(ret);
684 }
685
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100686repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100687 /*
688 * Don't need rcu_dereference because we re-check it was correct under
689 * the lock.
690 */
691 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100692 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100693 spin_lock(&ret->d_lock);
694 if (unlikely(ret != dentry->d_parent)) {
695 spin_unlock(&ret->d_lock);
696 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100697 goto repeat;
698 }
Nick Piggina734eb42011-01-07 17:49:44 +1100699 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700700 BUG_ON(!ret->d_lockref.count);
701 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100702 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100703 return ret;
704}
705EXPORT_SYMBOL(dget_parent);
706
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707/**
708 * d_find_alias - grab a hashed alias of inode
709 * @inode: inode in question
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700710 * @want_discon: flag, used by d_splice_alias, to request
711 * that only a DISCONNECTED alias be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 *
713 * If inode has a hashed alias, or is a directory and has any alias,
714 * acquire the reference to alias and return it. Otherwise return NULL.
715 * Notice that if inode is a directory there can be only one alias and
716 * it can be unhashed only if it has no children, or if it is the root
717 * of a filesystem.
718 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700719 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700720 * any other hashed alias over that one unless @want_discon is set,
721 * in which case only return an IS_ROOT, DCACHE_DISCONNECTED alias.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 */
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700723static struct dentry *__d_find_alias(struct inode *inode, int want_discon)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724{
Nick Pigginda502952011-01-07 17:49:33 +1100725 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Nick Pigginda502952011-01-07 17:49:33 +1100727again:
728 discon_alias = NULL;
Sasha Levinb67bfe02013-02-27 17:06:00 -0800729 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100730 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700732 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100733 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 discon_alias = alias;
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700735 } else if (!want_discon) {
Nick Piggindc0474b2011-01-07 17:49:43 +1100736 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100737 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 return alias;
739 }
740 }
Nick Pigginda502952011-01-07 17:49:33 +1100741 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 }
Nick Pigginda502952011-01-07 17:49:33 +1100743 if (discon_alias) {
744 alias = discon_alias;
745 spin_lock(&alias->d_lock);
746 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
747 if (IS_ROOT(alias) &&
748 (alias->d_flags & DCACHE_DISCONNECTED)) {
Nick Piggindc0474b2011-01-07 17:49:43 +1100749 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100750 spin_unlock(&alias->d_lock);
751 return alias;
752 }
753 }
754 spin_unlock(&alias->d_lock);
755 goto again;
756 }
757 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758}
759
Nick Pigginda502952011-01-07 17:49:33 +1100760struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761{
David Howells214fda12006-03-25 03:06:36 -0800762 struct dentry *de = NULL;
763
Al Virob3d9b7a2012-06-09 13:51:19 -0400764 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100765 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700766 de = __d_find_alias(inode, 0);
Nick Piggin873feea2011-01-07 17:50:06 +1100767 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800768 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 return de;
770}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700771EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
773/*
774 * Try to kill dentries associated with this inode.
775 * WARNING: you must own a reference to inode.
776 */
777void d_prune_aliases(struct inode *inode)
778{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700779 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100781 spin_lock(&inode->i_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -0800782 hlist_for_each_entry(dentry, &inode->i_dentry, d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700784 if (!dentry->d_lockref.count) {
Yan, Zheng590fb512013-08-13 15:42:02 +0800785 /*
786 * inform the fs via d_prune that this dentry
787 * is about to be unhashed and destroyed.
788 */
789 if ((dentry->d_flags & DCACHE_OP_PRUNE) &&
790 !d_unhashed(dentry))
791 dentry->d_op->d_prune(dentry);
792
Nick Piggindc0474b2011-01-07 17:49:43 +1100793 __dget_dlock(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 __d_drop(dentry);
795 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100796 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 dput(dentry);
798 goto restart;
799 }
800 spin_unlock(&dentry->d_lock);
801 }
Nick Piggin873feea2011-01-07 17:50:06 +1100802 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700804EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
806/*
Nick Piggin77812a12011-01-07 17:49:48 +1100807 * Try to throw away a dentry - free the inode, dput the parent.
808 * Requires dentry->d_lock is held, and dentry->d_count == 0.
809 * Releases dentry->d_lock.
Andrew Mortond702ccb2006-06-22 14:47:31 -0700810 *
Nick Piggin77812a12011-01-07 17:49:48 +1100811 * This may fail if locks cannot be acquired no problem, just try again.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 */
Nick Piggin77812a12011-01-07 17:49:48 +1100813static void try_prune_one_dentry(struct dentry *dentry)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200814 __releases(dentry->d_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815{
Nick Piggin77812a12011-01-07 17:49:48 +1100816 struct dentry *parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700817
Linus Torvalds0d984392013-09-08 13:46:52 -0700818 parent = dentry_kill(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700819 /*
Nick Piggin77812a12011-01-07 17:49:48 +1100820 * If dentry_kill returns NULL, we have nothing more to do.
821 * if it returns the same dentry, trylocks failed. In either
822 * case, just loop again.
823 *
824 * Otherwise, we need to prune ancestors too. This is necessary
825 * to prevent quadratic behavior of shrink_dcache_parent(), but
826 * is also expected to be beneficial in reducing dentry cache
827 * fragmentation.
Miklos Szeredid52b9082007-05-08 00:23:46 -0700828 */
Nick Piggin77812a12011-01-07 17:49:48 +1100829 if (!parent)
830 return;
831 if (parent == dentry)
832 return;
833
834 /* Prune ancestors. */
835 dentry = parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700836 while (dentry) {
Waiman Long98474232013-08-28 18:24:59 -0700837 if (lockref_put_or_lock(&dentry->d_lockref))
Nick Piggin89e60542011-01-07 17:49:45 +1100838 return;
Linus Torvalds0d984392013-09-08 13:46:52 -0700839 dentry = dentry_kill(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700840 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841}
842
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400843static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844{
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700845 struct dentry *dentry;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700846
Nick Pigginec336792011-01-07 17:49:47 +1100847 rcu_read_lock();
848 for (;;) {
Nick Pigginec336792011-01-07 17:49:47 +1100849 dentry = list_entry_rcu(list->prev, struct dentry, d_lru);
850 if (&dentry->d_lru == list)
851 break; /* empty */
852 spin_lock(&dentry->d_lock);
853 if (dentry != list_entry(list->prev, struct dentry, d_lru)) {
854 spin_unlock(&dentry->d_lock);
Nick Piggin23044502011-01-07 17:49:31 +1100855 continue;
856 }
857
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 /*
859 * We found an inuse dentry which was not removed from
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700860 * the LRU because of laziness during lookup. Do not free
861 * it - just keep it off the LRU list.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 */
Waiman Long98474232013-08-28 18:24:59 -0700863 if (dentry->d_lockref.count) {
Nick Pigginec336792011-01-07 17:49:47 +1100864 dentry_lru_del(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700865 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 continue;
867 }
Nick Pigginec336792011-01-07 17:49:47 +1100868
Nick Pigginec336792011-01-07 17:49:47 +1100869 rcu_read_unlock();
Nick Piggin77812a12011-01-07 17:49:48 +1100870
871 try_prune_one_dentry(dentry);
872
Nick Pigginec336792011-01-07 17:49:47 +1100873 rcu_read_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 }
Nick Pigginec336792011-01-07 17:49:47 +1100875 rcu_read_unlock();
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400876}
877
878/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000879 * prune_dcache_sb - shrink the dcache
880 * @sb: superblock
881 * @count: number of entries to try to free
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400882 *
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000883 * Attempt to shrink the superblock dcache LRU by @count entries. This is
884 * done when we need more memory an called from the superblock shrinker
885 * function.
886 *
887 * This function may fail to free any resources if all the dentries are in
888 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400889 */
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000890void prune_dcache_sb(struct super_block *sb, int count)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400891{
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400892 struct dentry *dentry;
893 LIST_HEAD(referenced);
894 LIST_HEAD(tmp);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400895
Nick Piggin23044502011-01-07 17:49:31 +1100896relock:
Dave Chinner19156842013-08-28 10:17:55 +1000897 spin_lock(&sb->s_dentry_lru_lock);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400898 while (!list_empty(&sb->s_dentry_lru)) {
899 dentry = list_entry(sb->s_dentry_lru.prev,
900 struct dentry, d_lru);
901 BUG_ON(dentry->d_sb != sb);
902
Nick Piggin23044502011-01-07 17:49:31 +1100903 if (!spin_trylock(&dentry->d_lock)) {
Dave Chinner19156842013-08-28 10:17:55 +1000904 spin_unlock(&sb->s_dentry_lru_lock);
Nick Piggin23044502011-01-07 17:49:31 +1100905 cpu_relax();
906 goto relock;
907 }
908
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000909 if (dentry->d_flags & DCACHE_REFERENCED) {
Nick Piggin23044502011-01-07 17:49:31 +1100910 dentry->d_flags &= ~DCACHE_REFERENCED;
911 list_move(&dentry->d_lru, &referenced);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400912 spin_unlock(&dentry->d_lock);
Nick Piggin23044502011-01-07 17:49:31 +1100913 } else {
914 list_move_tail(&dentry->d_lru, &tmp);
Miklos Szeredieaf5f902012-01-10 18:22:25 +0100915 dentry->d_flags |= DCACHE_SHRINK_LIST;
Nick Piggin23044502011-01-07 17:49:31 +1100916 spin_unlock(&dentry->d_lock);
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000917 if (!--count)
Nick Piggin23044502011-01-07 17:49:31 +1100918 break;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400919 }
Dave Chinner19156842013-08-28 10:17:55 +1000920 cond_resched_lock(&sb->s_dentry_lru_lock);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400921 }
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700922 if (!list_empty(&referenced))
923 list_splice(&referenced, &sb->s_dentry_lru);
Dave Chinner19156842013-08-28 10:17:55 +1000924 spin_unlock(&sb->s_dentry_lru_lock);
Nick Pigginec336792011-01-07 17:49:47 +1100925
926 shrink_dentry_list(&tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927}
928
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700929/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 * shrink_dcache_sb - shrink dcache for a superblock
931 * @sb: superblock
932 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400933 * Shrink the dcache for the specified super block. This is used to free
934 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400936void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937{
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400938 LIST_HEAD(tmp);
939
Dave Chinner19156842013-08-28 10:17:55 +1000940 spin_lock(&sb->s_dentry_lru_lock);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400941 while (!list_empty(&sb->s_dentry_lru)) {
942 list_splice_init(&sb->s_dentry_lru, &tmp);
Dave Chinner19156842013-08-28 10:17:55 +1000943 spin_unlock(&sb->s_dentry_lru_lock);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400944 shrink_dentry_list(&tmp);
Dave Chinner19156842013-08-28 10:17:55 +1000945 spin_lock(&sb->s_dentry_lru_lock);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400946 }
Dave Chinner19156842013-08-28 10:17:55 +1000947 spin_unlock(&sb->s_dentry_lru_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700949EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
951/*
David Howellsc636ebd2006-10-11 01:22:19 -0700952 * destroy a single subtree of dentries for unmount
953 * - see the comments on shrink_dcache_for_umount() for a description of the
954 * locking
955 */
956static void shrink_dcache_for_umount_subtree(struct dentry *dentry)
957{
958 struct dentry *parent;
959
960 BUG_ON(!IS_ROOT(dentry));
961
David Howellsc636ebd2006-10-11 01:22:19 -0700962 for (;;) {
963 /* descend to the first leaf in the current subtree */
David Howells43c1c9c2011-06-07 14:09:30 +0100964 while (!list_empty(&dentry->d_subdirs))
David Howellsc636ebd2006-10-11 01:22:19 -0700965 dentry = list_entry(dentry->d_subdirs.next,
966 struct dentry, d_u.d_child);
David Howellsc636ebd2006-10-11 01:22:19 -0700967
968 /* consume the dentries from this leaf up through its parents
969 * until we find one with children or run out altogether */
970 do {
971 struct inode *inode;
972
Sage Weilf0023bc2011-10-28 10:02:42 -0700973 /*
Yan, Zheng61572bb2013-04-15 14:13:21 +0800974 * inform the fs that this dentry is about to be
Sage Weilf0023bc2011-10-28 10:02:42 -0700975 * unhashed and destroyed.
976 */
Yan, Zheng590fb512013-08-13 15:42:02 +0800977 if ((dentry->d_flags & DCACHE_OP_PRUNE) &&
978 !d_unhashed(dentry))
Yan, Zheng61572bb2013-04-15 14:13:21 +0800979 dentry->d_op->d_prune(dentry);
980
981 dentry_lru_del(dentry);
David Howells43c1c9c2011-06-07 14:09:30 +0100982 __d_shrink(dentry);
983
Waiman Long98474232013-08-28 18:24:59 -0700984 if (dentry->d_lockref.count != 0) {
David Howellsc636ebd2006-10-11 01:22:19 -0700985 printk(KERN_ERR
986 "BUG: Dentry %p{i=%lx,n=%s}"
987 " still in use (%d)"
988 " [unmount of %s %s]\n",
989 dentry,
990 dentry->d_inode ?
991 dentry->d_inode->i_ino : 0UL,
992 dentry->d_name.name,
Waiman Long98474232013-08-28 18:24:59 -0700993 dentry->d_lockref.count,
David Howellsc636ebd2006-10-11 01:22:19 -0700994 dentry->d_sb->s_type->name,
995 dentry->d_sb->s_id);
996 BUG();
997 }
998
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100999 if (IS_ROOT(dentry)) {
David Howellsc636ebd2006-10-11 01:22:19 -07001000 parent = NULL;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001001 list_del(&dentry->d_u.d_child);
1002 } else {
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09001003 parent = dentry->d_parent;
Waiman Long98474232013-08-28 18:24:59 -07001004 parent->d_lockref.count--;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001005 list_del(&dentry->d_u.d_child);
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09001006 }
David Howellsc636ebd2006-10-11 01:22:19 -07001007
David Howellsc636ebd2006-10-11 01:22:19 -07001008 inode = dentry->d_inode;
1009 if (inode) {
1010 dentry->d_inode = NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001011 hlist_del_init(&dentry->d_alias);
David Howellsc636ebd2006-10-11 01:22:19 -07001012 if (dentry->d_op && dentry->d_op->d_iput)
1013 dentry->d_op->d_iput(dentry, inode);
1014 else
1015 iput(inode);
1016 }
1017
1018 d_free(dentry);
1019
1020 /* finished when we fall off the top of the tree,
1021 * otherwise we ascend to the parent and move to the
1022 * next sibling if there is one */
1023 if (!parent)
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001024 return;
David Howellsc636ebd2006-10-11 01:22:19 -07001025 dentry = parent;
David Howellsc636ebd2006-10-11 01:22:19 -07001026 } while (list_empty(&dentry->d_subdirs));
1027
1028 dentry = list_entry(dentry->d_subdirs.next,
1029 struct dentry, d_u.d_child);
1030 }
1031}
1032
1033/*
1034 * destroy the dentries attached to a superblock on unmounting
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001035 * - we don't need to use dentry->d_lock because:
David Howellsc636ebd2006-10-11 01:22:19 -07001036 * - the superblock is detached from all mountings and open files, so the
1037 * dentry trees will not be rearranged by the VFS
1038 * - s_umount is write-locked, so the memory pressure shrinker will ignore
1039 * any dentries belonging to this superblock that it comes across
1040 * - the filesystem itself is no longer permitted to rearrange the dentries
1041 * in this superblock
1042 */
1043void shrink_dcache_for_umount(struct super_block *sb)
1044{
1045 struct dentry *dentry;
1046
1047 if (down_read_trylock(&sb->s_umount))
1048 BUG();
1049
1050 dentry = sb->s_root;
1051 sb->s_root = NULL;
Waiman Long98474232013-08-28 18:24:59 -07001052 dentry->d_lockref.count--;
David Howellsc636ebd2006-10-11 01:22:19 -07001053 shrink_dcache_for_umount_subtree(dentry);
1054
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001055 while (!hlist_bl_empty(&sb->s_anon)) {
1056 dentry = hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash);
David Howellsc636ebd2006-10-11 01:22:19 -07001057 shrink_dcache_for_umount_subtree(dentry);
1058 }
1059}
1060
1061/*
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001062 * This tries to ascend one level of parenthood, but
1063 * we can race with renaming, so we need to re-check
1064 * the parenthood after dropping the lock and check
1065 * that the sequence number still matches.
1066 */
Al Viro48f5ec22013-09-09 15:22:25 -04001067static struct dentry *try_to_ascend(struct dentry *old, unsigned seq)
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001068{
1069 struct dentry *new = old->d_parent;
1070
1071 rcu_read_lock();
1072 spin_unlock(&old->d_lock);
1073 spin_lock(&new->d_lock);
1074
1075 /*
1076 * might go back up the wrong parent if we have had a rename
1077 * or deletion
1078 */
1079 if (new != old->d_parent ||
Miklos Szeredib161dfa62012-09-17 22:31:38 +02001080 (old->d_flags & DCACHE_DENTRY_KILLED) ||
Al Viro48f5ec22013-09-09 15:22:25 -04001081 need_seqretry(&rename_lock, seq)) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001082 spin_unlock(&new->d_lock);
1083 new = NULL;
1084 }
1085 rcu_read_unlock();
1086 return new;
1087}
1088
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001090 * enum d_walk_ret - action to talke during tree walk
1091 * @D_WALK_CONTINUE: contrinue walk
1092 * @D_WALK_QUIT: quit walk
1093 * @D_WALK_NORETRY: quit when retry is needed
1094 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001096enum d_walk_ret {
1097 D_WALK_CONTINUE,
1098 D_WALK_QUIT,
1099 D_WALK_NORETRY,
1100 D_WALK_SKIP,
1101};
1102
1103/**
1104 * d_walk - walk the dentry tree
1105 * @parent: start of walk
1106 * @data: data passed to @enter() and @finish()
1107 * @enter: callback when first entering the dentry
1108 * @finish: callback when successfully finished the walk
1109 *
1110 * The @enter() and @finish() callbacks are called with d_lock held.
1111 */
1112static void d_walk(struct dentry *parent, void *data,
1113 enum d_walk_ret (*enter)(void *, struct dentry *),
1114 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115{
Nick Piggin949854d2011-01-07 17:49:37 +11001116 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001118 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001119 enum d_walk_ret ret;
1120 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001121
Nick Piggin58db63d2011-01-07 17:49:39 +11001122again:
Al Viro48f5ec22013-09-09 15:22:25 -04001123 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001124 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001125 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001126
1127 ret = enter(data, this_parent);
1128 switch (ret) {
1129 case D_WALK_CONTINUE:
1130 break;
1131 case D_WALK_QUIT:
1132 case D_WALK_SKIP:
1133 goto out_unlock;
1134 case D_WALK_NORETRY:
1135 retry = false;
1136 break;
1137 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138repeat:
1139 next = this_parent->d_subdirs.next;
1140resume:
1141 while (next != &this_parent->d_subdirs) {
1142 struct list_head *tmp = next;
Eric Dumazet5160ee62006-01-08 01:03:32 -08001143 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001145
1146 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001147
1148 ret = enter(data, dentry);
1149 switch (ret) {
1150 case D_WALK_CONTINUE:
1151 break;
1152 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001153 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001154 goto out_unlock;
1155 case D_WALK_NORETRY:
1156 retry = false;
1157 break;
1158 case D_WALK_SKIP:
1159 spin_unlock(&dentry->d_lock);
1160 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001161 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001162
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001164 spin_unlock(&this_parent->d_lock);
1165 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001167 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 goto repeat;
1169 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001170 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 }
1172 /*
1173 * All done at this level ... ascend and resume the search.
1174 */
1175 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001176 struct dentry *child = this_parent;
Al Viro48f5ec22013-09-09 15:22:25 -04001177 this_parent = try_to_ascend(this_parent, seq);
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001178 if (!this_parent)
Nick Piggin949854d2011-01-07 17:49:37 +11001179 goto rename_retry;
Nick Piggin949854d2011-01-07 17:49:37 +11001180 next = child->d_u.d_child.next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 goto resume;
1182 }
Al Viro48f5ec22013-09-09 15:22:25 -04001183 if (need_seqretry(&rename_lock, seq)) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001184 spin_unlock(&this_parent->d_lock);
1185 goto rename_retry;
1186 }
1187 if (finish)
1188 finish(data);
1189
1190out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001191 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001192 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001193 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001194
1195rename_retry:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001196 if (!retry)
1197 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001198 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001199 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001201
1202/*
1203 * Search for at least 1 mount point in the dentry's subdirs.
1204 * We descend to the next level whenever the d_subdirs
1205 * list is non-empty and continue searching.
1206 */
1207
1208/**
1209 * have_submounts - check for mounts over a dentry
1210 * @parent: dentry to check.
1211 *
1212 * Return true if the parent or its subdirectories contain
1213 * a mount point
1214 */
1215
1216static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1217{
1218 int *ret = data;
1219 if (d_mountpoint(dentry)) {
1220 *ret = 1;
1221 return D_WALK_QUIT;
1222 }
1223 return D_WALK_CONTINUE;
1224}
1225
1226int have_submounts(struct dentry *parent)
1227{
1228 int ret = 0;
1229
1230 d_walk(parent, &ret, check_mount, NULL);
1231
1232 return ret;
1233}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001234EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235
1236/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001237 * Called by mount code to set a mountpoint and check if the mountpoint is
1238 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1239 * subtree can become unreachable).
1240 *
1241 * Only one of check_submounts_and_drop() and d_set_mounted() must succeed. For
1242 * this reason take rename_lock and d_lock on dentry and ancestors.
1243 */
1244int d_set_mounted(struct dentry *dentry)
1245{
1246 struct dentry *p;
1247 int ret = -ENOENT;
1248 write_seqlock(&rename_lock);
1249 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
1250 /* Need exclusion wrt. check_submounts_and_drop() */
1251 spin_lock(&p->d_lock);
1252 if (unlikely(d_unhashed(p))) {
1253 spin_unlock(&p->d_lock);
1254 goto out;
1255 }
1256 spin_unlock(&p->d_lock);
1257 }
1258 spin_lock(&dentry->d_lock);
1259 if (!d_unlinked(dentry)) {
1260 dentry->d_flags |= DCACHE_MOUNTED;
1261 ret = 0;
1262 }
1263 spin_unlock(&dentry->d_lock);
1264out:
1265 write_sequnlock(&rename_lock);
1266 return ret;
1267}
1268
1269/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001270 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 * and move any unused dentries to the end of the unused
1272 * list for prune_dcache(). We descend to the next level
1273 * whenever the d_subdirs list is non-empty and continue
1274 * searching.
1275 *
1276 * It returns zero iff there are no unused children,
1277 * otherwise it returns the number of children moved to
1278 * the end of the unused list. This may not be the total
1279 * number of unused children, because select_parent can
1280 * drop the lock and return early due to latency
1281 * constraints.
1282 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001283
1284struct select_data {
1285 struct dentry *start;
1286 struct list_head dispose;
1287 int found;
1288};
1289
1290static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001292 struct select_data *data = _data;
1293 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001295 if (data->start == dentry)
1296 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001298 /*
1299 * move only zero ref count dentries to the dispose list.
1300 *
1301 * Those which are presently on the shrink list, being processed
1302 * by shrink_dentry_list(), shouldn't be moved. Otherwise the
1303 * loop in shrink_dcache_parent() might not make any progress
1304 * and loop forever.
1305 */
1306 if (dentry->d_lockref.count) {
1307 dentry_lru_del(dentry);
1308 } else if (!(dentry->d_flags & DCACHE_SHRINK_LIST)) {
1309 dentry_lru_move_list(dentry, &data->dispose);
1310 dentry->d_flags |= DCACHE_SHRINK_LIST;
1311 data->found++;
1312 ret = D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 }
1314 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001315 * We can return to the caller if we have found some (this
1316 * ensures forward progress). We'll be coming back to find
1317 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001319 if (data->found && need_resched())
1320 ret = D_WALK_QUIT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001322 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323}
1324
1325/**
1326 * shrink_dcache_parent - prune dcache
1327 * @parent: parent of entries to prune
1328 *
1329 * Prune the dcache to remove unused children of the parent dentry.
1330 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001331void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001333 for (;;) {
1334 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001336 INIT_LIST_HEAD(&data.dispose);
1337 data.start = parent;
1338 data.found = 0;
1339
1340 d_walk(parent, &data, select_collect, NULL);
1341 if (!data.found)
1342 break;
1343
1344 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001345 cond_resched();
1346 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001348EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001350static enum d_walk_ret check_and_collect(void *_data, struct dentry *dentry)
1351{
1352 struct select_data *data = _data;
1353
1354 if (d_mountpoint(dentry)) {
1355 data->found = -EBUSY;
1356 return D_WALK_QUIT;
1357 }
1358
1359 return select_collect(_data, dentry);
1360}
1361
1362static void check_and_drop(void *_data)
1363{
1364 struct select_data *data = _data;
1365
1366 if (d_mountpoint(data->start))
1367 data->found = -EBUSY;
1368 if (!data->found)
1369 __d_drop(data->start);
1370}
1371
1372/**
1373 * check_submounts_and_drop - prune dcache, check for submounts and drop
1374 *
1375 * All done as a single atomic operation relative to has_unlinked_ancestor().
1376 * Returns 0 if successfully unhashed @parent. If there were submounts then
1377 * return -EBUSY.
1378 *
1379 * @dentry: dentry to prune and drop
1380 */
1381int check_submounts_and_drop(struct dentry *dentry)
1382{
1383 int ret = 0;
1384
1385 /* Negative dentries can be dropped without further checks */
1386 if (!dentry->d_inode) {
1387 d_drop(dentry);
1388 goto out;
1389 }
1390
1391 for (;;) {
1392 struct select_data data;
1393
1394 INIT_LIST_HEAD(&data.dispose);
1395 data.start = dentry;
1396 data.found = 0;
1397
1398 d_walk(dentry, &data, check_and_collect, check_and_drop);
1399 ret = data.found;
1400
1401 if (!list_empty(&data.dispose))
1402 shrink_dentry_list(&data.dispose);
1403
1404 if (ret <= 0)
1405 break;
1406
1407 cond_resched();
1408 }
1409
1410out:
1411 return ret;
1412}
1413EXPORT_SYMBOL(check_submounts_and_drop);
1414
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415/**
Al Viroa4464db2011-07-07 15:03:58 -04001416 * __d_alloc - allocate a dcache entry
1417 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 * @name: qstr of the name
1419 *
1420 * Allocates a dentry. It returns %NULL if there is insufficient memory
1421 * available. On a success the dentry is returned. The name passed in is
1422 * copied and the copy passed in may be reused after this call.
1423 */
1424
Al Viroa4464db2011-07-07 15:03:58 -04001425struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426{
1427 struct dentry *dentry;
1428 char *dname;
1429
Mel Gormane12ba742007-10-16 01:25:52 -07001430 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 if (!dentry)
1432 return NULL;
1433
Linus Torvalds6326c712012-05-21 16:14:04 -07001434 /*
1435 * We guarantee that the inline name is always NUL-terminated.
1436 * This way the memcpy() done by the name switching in rename
1437 * will still always have a NUL at the end, even if we might
1438 * be overwriting an internal NUL character
1439 */
1440 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441 if (name->len > DNAME_INLINE_LEN-1) {
1442 dname = kmalloc(name->len + 1, GFP_KERNEL);
1443 if (!dname) {
1444 kmem_cache_free(dentry_cache, dentry);
1445 return NULL;
1446 }
1447 } else {
1448 dname = dentry->d_iname;
1449 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450
1451 dentry->d_name.len = name->len;
1452 dentry->d_name.hash = name->hash;
1453 memcpy(dname, name->name, name->len);
1454 dname[name->len] = 0;
1455
Linus Torvalds6326c712012-05-21 16:14:04 -07001456 /* Make sure we always see the terminating NUL character */
1457 smp_wmb();
1458 dentry->d_name.name = dname;
1459
Waiman Long98474232013-08-28 18:24:59 -07001460 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001461 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001463 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001465 dentry->d_parent = dentry;
1466 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 dentry->d_op = NULL;
1468 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001469 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 INIT_LIST_HEAD(&dentry->d_lru);
1471 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Virob3d9b7a2012-06-09 13:51:19 -04001472 INIT_HLIST_NODE(&dentry->d_alias);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001473 INIT_LIST_HEAD(&dentry->d_u.d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001474 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475
Nick Piggin3e880fb2011-01-07 17:49:19 +11001476 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001477
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 return dentry;
1479}
Al Viroa4464db2011-07-07 15:03:58 -04001480
1481/**
1482 * d_alloc - allocate a dcache entry
1483 * @parent: parent of entry to allocate
1484 * @name: qstr of the name
1485 *
1486 * Allocates a dentry. It returns %NULL if there is insufficient memory
1487 * available. On a success the dentry is returned. The name passed in is
1488 * copied and the copy passed in may be reused after this call.
1489 */
1490struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1491{
1492 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1493 if (!dentry)
1494 return NULL;
1495
1496 spin_lock(&parent->d_lock);
1497 /*
1498 * don't need child lock because it is not subject
1499 * to concurrency here
1500 */
1501 __dget_dlock(parent);
1502 dentry->d_parent = parent;
1503 list_add(&dentry->d_u.d_child, &parent->d_subdirs);
1504 spin_unlock(&parent->d_lock);
1505
1506 return dentry;
1507}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001508EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
Nick Piggin4b936882011-01-07 17:50:07 +11001510struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1511{
Al Viroa4464db2011-07-07 15:03:58 -04001512 struct dentry *dentry = __d_alloc(sb, name);
1513 if (dentry)
Nick Piggin4b936882011-01-07 17:50:07 +11001514 dentry->d_flags |= DCACHE_DISCONNECTED;
Nick Piggin4b936882011-01-07 17:50:07 +11001515 return dentry;
1516}
1517EXPORT_SYMBOL(d_alloc_pseudo);
1518
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1520{
1521 struct qstr q;
1522
1523 q.name = name;
1524 q.len = strlen(name);
1525 q.hash = full_name_hash(q.name, q.len);
1526 return d_alloc(parent, &q);
1527}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001528EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
Nick Pigginfb045ad2011-01-07 17:49:55 +11001530void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1531{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001532 WARN_ON_ONCE(dentry->d_op);
1533 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001534 DCACHE_OP_COMPARE |
1535 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001536 DCACHE_OP_WEAK_REVALIDATE |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001537 DCACHE_OP_DELETE ));
1538 dentry->d_op = op;
1539 if (!op)
1540 return;
1541 if (op->d_hash)
1542 dentry->d_flags |= DCACHE_OP_HASH;
1543 if (op->d_compare)
1544 dentry->d_flags |= DCACHE_OP_COMPARE;
1545 if (op->d_revalidate)
1546 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001547 if (op->d_weak_revalidate)
1548 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001549 if (op->d_delete)
1550 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001551 if (op->d_prune)
1552 dentry->d_flags |= DCACHE_OP_PRUNE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001553
1554}
1555EXPORT_SYMBOL(d_set_d_op);
1556
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001557static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1558{
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001559 spin_lock(&dentry->d_lock);
David Howells9875cf82011-01-14 18:45:21 +00001560 if (inode) {
1561 if (unlikely(IS_AUTOMOUNT(inode)))
1562 dentry->d_flags |= DCACHE_NEED_AUTOMOUNT;
Al Virob3d9b7a2012-06-09 13:51:19 -04001563 hlist_add_head(&dentry->d_alias, &inode->i_dentry);
David Howells9875cf82011-01-14 18:45:21 +00001564 }
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001565 dentry->d_inode = inode;
Nick Piggin31e6b012011-01-07 17:49:52 +11001566 dentry_rcuwalk_barrier(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001567 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001568 fsnotify_d_instantiate(dentry, inode);
1569}
1570
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571/**
1572 * d_instantiate - fill in inode information for a dentry
1573 * @entry: dentry to complete
1574 * @inode: inode to attach to this dentry
1575 *
1576 * Fill in inode information in the entry.
1577 *
1578 * This turns negative dentries into productive full members
1579 * of society.
1580 *
1581 * NOTE! This assumes that the inode count has been incremented
1582 * (or otherwise set) by the caller to indicate that it is now
1583 * in use by the dcache.
1584 */
1585
1586void d_instantiate(struct dentry *entry, struct inode * inode)
1587{
Al Virob3d9b7a2012-06-09 13:51:19 -04001588 BUG_ON(!hlist_unhashed(&entry->d_alias));
Nick Piggin873feea2011-01-07 17:50:06 +11001589 if (inode)
1590 spin_lock(&inode->i_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001591 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001592 if (inode)
1593 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 security_d_instantiate(entry, inode);
1595}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001596EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597
1598/**
1599 * d_instantiate_unique - instantiate a non-aliased dentry
1600 * @entry: dentry to instantiate
1601 * @inode: inode to attach to this dentry
1602 *
1603 * Fill in inode information in the entry. On success, it returns NULL.
1604 * If an unhashed alias of "entry" already exists, then we return the
Oleg Drokine866cfa2006-01-09 20:52:51 -08001605 * aliased dentry instead and drop one reference to inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 *
1607 * Note that in order to avoid conflicts with rename() etc, the caller
1608 * had better be holding the parent directory semaphore.
Oleg Drokine866cfa2006-01-09 20:52:51 -08001609 *
1610 * This also assumes that the inode count has been incremented
1611 * (or otherwise set) by the caller to indicate that it is now
1612 * in use by the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 */
David Howells770bfad2006-08-22 20:06:07 -04001614static struct dentry *__d_instantiate_unique(struct dentry *entry,
1615 struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616{
1617 struct dentry *alias;
1618 int len = entry->d_name.len;
1619 const char *name = entry->d_name.name;
1620 unsigned int hash = entry->d_name.hash;
1621
David Howells770bfad2006-08-22 20:06:07 -04001622 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001623 __d_instantiate(entry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001624 return NULL;
1625 }
1626
Sasha Levinb67bfe02013-02-27 17:06:00 -08001627 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Piggin9abca362011-01-07 17:49:36 +11001628 /*
1629 * Don't need alias->d_lock here, because aliases with
1630 * d_parent == entry->d_parent are not subject to name or
1631 * parent changes, because the parent inode i_mutex is held.
1632 */
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001633 if (alias->d_name.hash != hash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 continue;
1635 if (alias->d_parent != entry->d_parent)
1636 continue;
Linus Torvaldsee983e82012-05-10 12:37:10 -07001637 if (alias->d_name.len != len)
1638 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001639 if (dentry_cmp(alias, name, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 continue;
Nick Piggindc0474b2011-01-07 17:49:43 +11001641 __dget(alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642 return alias;
1643 }
David Howells770bfad2006-08-22 20:06:07 -04001644
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001645 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 return NULL;
1647}
David Howells770bfad2006-08-22 20:06:07 -04001648
1649struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1650{
1651 struct dentry *result;
1652
Al Virob3d9b7a2012-06-09 13:51:19 -04001653 BUG_ON(!hlist_unhashed(&entry->d_alias));
David Howells770bfad2006-08-22 20:06:07 -04001654
Nick Piggin873feea2011-01-07 17:50:06 +11001655 if (inode)
1656 spin_lock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001657 result = __d_instantiate_unique(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001658 if (inode)
1659 spin_unlock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001660
1661 if (!result) {
1662 security_d_instantiate(entry, inode);
1663 return NULL;
1664 }
1665
1666 BUG_ON(!d_unhashed(result));
1667 iput(inode);
1668 return result;
1669}
1670
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671EXPORT_SYMBOL(d_instantiate_unique);
1672
Al Viroadc0e912012-01-08 16:49:21 -05001673struct dentry *d_make_root(struct inode *root_inode)
1674{
1675 struct dentry *res = NULL;
1676
1677 if (root_inode) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07001678 static const struct qstr name = QSTR_INIT("/", 1);
Al Viroadc0e912012-01-08 16:49:21 -05001679
1680 res = __d_alloc(root_inode->i_sb, &name);
1681 if (res)
1682 d_instantiate(res, root_inode);
1683 else
1684 iput(root_inode);
1685 }
1686 return res;
1687}
1688EXPORT_SYMBOL(d_make_root);
1689
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001690static struct dentry * __d_find_any_alias(struct inode *inode)
1691{
1692 struct dentry *alias;
1693
Al Virob3d9b7a2012-06-09 13:51:19 -04001694 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001695 return NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001696 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001697 __dget(alias);
1698 return alias;
1699}
1700
Sage Weil46f72b32012-01-10 09:04:37 -08001701/**
1702 * d_find_any_alias - find any alias for a given inode
1703 * @inode: inode to find an alias for
1704 *
1705 * If any aliases exist for the given inode, take and return a
1706 * reference for one of them. If no aliases exist, return %NULL.
1707 */
1708struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001709{
1710 struct dentry *de;
1711
1712 spin_lock(&inode->i_lock);
1713 de = __d_find_any_alias(inode);
1714 spin_unlock(&inode->i_lock);
1715 return de;
1716}
Sage Weil46f72b32012-01-10 09:04:37 -08001717EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001718
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719/**
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001720 * d_obtain_alias - find or allocate a dentry for a given inode
1721 * @inode: inode to allocate the dentry for
1722 *
1723 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1724 * similar open by handle operations. The returned dentry may be anonymous,
1725 * or may have a full name (if the inode was already in the cache).
1726 *
1727 * When called on a directory inode, we must ensure that the inode only ever
1728 * has one dentry. If a dentry is found, that is returned instead of
1729 * allocating a new one.
1730 *
1731 * On successful return, the reference to the inode has been transferred
Christoph Hellwig44003722008-08-11 15:49:04 +02001732 * to the dentry. In case of an error the reference on the inode is released.
1733 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1734 * be passed in and will be the error will be propagate to the return value,
1735 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001736 */
1737struct dentry *d_obtain_alias(struct inode *inode)
1738{
NeilBrownb911a6b2012-11-08 16:09:37 -08001739 static const struct qstr anonstring = QSTR_INIT("/", 1);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001740 struct dentry *tmp;
1741 struct dentry *res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001742
1743 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001744 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001745 if (IS_ERR(inode))
1746 return ERR_CAST(inode);
1747
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001748 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001749 if (res)
1750 goto out_iput;
1751
Al Viroa4464db2011-07-07 15:03:58 -04001752 tmp = __d_alloc(inode->i_sb, &anonstring);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001753 if (!tmp) {
1754 res = ERR_PTR(-ENOMEM);
1755 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001756 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001757
Nick Piggin873feea2011-01-07 17:50:06 +11001758 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001759 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001760 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001761 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001762 dput(tmp);
1763 goto out_iput;
1764 }
1765
1766 /* attach a disconnected dentry */
1767 spin_lock(&tmp->d_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001768 tmp->d_inode = inode;
1769 tmp->d_flags |= DCACHE_DISCONNECTED;
Al Virob3d9b7a2012-06-09 13:51:19 -04001770 hlist_add_head(&tmp->d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001771 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001772 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001773 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001774 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001775 spin_unlock(&inode->i_lock);
Josef Bacik24ff6662010-11-18 20:52:55 -05001776 security_d_instantiate(tmp, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001777
Christoph Hellwig9308a612008-08-11 15:49:12 +02001778 return tmp;
1779
1780 out_iput:
Josef Bacik24ff6662010-11-18 20:52:55 -05001781 if (res && !IS_ERR(res))
1782 security_d_instantiate(res, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001783 iput(inode);
1784 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001785}
Benny Halevyadc48722009-02-27 14:02:59 -08001786EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787
1788/**
1789 * d_splice_alias - splice a disconnected dentry into the tree if one exists
1790 * @inode: the inode which may have a disconnected dentry
1791 * @dentry: a negative dentry which we want to point to the inode.
1792 *
1793 * If inode is a directory and has a 'disconnected' dentry (i.e. IS_ROOT and
1794 * DCACHE_DISCONNECTED), then d_move that in place of the given dentry
1795 * and return it, else simply d_add the inode to the dentry and return NULL.
1796 *
1797 * This is needed in the lookup routine of any filesystem that is exportable
1798 * (via knfsd) so that we can build dcache paths to directories effectively.
1799 *
1800 * If a dentry was found and moved, then it is returned. Otherwise NULL
1801 * is returned. This matches the expected return value of ->lookup.
1802 *
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001803 * Cluster filesystems may call this function with a negative, hashed dentry.
1804 * In that case, we know that the inode will be a regular file, and also this
1805 * will only occur during atomic_open. So we need to check for the dentry
1806 * being already hashed only in the final case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807 */
1808struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
1809{
1810 struct dentry *new = NULL;
1811
Al Viroa9049372011-07-08 21:20:11 -04001812 if (IS_ERR(inode))
1813 return ERR_CAST(inode);
1814
NeilBrown21c0d8f2006-10-04 02:16:16 -07001815 if (inode && S_ISDIR(inode->i_mode)) {
Nick Piggin873feea2011-01-07 17:50:06 +11001816 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001817 new = __d_find_alias(inode, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818 if (new) {
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001819 BUG_ON(!(new->d_flags & DCACHE_DISCONNECTED));
Nick Piggin873feea2011-01-07 17:50:06 +11001820 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 security_d_instantiate(new, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 d_move(new, dentry);
1823 iput(inode);
1824 } else {
Nick Piggin873feea2011-01-07 17:50:06 +11001825 /* already taking inode->i_lock, so d_add() by hand */
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001826 __d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001827 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 security_d_instantiate(dentry, inode);
1829 d_rehash(dentry);
1830 }
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001831 } else {
1832 d_instantiate(dentry, inode);
1833 if (d_unhashed(dentry))
1834 d_rehash(dentry);
1835 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 return new;
1837}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001838EXPORT_SYMBOL(d_splice_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839
Barry Naujok94035402008-05-21 16:50:46 +10001840/**
1841 * d_add_ci - lookup or allocate new dentry with case-exact name
1842 * @inode: the inode case-insensitive lookup has found
1843 * @dentry: the negative dentry that was passed to the parent's lookup func
1844 * @name: the case-exact name to be associated with the returned dentry
1845 *
1846 * This is to avoid filling the dcache with case-insensitive names to the
1847 * same inode, only the actual correct case is stored in the dcache for
1848 * case-insensitive filesystems.
1849 *
1850 * For a case-insensitive lookup match and if the the case-exact dentry
1851 * already exists in in the dcache, use it and return it.
1852 *
1853 * If no entry exists with the exact case name, allocate new dentry with
1854 * the exact case, and return the spliced entry.
1855 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001856struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001857 struct qstr *name)
1858{
Barry Naujok94035402008-05-21 16:50:46 +10001859 struct dentry *found;
1860 struct dentry *new;
1861
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001862 /*
1863 * First check if a dentry matching the name already exists,
1864 * if not go ahead and create it now.
1865 */
Barry Naujok94035402008-05-21 16:50:46 +10001866 found = d_hash_and_lookup(dentry->d_parent, name);
Al Viro4f522a22013-02-11 23:20:37 -05001867 if (unlikely(IS_ERR(found)))
1868 goto err_out;
Barry Naujok94035402008-05-21 16:50:46 +10001869 if (!found) {
1870 new = d_alloc(dentry->d_parent, name);
1871 if (!new) {
Al Viro4f522a22013-02-11 23:20:37 -05001872 found = ERR_PTR(-ENOMEM);
Barry Naujok94035402008-05-21 16:50:46 +10001873 goto err_out;
1874 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001875
Barry Naujok94035402008-05-21 16:50:46 +10001876 found = d_splice_alias(inode, new);
1877 if (found) {
1878 dput(new);
1879 return found;
1880 }
1881 return new;
1882 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001883
1884 /*
1885 * If a matching dentry exists, and it's not negative use it.
1886 *
1887 * Decrement the reference count to balance the iget() done
1888 * earlier on.
1889 */
Barry Naujok94035402008-05-21 16:50:46 +10001890 if (found->d_inode) {
1891 if (unlikely(found->d_inode != inode)) {
1892 /* This can't happen because bad inodes are unhashed. */
1893 BUG_ON(!is_bad_inode(inode));
1894 BUG_ON(!is_bad_inode(found->d_inode));
1895 }
Barry Naujok94035402008-05-21 16:50:46 +10001896 iput(inode);
1897 return found;
1898 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001899
Barry Naujok94035402008-05-21 16:50:46 +10001900 /*
1901 * Negative dentry: instantiate it unless the inode is a directory and
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001902 * already has a dentry.
Barry Naujok94035402008-05-21 16:50:46 +10001903 */
Al Viro4513d892011-07-17 10:52:14 -04001904 new = d_splice_alias(inode, found);
1905 if (new) {
1906 dput(found);
1907 found = new;
Barry Naujok94035402008-05-21 16:50:46 +10001908 }
Al Viro4513d892011-07-17 10:52:14 -04001909 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001910
1911err_out:
1912 iput(inode);
Al Viro4f522a22013-02-11 23:20:37 -05001913 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001914}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001915EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001917/*
1918 * Do the slow-case of the dentry name compare.
1919 *
1920 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07001921 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001922 * filesystem can rely on them, and can use the 'name' and
1923 * 'len' information without worrying about walking off the
1924 * end of memory etc.
1925 *
1926 * Thus the read_seqcount_retry() and the "duplicate" info
1927 * in arguments (the low-level filesystem should not look
1928 * at the dentry inode or name contents directly, since
1929 * rename can change them while we're in RCU mode).
1930 */
1931enum slow_d_compare {
1932 D_COMP_OK,
1933 D_COMP_NOMATCH,
1934 D_COMP_SEQRETRY,
1935};
1936
1937static noinline enum slow_d_compare slow_dentry_cmp(
1938 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001939 struct dentry *dentry,
1940 unsigned int seq,
1941 const struct qstr *name)
1942{
1943 int tlen = dentry->d_name.len;
1944 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001945
1946 if (read_seqcount_retry(&dentry->d_seq, seq)) {
1947 cpu_relax();
1948 return D_COMP_SEQRETRY;
1949 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07001950 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001951 return D_COMP_NOMATCH;
1952 return D_COMP_OK;
1953}
1954
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955/**
Nick Piggin31e6b012011-01-07 17:49:52 +11001956 * __d_lookup_rcu - search for a dentry (racy, store-free)
1957 * @parent: parent dentry
1958 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07001959 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11001960 * Returns: dentry, or NULL
1961 *
1962 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
1963 * resolution (store-free path walking) design described in
1964 * Documentation/filesystems/path-lookup.txt.
1965 *
1966 * This is not to be used outside core vfs.
1967 *
1968 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
1969 * held, and rcu_read_lock held. The returned dentry must not be stored into
1970 * without taking d_lock and checking d_seq sequence count against @seq
1971 * returned here.
1972 *
Linus Torvalds15570082013-09-02 11:38:06 -07001973 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11001974 * function.
1975 *
1976 * Alternatively, __d_lookup_rcu may be called again to look up the child of
1977 * the returned dentry, so long as its parent's seqlock is checked after the
1978 * child is looked up. Thus, an interlocking stepping of sequence lock checks
1979 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001980 *
1981 * NOTE! The caller *has* to check the resulting dentry against the sequence
1982 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11001983 */
Linus Torvalds8966be92012-03-02 14:23:30 -08001984struct dentry *__d_lookup_rcu(const struct dentry *parent,
1985 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07001986 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11001987{
Linus Torvalds26fe5752012-05-10 13:14:12 -07001988 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11001989 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07001990 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001991 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11001992 struct dentry *dentry;
1993
1994 /*
1995 * Note: There is significant duplication with __d_lookup_rcu which is
1996 * required to prevent single threaded performance regressions
1997 * especially on architectures where smp_rmb (in seqcounts) are costly.
1998 * Keep the two functions in sync.
1999 */
2000
2001 /*
2002 * The hash list is protected using RCU.
2003 *
2004 * Carefully use d_seq when comparing a candidate dentry, to avoid
2005 * races with d_move().
2006 *
2007 * It is possible that concurrent renames can mess up our list
2008 * walk here and result in missing our dentry, resulting in the
2009 * false-negative result. d_lookup() protects against concurrent
2010 * renames using rename_lock seqlock.
2011 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002012 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002013 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002014 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002015 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002016
Nick Piggin31e6b012011-01-07 17:49:52 +11002017seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002018 /*
2019 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002020 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002021 *
2022 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002023 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002024 *
2025 * NOTE! We do a "raw" seqcount_begin here. That means that
2026 * we don't wait for the sequence count to stabilize if it
2027 * is in the middle of a sequence change. If we do the slow
2028 * dentry compare, we will do seqretries until it is stable,
2029 * and if we end up with a successful lookup, we actually
2030 * want to exit RCU lookup anyway.
2031 */
2032 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002033 if (dentry->d_parent != parent)
2034 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002035 if (d_unhashed(dentry))
2036 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002037
2038 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002039 if (dentry->d_name.hash != hashlen_hash(hashlen))
2040 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002041 *seqp = seq;
2042 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002043 case D_COMP_OK:
2044 return dentry;
2045 case D_COMP_NOMATCH:
2046 continue;
2047 default:
2048 goto seqretry;
2049 }
2050 }
2051
Linus Torvalds26fe5752012-05-10 13:14:12 -07002052 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002053 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002054 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002055 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002056 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002057 }
2058 return NULL;
2059}
2060
2061/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062 * d_lookup - search for a dentry
2063 * @parent: parent dentry
2064 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002065 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002067 * d_lookup searches the children of the parent dentry for the name in
2068 * question. If the dentry is found its reference count is incremented and the
2069 * dentry is returned. The caller must use dput to free the entry when it has
2070 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 */
Al Viroda2d8452013-01-24 18:29:34 -05002072struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073{
Nick Piggin31e6b012011-01-07 17:49:52 +11002074 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002075 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076
2077 do {
2078 seq = read_seqbegin(&rename_lock);
2079 dentry = __d_lookup(parent, name);
2080 if (dentry)
2081 break;
2082 } while (read_seqretry(&rename_lock, seq));
2083 return dentry;
2084}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002085EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086
Nick Piggin31e6b012011-01-07 17:49:52 +11002087/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002088 * __d_lookup - search for a dentry (racy)
2089 * @parent: parent dentry
2090 * @name: qstr of name we wish to find
2091 * Returns: dentry, or NULL
2092 *
2093 * __d_lookup is like d_lookup, however it may (rarely) return a
2094 * false-negative result due to unrelated rename activity.
2095 *
2096 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2097 * however it must be used carefully, eg. with a following d_lookup in
2098 * the case of failure.
2099 *
2100 * __d_lookup callers must be commented.
2101 */
Al Viroa713ca22013-01-24 18:27:00 -05002102struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103{
2104 unsigned int len = name->len;
2105 unsigned int hash = name->hash;
2106 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002107 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002108 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002109 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002110 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111
Nick Pigginb04f7842010-08-18 04:37:34 +10002112 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002113 * Note: There is significant duplication with __d_lookup_rcu which is
2114 * required to prevent single threaded performance regressions
2115 * especially on architectures where smp_rmb (in seqcounts) are costly.
2116 * Keep the two functions in sync.
2117 */
2118
2119 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002120 * The hash list is protected using RCU.
2121 *
2122 * Take d_lock when comparing a candidate dentry, to avoid races
2123 * with d_move().
2124 *
2125 * It is possible that concurrent renames can mess up our list
2126 * walk here and result in missing our dentry, resulting in the
2127 * false-negative result. d_lookup() protects against concurrent
2128 * renames using rename_lock seqlock.
2129 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002130 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002131 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132 rcu_read_lock();
2133
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002134 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 if (dentry->d_name.hash != hash)
2137 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138
2139 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 if (dentry->d_parent != parent)
2141 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002142 if (d_unhashed(dentry))
2143 goto next;
2144
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145 /*
2146 * It is safe to compare names since d_move() cannot
2147 * change the qstr (protected by d_lock).
2148 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002149 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002150 int tlen = dentry->d_name.len;
2151 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002152 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 goto next;
2154 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002155 if (dentry->d_name.len != len)
2156 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002157 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 goto next;
2159 }
2160
Waiman Long98474232013-08-28 18:24:59 -07002161 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002162 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163 spin_unlock(&dentry->d_lock);
2164 break;
2165next:
2166 spin_unlock(&dentry->d_lock);
2167 }
2168 rcu_read_unlock();
2169
2170 return found;
2171}
2172
2173/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002174 * d_hash_and_lookup - hash the qstr then search for a dentry
2175 * @dir: Directory to search in
2176 * @name: qstr of name we wish to find
2177 *
Al Viro4f522a22013-02-11 23:20:37 -05002178 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002179 */
2180struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2181{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002182 /*
2183 * Check for a fs-specific hash function. Note that we must
2184 * calculate the standard hash first, as the d_op->d_hash()
2185 * routine may choose to leave the hash value unchanged.
2186 */
2187 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002188 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002189 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002190 if (unlikely(err < 0))
2191 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002192 }
Al Viro4f522a22013-02-11 23:20:37 -05002193 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002194}
Al Viro4f522a22013-02-11 23:20:37 -05002195EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002196
2197/**
Nick Piggin786a5e12011-01-07 17:49:16 +11002198 * d_validate - verify dentry provided from insecure source (deprecated)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199 * @dentry: The dentry alleged to be valid child of @dparent
Randy Dunlapff5fdb62011-01-22 20:16:06 -08002200 * @dparent: The parent dentry (known to be valid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 *
2202 * An insecure source has sent us a dentry, here we verify it and dget() it.
2203 * This is used by ncpfs in its readdir implementation.
2204 * Zero is returned in the dentry is invalid.
Nick Piggin786a5e12011-01-07 17:49:16 +11002205 *
2206 * This function is slow for big directories, and deprecated, do not use it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 */
Nick Piggind3a23e12011-01-05 20:01:21 +11002208int d_validate(struct dentry *dentry, struct dentry *dparent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209{
Nick Piggin786a5e12011-01-07 17:49:16 +11002210 struct dentry *child;
Nick Piggind3a23e12011-01-05 20:01:21 +11002211
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002212 spin_lock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002213 list_for_each_entry(child, &dparent->d_subdirs, d_u.d_child) {
2214 if (dentry == child) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002215 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Nick Piggindc0474b2011-01-07 17:49:43 +11002216 __dget_dlock(dentry);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002217 spin_unlock(&dentry->d_lock);
2218 spin_unlock(&dparent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219 return 1;
2220 }
2221 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002222 spin_unlock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002223
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 return 0;
2225}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002226EXPORT_SYMBOL(d_validate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227
2228/*
2229 * When a file is deleted, we have two options:
2230 * - turn this dentry into a negative dentry
2231 * - unhash this dentry and free it.
2232 *
2233 * Usually, we want to just turn this into
2234 * a negative dentry, but if anybody else is
2235 * currently using the dentry or the inode
2236 * we can't do that and we fall back on removing
2237 * it from the hash queues and waiting for
2238 * it to be deleted later when it has no users
2239 */
2240
2241/**
2242 * d_delete - delete a dentry
2243 * @dentry: The dentry to delete
2244 *
2245 * Turn the dentry into a negative dentry if possible, otherwise
2246 * remove it from the hash queues so it can be deleted later
2247 */
2248
2249void d_delete(struct dentry * dentry)
2250{
Nick Piggin873feea2011-01-07 17:50:06 +11002251 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002252 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 /*
2254 * Are we the only user?
2255 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002256again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002258 inode = dentry->d_inode;
2259 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002260 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002261 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002262 spin_unlock(&dentry->d_lock);
2263 cpu_relax();
2264 goto again;
2265 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002266 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002267 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002268 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269 return;
2270 }
2271
2272 if (!d_unhashed(dentry))
2273 __d_drop(dentry);
2274
2275 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002276
2277 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002279EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002281static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002283 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002284 hlist_bl_lock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -07002285 entry->d_flags |= DCACHE_RCUACCESS;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002286 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002287 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288}
2289
David Howells770bfad2006-08-22 20:06:07 -04002290static void _d_rehash(struct dentry * entry)
2291{
2292 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2293}
2294
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295/**
2296 * d_rehash - add an entry back to the hash
2297 * @entry: dentry to add to the hash
2298 *
2299 * Adds a dentry to the hash according to its name.
2300 */
2301
2302void d_rehash(struct dentry * entry)
2303{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002305 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002308EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002310/**
2311 * dentry_update_name_case - update case insensitive dentry with a new name
2312 * @dentry: dentry to be updated
2313 * @name: new name
2314 *
2315 * Update a case insensitive dentry with new case of name.
2316 *
2317 * dentry must have been returned by d_lookup with name @name. Old and new
2318 * name lengths must match (ie. no d_compare which allows mismatched name
2319 * lengths).
2320 *
2321 * Parent inode i_mutex must be held over d_lookup and into this call (to
2322 * keep renames and concurrent inserts, and readdir(2) away).
2323 */
2324void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2325{
Linus Torvalds7ebfa572011-04-15 07:34:26 -07002326 BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002327 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2328
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002329 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002330 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002331 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002332 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002333 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002334}
2335EXPORT_SYMBOL(dentry_update_name_case);
2336
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337static void switch_names(struct dentry *dentry, struct dentry *target)
2338{
2339 if (dname_external(target)) {
2340 if (dname_external(dentry)) {
2341 /*
2342 * Both external: swap the pointers
2343 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002344 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345 } else {
2346 /*
2347 * dentry:internal, target:external. Steal target's
2348 * storage and make target internal.
2349 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002350 memcpy(target->d_iname, dentry->d_name.name,
2351 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352 dentry->d_name.name = target->d_name.name;
2353 target->d_name.name = target->d_iname;
2354 }
2355 } else {
2356 if (dname_external(dentry)) {
2357 /*
2358 * dentry:external, target:internal. Give dentry's
2359 * storage to target and make dentry internal
2360 */
2361 memcpy(dentry->d_iname, target->d_name.name,
2362 target->d_name.len + 1);
2363 target->d_name.name = dentry->d_name.name;
2364 dentry->d_name.name = dentry->d_iname;
2365 } else {
2366 /*
2367 * Both are internal. Just copy target to dentry
2368 */
2369 memcpy(dentry->d_iname, target->d_name.name,
2370 target->d_name.len + 1);
Al Virodc711ca2008-11-03 15:03:50 -05002371 dentry->d_name.len = target->d_name.len;
2372 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373 }
2374 }
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002375 swap(dentry->d_name.len, target->d_name.len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376}
2377
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002378static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2379{
2380 /*
2381 * XXXX: do we really need to take target->d_lock?
2382 */
2383 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2384 spin_lock(&target->d_parent->d_lock);
2385 else {
2386 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2387 spin_lock(&dentry->d_parent->d_lock);
2388 spin_lock_nested(&target->d_parent->d_lock,
2389 DENTRY_D_LOCK_NESTED);
2390 } else {
2391 spin_lock(&target->d_parent->d_lock);
2392 spin_lock_nested(&dentry->d_parent->d_lock,
2393 DENTRY_D_LOCK_NESTED);
2394 }
2395 }
2396 if (target < dentry) {
2397 spin_lock_nested(&target->d_lock, 2);
2398 spin_lock_nested(&dentry->d_lock, 3);
2399 } else {
2400 spin_lock_nested(&dentry->d_lock, 2);
2401 spin_lock_nested(&target->d_lock, 3);
2402 }
2403}
2404
2405static void dentry_unlock_parents_for_move(struct dentry *dentry,
2406 struct dentry *target)
2407{
2408 if (target->d_parent != dentry->d_parent)
2409 spin_unlock(&dentry->d_parent->d_lock);
2410 if (target->d_parent != target)
2411 spin_unlock(&target->d_parent->d_lock);
2412}
2413
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002415 * When switching names, the actual string doesn't strictly have to
2416 * be preserved in the target - because we're dropping the target
2417 * anyway. As such, we can just do a simple memcpy() to copy over
2418 * the new name before we switch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419 *
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002420 * Note that we have to be a lot more careful about getting the hash
2421 * switched - we have to switch the hash value properly even if it
2422 * then no longer matches the actual (corrupted) string of the target.
2423 * The hash value has to match the hash queue that the dentry is on..
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002425/*
Al Viro18367502011-07-12 21:42:24 -04002426 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427 * @dentry: entry to move
2428 * @target: new dentry
2429 *
2430 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002431 * dcache entries should not be moved in this way. Caller must hold
2432 * rename_lock, the i_mutex of the source and target directories,
2433 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434 */
Al Viro18367502011-07-12 21:42:24 -04002435static void __d_move(struct dentry * dentry, struct dentry * target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002437 if (!dentry->d_inode)
2438 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2439
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002440 BUG_ON(d_ancestor(dentry, target));
2441 BUG_ON(d_ancestor(target, dentry));
2442
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002443 dentry_lock_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444
Nick Piggin31e6b012011-01-07 17:49:52 +11002445 write_seqcount_begin(&dentry->d_seq);
2446 write_seqcount_begin(&target->d_seq);
2447
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002448 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2449
2450 /*
2451 * Move the dentry to the target hash queue. Don't bother checking
2452 * for the same hash queue because of how unlikely it is.
2453 */
2454 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002455 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456
2457 /* Unhash the target: dput() will then get rid of it */
2458 __d_drop(target);
2459
Eric Dumazet5160ee62006-01-08 01:03:32 -08002460 list_del(&dentry->d_u.d_child);
2461 list_del(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462
2463 /* Switch the names.. */
2464 switch_names(dentry, target);
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002465 swap(dentry->d_name.hash, target->d_name.hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002466
2467 /* ... and switch the parents */
2468 if (IS_ROOT(dentry)) {
2469 dentry->d_parent = target->d_parent;
2470 target->d_parent = target;
Eric Dumazet5160ee62006-01-08 01:03:32 -08002471 INIT_LIST_HEAD(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472 } else {
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002473 swap(dentry->d_parent, target->d_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474
2475 /* And add them back to the (new) parent lists */
Eric Dumazet5160ee62006-01-08 01:03:32 -08002476 list_add(&target->d_u.d_child, &target->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477 }
2478
Eric Dumazet5160ee62006-01-08 01:03:32 -08002479 list_add(&dentry->d_u.d_child, &dentry->d_parent->d_subdirs);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002480
Nick Piggin31e6b012011-01-07 17:49:52 +11002481 write_seqcount_end(&target->d_seq);
2482 write_seqcount_end(&dentry->d_seq);
2483
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002484 dentry_unlock_parents_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485 spin_unlock(&target->d_lock);
Nick Pigginc32ccd82006-03-25 03:07:09 -08002486 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002487 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002488}
2489
2490/*
2491 * d_move - move a dentry
2492 * @dentry: entry to move
2493 * @target: new dentry
2494 *
2495 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002496 * dcache entries should not be moved in this way. See the locking
2497 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002498 */
2499void d_move(struct dentry *dentry, struct dentry *target)
2500{
2501 write_seqlock(&rename_lock);
2502 __d_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002503 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002504}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002505EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002507/**
2508 * d_ancestor - search for an ancestor
2509 * @p1: ancestor dentry
2510 * @p2: child dentry
2511 *
2512 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2513 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002514 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002515struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002516{
2517 struct dentry *p;
2518
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002519 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002520 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002521 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002522 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002523 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002524}
2525
2526/*
2527 * This helper attempts to cope with remotely renamed directories
2528 *
2529 * It assumes that the caller is already holding
Al Viro18367502011-07-12 21:42:24 -04002530 * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002531 *
2532 * Note: If ever the locking in lock_rename() changes, then please
2533 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002534 */
Nick Piggin873feea2011-01-07 17:50:06 +11002535static struct dentry *__d_unalias(struct inode *inode,
2536 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002537{
2538 struct mutex *m1 = NULL, *m2 = NULL;
Al Viroee3efa92012-06-08 15:59:33 -04002539 struct dentry *ret = ERR_PTR(-EBUSY);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002540
2541 /* If alias and dentry share a parent, then no extra locks required */
2542 if (alias->d_parent == dentry->d_parent)
2543 goto out_unalias;
2544
Trond Myklebust9eaef272006-10-21 10:24:20 -07002545 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002546 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2547 goto out_err;
2548 m1 = &dentry->d_sb->s_vfs_rename_mutex;
2549 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
2550 goto out_err;
2551 m2 = &alias->d_parent->d_inode->i_mutex;
2552out_unalias:
Al Viroee3efa92012-06-08 15:59:33 -04002553 if (likely(!d_mountpoint(alias))) {
2554 __d_move(alias, dentry);
2555 ret = alias;
2556 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002557out_err:
Nick Piggin873feea2011-01-07 17:50:06 +11002558 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002559 if (m2)
2560 mutex_unlock(m2);
2561 if (m1)
2562 mutex_unlock(m1);
2563 return ret;
2564}
2565
2566/*
David Howells770bfad2006-08-22 20:06:07 -04002567 * Prepare an anonymous dentry for life in the superblock's dentry tree as a
2568 * named dentry in place of the dentry to be replaced.
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002569 * returns with anon->d_lock held!
David Howells770bfad2006-08-22 20:06:07 -04002570 */
2571static void __d_materialise_dentry(struct dentry *dentry, struct dentry *anon)
2572{
Al Viro740da422013-01-30 10:13:38 -05002573 struct dentry *dparent;
David Howells770bfad2006-08-22 20:06:07 -04002574
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002575 dentry_lock_for_move(anon, dentry);
David Howells770bfad2006-08-22 20:06:07 -04002576
Nick Piggin31e6b012011-01-07 17:49:52 +11002577 write_seqcount_begin(&dentry->d_seq);
2578 write_seqcount_begin(&anon->d_seq);
2579
David Howells770bfad2006-08-22 20:06:07 -04002580 dparent = dentry->d_parent;
David Howells770bfad2006-08-22 20:06:07 -04002581
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002582 switch_names(dentry, anon);
2583 swap(dentry->d_name.hash, anon->d_name.hash);
2584
Al Viro740da422013-01-30 10:13:38 -05002585 dentry->d_parent = dentry;
2586 list_del_init(&dentry->d_u.d_child);
2587 anon->d_parent = dparent;
Wei Yongjun9ed53b12013-03-12 00:10:50 +08002588 list_move(&anon->d_u.d_child, &dparent->d_subdirs);
David Howells770bfad2006-08-22 20:06:07 -04002589
Nick Piggin31e6b012011-01-07 17:49:52 +11002590 write_seqcount_end(&dentry->d_seq);
2591 write_seqcount_end(&anon->d_seq);
2592
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002593 dentry_unlock_parents_for_move(anon, dentry);
2594 spin_unlock(&dentry->d_lock);
2595
2596 /* anon->d_lock still locked, returns locked */
David Howells770bfad2006-08-22 20:06:07 -04002597 anon->d_flags &= ~DCACHE_DISCONNECTED;
2598}
2599
2600/**
2601 * d_materialise_unique - introduce an inode into the tree
2602 * @dentry: candidate dentry
2603 * @inode: inode to bind to the dentry, to which aliases may be attached
2604 *
2605 * Introduces an dentry into the tree, substituting an extant disconnected
Jeff Laytonc46c8872011-07-26 13:33:16 -04002606 * root directory alias in its place if there is one. Caller must hold the
2607 * i_mutex of the parent directory.
David Howells770bfad2006-08-22 20:06:07 -04002608 */
2609struct dentry *d_materialise_unique(struct dentry *dentry, struct inode *inode)
2610{
Trond Myklebust9eaef272006-10-21 10:24:20 -07002611 struct dentry *actual;
David Howells770bfad2006-08-22 20:06:07 -04002612
2613 BUG_ON(!d_unhashed(dentry));
2614
David Howells770bfad2006-08-22 20:06:07 -04002615 if (!inode) {
2616 actual = dentry;
OGAWA Hirofumi360da902008-10-16 07:50:28 +09002617 __d_instantiate(dentry, NULL);
Nick Piggin357f8e62011-01-07 17:49:42 +11002618 d_rehash(actual);
2619 goto out_nolock;
David Howells770bfad2006-08-22 20:06:07 -04002620 }
2621
Nick Piggin873feea2011-01-07 17:50:06 +11002622 spin_lock(&inode->i_lock);
Nick Piggin357f8e62011-01-07 17:49:42 +11002623
Trond Myklebust9eaef272006-10-21 10:24:20 -07002624 if (S_ISDIR(inode->i_mode)) {
2625 struct dentry *alias;
David Howells770bfad2006-08-22 20:06:07 -04002626
Trond Myklebust9eaef272006-10-21 10:24:20 -07002627 /* Does an aliased dentry already exist? */
Linus Torvalds32ba9c32012-06-08 10:34:03 -07002628 alias = __d_find_alias(inode, 0);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002629 if (alias) {
2630 actual = alias;
Al Viro18367502011-07-12 21:42:24 -04002631 write_seqlock(&rename_lock);
2632
2633 if (d_ancestor(alias, dentry)) {
2634 /* Check for loops */
2635 actual = ERR_PTR(-ELOOP);
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002636 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002637 } else if (IS_ROOT(alias)) {
2638 /* Is this an anonymous mountpoint that we
2639 * could splice into our tree? */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002640 __d_materialise_dentry(dentry, alias);
Al Viro18367502011-07-12 21:42:24 -04002641 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002642 __d_drop(alias);
2643 goto found;
Al Viro18367502011-07-12 21:42:24 -04002644 } else {
2645 /* Nope, but we must(!) avoid directory
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002646 * aliasing. This drops inode->i_lock */
Al Viro18367502011-07-12 21:42:24 -04002647 actual = __d_unalias(inode, dentry, alias);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002648 }
Al Viro18367502011-07-12 21:42:24 -04002649 write_sequnlock(&rename_lock);
David Howellsdd179942011-08-16 15:31:30 +01002650 if (IS_ERR(actual)) {
2651 if (PTR_ERR(actual) == -ELOOP)
2652 pr_warn_ratelimited(
2653 "VFS: Lookup of '%s' in %s %s"
2654 " would have caused loop\n",
2655 dentry->d_name.name,
2656 inode->i_sb->s_type->name,
2657 inode->i_sb->s_id);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002658 dput(alias);
David Howellsdd179942011-08-16 15:31:30 +01002659 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002660 goto out_nolock;
2661 }
David Howells770bfad2006-08-22 20:06:07 -04002662 }
2663
2664 /* Add a unique reference */
2665 actual = __d_instantiate_unique(dentry, inode);
2666 if (!actual)
2667 actual = dentry;
Nick Piggin357f8e62011-01-07 17:49:42 +11002668 else
2669 BUG_ON(!d_unhashed(actual));
David Howells770bfad2006-08-22 20:06:07 -04002670
David Howells770bfad2006-08-22 20:06:07 -04002671 spin_lock(&actual->d_lock);
2672found:
2673 _d_rehash(actual);
2674 spin_unlock(&actual->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002675 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002676out_nolock:
David Howells770bfad2006-08-22 20:06:07 -04002677 if (actual == dentry) {
2678 security_d_instantiate(dentry, inode);
2679 return NULL;
2680 }
2681
2682 iput(inode);
2683 return actual;
David Howells770bfad2006-08-22 20:06:07 -04002684}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002685EXPORT_SYMBOL_GPL(d_materialise_unique);
David Howells770bfad2006-08-22 20:06:07 -04002686
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002687static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002688{
2689 *buflen -= namelen;
2690 if (*buflen < 0)
2691 return -ENAMETOOLONG;
2692 *buffer -= namelen;
2693 memcpy(*buffer, str, namelen);
2694 return 0;
2695}
2696
Waiman Long232d2d62013-09-09 12:18:13 -04002697/**
2698 * prepend_name - prepend a pathname in front of current buffer pointer
2699 * buffer: buffer pointer
2700 * buflen: allocated length of the buffer
2701 * name: name string and length qstr structure
2702 *
2703 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
2704 * make sure that either the old or the new name pointer and length are
2705 * fetched. However, there may be mismatch between length and pointer.
2706 * The length cannot be trusted, we need to copy it byte-by-byte until
2707 * the length is reached or a null byte is found. It also prepends "/" at
2708 * the beginning of the name. The sequence number check at the caller will
2709 * retry it again when a d_move() does happen. So any garbage in the buffer
2710 * due to mismatched pointer and length will be discarded.
2711 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002712static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2713{
Waiman Long232d2d62013-09-09 12:18:13 -04002714 const char *dname = ACCESS_ONCE(name->name);
2715 u32 dlen = ACCESS_ONCE(name->len);
2716 char *p;
2717
2718 if (*buflen < dlen + 1)
2719 return -ENAMETOOLONG;
2720 *buflen -= dlen + 1;
2721 p = *buffer -= dlen + 1;
2722 *p++ = '/';
2723 while (dlen--) {
2724 char c = *dname++;
2725 if (!c)
2726 break;
2727 *p++ = c;
2728 }
2729 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002730}
2731
Linus Torvalds1da177e2005-04-16 15:20:36 -07002732/**
Randy Dunlap208898c2010-11-18 15:02:49 -08002733 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002734 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002735 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002736 * @buffer: pointer to the end of the buffer
2737 * @buflen: pointer to buffer length
2738 *
Waiman Long232d2d62013-09-09 12:18:13 -04002739 * The function tries to write out the pathname without taking any lock other
2740 * than the RCU read lock to make sure that dentries won't go away. It only
2741 * checks the sequence number of the global rename_lock as any change in the
2742 * dentry's d_seq will be preceded by changes in the rename_lock sequence
2743 * number. If the sequence number had been change, it will restart the whole
2744 * pathname back-tracing sequence again. It performs a total of 3 trials of
2745 * lockless back-tracing sequences before falling back to take the
2746 * rename_lock.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002747 */
Al Viro02125a82011-12-05 08:43:34 -05002748static int prepend_path(const struct path *path,
2749 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002750 char **buffer, int *buflen)
2751{
2752 struct dentry *dentry = path->dentry;
2753 struct vfsmount *vfsmnt = path->mnt;
Al Viro0714a532011-11-24 22:19:58 -05002754 struct mount *mnt = real_mount(vfsmnt);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002755 int error = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04002756 unsigned seq = 0;
2757 char *bptr;
2758 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002759
Al Viro48f5ec22013-09-09 15:22:25 -04002760 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002761restart:
2762 bptr = *buffer;
2763 blen = *buflen;
2764 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002765 while (dentry != root->dentry || vfsmnt != root->mnt) {
2766 struct dentry * parent;
2767
2768 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
2769 /* Global root? */
Waiman Long232d2d62013-09-09 12:18:13 -04002770 if (mnt_has_parent(mnt)) {
2771 dentry = mnt->mnt_mountpoint;
2772 mnt = mnt->mnt_parent;
2773 vfsmnt = &mnt->mnt;
2774 continue;
2775 }
2776 /*
2777 * Filesystems needing to implement special "root names"
2778 * should do so with ->d_dname()
2779 */
2780 if (IS_ROOT(dentry) &&
2781 (dentry->d_name.len != 1 ||
2782 dentry->d_name.name[0] != '/')) {
2783 WARN(1, "Root dentry has weird name <%.*s>\n",
2784 (int) dentry->d_name.len,
2785 dentry->d_name.name);
2786 }
2787 if (!error)
2788 error = is_mounted(vfsmnt) ? 1 : 2;
2789 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002790 }
2791 parent = dentry->d_parent;
2792 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002793 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002794 if (error)
2795 break;
2796
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002797 dentry = parent;
2798 }
Al Viro48f5ec22013-09-09 15:22:25 -04002799 if (!(seq & 1))
2800 rcu_read_unlock();
2801 if (need_seqretry(&rename_lock, seq)) {
2802 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04002803 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002804 }
Al Viro48f5ec22013-09-09 15:22:25 -04002805 done_seqretry(&rename_lock, seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002806
Waiman Long232d2d62013-09-09 12:18:13 -04002807 if (error >= 0 && bptr == *buffer) {
2808 if (--blen < 0)
2809 error = -ENAMETOOLONG;
2810 else
2811 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002812 }
Waiman Long232d2d62013-09-09 12:18:13 -04002813 *buffer = bptr;
2814 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04002815 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002816}
2817
2818/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002819 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002820 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002821 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07002822 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07002823 * @buflen: buffer length
2824 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002825 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002826 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002827 * Returns a pointer into the buffer or an error code if the
2828 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08002829 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04002830 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002831 *
Al Viro02125a82011-12-05 08:43:34 -05002832 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002833 */
Al Viro02125a82011-12-05 08:43:34 -05002834char *__d_path(const struct path *path,
2835 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002836 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002837{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002838 char *res = buf + buflen;
2839 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002840
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002841 prepend(&res, &buflen, "\0", 1);
Al Viro7ea600b2013-03-26 18:25:57 -04002842 br_read_lock(&vfsmount_lock);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002843 error = prepend_path(path, root, &res, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04002844 br_read_unlock(&vfsmount_lock);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002845
Al Viro02125a82011-12-05 08:43:34 -05002846 if (error < 0)
2847 return ERR_PTR(error);
2848 if (error > 0)
2849 return NULL;
2850 return res;
2851}
2852
2853char *d_absolute_path(const struct path *path,
2854 char *buf, int buflen)
2855{
2856 struct path root = {};
2857 char *res = buf + buflen;
2858 int error;
2859
2860 prepend(&res, &buflen, "\0", 1);
Al Viro7ea600b2013-03-26 18:25:57 -04002861 br_read_lock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002862 error = prepend_path(path, &root, &res, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04002863 br_read_unlock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002864
2865 if (error > 1)
2866 error = -EINVAL;
2867 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002868 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002869 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002870}
2871
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002872/*
2873 * same as __d_path but appends "(deleted)" for unlinked files.
2874 */
Al Viro02125a82011-12-05 08:43:34 -05002875static int path_with_deleted(const struct path *path,
2876 const struct path *root,
2877 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002878{
2879 prepend(buf, buflen, "\0", 1);
2880 if (d_unlinked(path->dentry)) {
2881 int error = prepend(buf, buflen, " (deleted)", 10);
2882 if (error)
2883 return error;
2884 }
2885
2886 return prepend_path(path, root, buf, buflen);
2887}
2888
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002889static int prepend_unreachable(char **buffer, int *buflen)
2890{
2891 return prepend(buffer, buflen, "(unreachable)", 13);
2892}
2893
Jan Bluncka03a8a702008-02-14 19:38:32 -08002894/**
2895 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08002896 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08002897 * @buf: buffer to return value in
2898 * @buflen: buffer length
2899 *
2900 * Convert a dentry into an ASCII path name. If the entry has been deleted
2901 * the string " (deleted)" is appended. Note that this is ambiguous.
2902 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002903 * Returns a pointer into the buffer or an error code if the path was
2904 * too long. Note: Callers should use the returned pointer, not the passed
2905 * in buffer, to use the name! The implementation often starts at an offset
2906 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002907 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002908 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002909 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07002910char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002911{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002912 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08002913 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002914 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002915
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002916 /*
2917 * We have various synthetic filesystems that never get mounted. On
2918 * these filesystems dentries are never used for lookup purposes, and
2919 * thus don't need to be hashed. They also don't need a name until a
2920 * user wants to identify the object in /proc/pid/fd/. The little hack
2921 * below allows us to generate a name for these objects on demand:
2922 */
Jan Blunckcf28b482008-02-14 19:38:44 -08002923 if (path->dentry->d_op && path->dentry->d_op->d_dname)
2924 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002925
Miklos Szeredif7ad3c62010-08-10 11:41:36 +02002926 get_fs_root(current->fs, &root);
Al Viro7ea600b2013-03-26 18:25:57 -04002927 br_read_lock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002928 error = path_with_deleted(path, &root, &res, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04002929 br_read_unlock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002930 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002931 res = ERR_PTR(error);
Jan Blunck6ac08c32008-02-14 19:34:38 -08002932 path_put(&root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002933 return res;
2934}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002935EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002936
2937/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002938 * Helper function for dentry_operations.d_dname() members
2939 */
2940char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
2941 const char *fmt, ...)
2942{
2943 va_list args;
2944 char temp[64];
2945 int sz;
2946
2947 va_start(args, fmt);
2948 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
2949 va_end(args);
2950
2951 if (sz > sizeof(temp) || sz > buflen)
2952 return ERR_PTR(-ENAMETOOLONG);
2953
2954 buffer += buflen - sz;
2955 return memcpy(buffer, temp, sz);
2956}
2957
Al Viro118b2302013-08-24 12:08:17 -04002958char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
2959{
2960 char *end = buffer + buflen;
2961 /* these dentries are never renamed, so d_lock is not needed */
2962 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04002963 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04002964 prepend(&end, &buflen, "/", 1))
2965 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04002966 return end;
Al Viro118b2302013-08-24 12:08:17 -04002967}
2968
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002969/*
Ram Pai6092d042008-03-27 13:06:20 +01002970 * Write full pathname from the root of the filesystem into the buffer.
2971 */
Nick Pigginec2447c2011-01-07 17:49:29 +11002972static char *__dentry_path(struct dentry *dentry, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01002973{
Waiman Long232d2d62013-09-09 12:18:13 -04002974 char *end, *retval;
2975 int len, seq = 0;
2976 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01002977
Al Viro48f5ec22013-09-09 15:22:25 -04002978 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002979restart:
2980 end = buf + buflen;
2981 len = buflen;
2982 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01002983 if (buflen < 1)
2984 goto Elong;
2985 /* Get '/' right */
2986 retval = end-1;
2987 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04002988 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002989 while (!IS_ROOT(dentry)) {
2990 struct dentry *parent = dentry->d_parent;
Nick Piggin9abca362011-01-07 17:49:36 +11002991 int error;
Ram Pai6092d042008-03-27 13:06:20 +01002992
Ram Pai6092d042008-03-27 13:06:20 +01002993 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002994 error = prepend_name(&end, &len, &dentry->d_name);
2995 if (error)
2996 break;
Ram Pai6092d042008-03-27 13:06:20 +01002997
2998 retval = end;
2999 dentry = parent;
3000 }
Al Viro48f5ec22013-09-09 15:22:25 -04003001 if (!(seq & 1))
3002 rcu_read_unlock();
3003 if (need_seqretry(&rename_lock, seq)) {
3004 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003005 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003006 }
3007 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003008 if (error)
3009 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003010 return retval;
3011Elong:
3012 return ERR_PTR(-ENAMETOOLONG);
3013}
Nick Pigginec2447c2011-01-07 17:49:29 +11003014
3015char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3016{
Waiman Long232d2d62013-09-09 12:18:13 -04003017 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003018}
3019EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003020
3021char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3022{
3023 char *p = NULL;
3024 char *retval;
3025
Al Viroc1031352010-06-06 22:31:14 -04003026 if (d_unlinked(dentry)) {
3027 p = buf + buflen;
3028 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3029 goto Elong;
3030 buflen++;
3031 }
3032 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003033 if (!IS_ERR(retval) && p)
3034 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003035 return retval;
3036Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003037 return ERR_PTR(-ENAMETOOLONG);
3038}
3039
3040/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003041 * NOTE! The user-level library version returns a
3042 * character pointer. The kernel system call just
3043 * returns the length of the buffer filled (which
3044 * includes the ending '\0' character), or a negative
3045 * error value. So libc would do something like
3046 *
3047 * char *getcwd(char * buf, size_t size)
3048 * {
3049 * int retval;
3050 *
3051 * retval = sys_getcwd(buf, size);
3052 * if (retval >= 0)
3053 * return buf;
3054 * errno = -retval;
3055 * return NULL;
3056 * }
3057 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003058SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003059{
Linus Torvalds552ce542007-02-13 12:08:18 -08003060 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003061 struct path pwd, root;
Linus Torvalds552ce542007-02-13 12:08:18 -08003062 char *page = (char *) __get_free_page(GFP_USER);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003063
3064 if (!page)
3065 return -ENOMEM;
3066
Miklos Szeredif7ad3c62010-08-10 11:41:36 +02003067 get_fs_root_and_pwd(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003068
Linus Torvalds552ce542007-02-13 12:08:18 -08003069 error = -ENOENT;
Al Viro7ea600b2013-03-26 18:25:57 -04003070 br_read_lock(&vfsmount_lock);
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003071 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003072 unsigned long len;
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003073 char *cwd = page + PAGE_SIZE;
3074 int buflen = PAGE_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003075
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003076 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003077 error = prepend_path(&pwd, &root, &cwd, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04003078 br_read_unlock(&vfsmount_lock);
Linus Torvalds552ce542007-02-13 12:08:18 -08003079
Al Viro02125a82011-12-05 08:43:34 -05003080 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003081 goto out;
3082
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003083 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003084 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003085 error = prepend_unreachable(&cwd, &buflen);
3086 if (error)
3087 goto out;
3088 }
3089
Linus Torvalds552ce542007-02-13 12:08:18 -08003090 error = -ERANGE;
3091 len = PAGE_SIZE + page - cwd;
3092 if (len <= size) {
3093 error = len;
3094 if (copy_to_user(buf, cwd, len))
3095 error = -EFAULT;
3096 }
Nick Piggin949854d2011-01-07 17:49:37 +11003097 } else {
Al Viro7ea600b2013-03-26 18:25:57 -04003098 br_read_unlock(&vfsmount_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003099 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003100
3101out:
Jan Blunck6ac08c32008-02-14 19:34:38 -08003102 path_put(&pwd);
3103 path_put(&root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003104 free_page((unsigned long) page);
3105 return error;
3106}
3107
3108/*
3109 * Test whether new_dentry is a subdirectory of old_dentry.
3110 *
3111 * Trivially implemented using the dcache structure
3112 */
3113
3114/**
3115 * is_subdir - is new dentry a subdirectory of old_dentry
3116 * @new_dentry: new dentry
3117 * @old_dentry: old dentry
3118 *
3119 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
3120 * Returns 0 otherwise.
3121 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3122 */
3123
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003124int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003125{
3126 int result;
Nick Piggin949854d2011-01-07 17:49:37 +11003127 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003128
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003129 if (new_dentry == old_dentry)
3130 return 1;
3131
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003132 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003133 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003134 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003135 /*
3136 * Need rcu_readlock to protect against the d_parent trashing
3137 * due to d_move
3138 */
3139 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003140 if (d_ancestor(old_dentry, new_dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003141 result = 1;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003142 else
3143 result = 0;
Nick Piggin949854d2011-01-07 17:49:37 +11003144 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003145 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003146
3147 return result;
3148}
3149
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003150static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003151{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003152 struct dentry *root = data;
3153 if (dentry != root) {
3154 if (d_unhashed(dentry) || !dentry->d_inode)
3155 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003156
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003157 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3158 dentry->d_flags |= DCACHE_GENOCIDE;
3159 dentry->d_lockref.count--;
3160 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003161 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003162 return D_WALK_CONTINUE;
3163}
Nick Piggin58db63d2011-01-07 17:49:39 +11003164
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003165void d_genocide(struct dentry *parent)
3166{
3167 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003168}
3169
Al Viro60545d02013-06-07 01:20:27 -04003170void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003171{
Al Viro60545d02013-06-07 01:20:27 -04003172 inode_dec_link_count(inode);
3173 BUG_ON(dentry->d_name.name != dentry->d_iname ||
3174 !hlist_unhashed(&dentry->d_alias) ||
3175 !d_unlinked(dentry));
3176 spin_lock(&dentry->d_parent->d_lock);
3177 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3178 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3179 (unsigned long long)inode->i_ino);
3180 spin_unlock(&dentry->d_lock);
3181 spin_unlock(&dentry->d_parent->d_lock);
3182 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003183}
Al Viro60545d02013-06-07 01:20:27 -04003184EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003185
3186static __initdata unsigned long dhash_entries;
3187static int __init set_dhash_entries(char *str)
3188{
3189 if (!str)
3190 return 0;
3191 dhash_entries = simple_strtoul(str, &str, 0);
3192 return 1;
3193}
3194__setup("dhash_entries=", set_dhash_entries);
3195
3196static void __init dcache_init_early(void)
3197{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003198 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003199
3200 /* If hashes are distributed across NUMA nodes, defer
3201 * hash allocation until vmalloc space is available.
3202 */
3203 if (hashdist)
3204 return;
3205
3206 dentry_hashtable =
3207 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003208 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003209 dhash_entries,
3210 13,
3211 HASH_EARLY,
3212 &d_hash_shift,
3213 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003214 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003215 0);
3216
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003217 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003218 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003219}
3220
Denis Cheng74bf17c2007-10-16 23:26:30 -07003221static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003222{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003223 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003224
3225 /*
3226 * A constructor could be added for stable state like the lists,
3227 * but it is probably not worth it because of the cache nature
3228 * of the dcache.
3229 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003230 dentry_cache = KMEM_CACHE(dentry,
3231 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003232
3233 /* Hash may have been set up in dcache_init_early */
3234 if (!hashdist)
3235 return;
3236
3237 dentry_hashtable =
3238 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003239 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003240 dhash_entries,
3241 13,
3242 0,
3243 &d_hash_shift,
3244 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003245 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003246 0);
3247
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003248 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003249 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003250}
3251
3252/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003253struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003254EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003255
Linus Torvalds1da177e2005-04-16 15:20:36 -07003256EXPORT_SYMBOL(d_genocide);
3257
Linus Torvalds1da177e2005-04-16 15:20:36 -07003258void __init vfs_caches_init_early(void)
3259{
3260 dcache_init_early();
3261 inode_init_early();
3262}
3263
3264void __init vfs_caches_init(unsigned long mempages)
3265{
3266 unsigned long reserve;
3267
3268 /* Base hash sizes on available memory, with a reserve equal to
3269 150% of current kernel size */
3270
3271 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
3272 mempages -= reserve;
3273
3274 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003275 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003276
Denis Cheng74bf17c2007-10-16 23:26:30 -07003277 dcache_init();
3278 inode_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003279 files_init(mempages);
Denis Cheng74bf17c2007-10-16 23:26:30 -07003280 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003281 bdev_cache_init();
3282 chrdev_init();
3283}