blob: d74b5bdff7f959a1201a94e2d74ff09cf75c9db1 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/dcache.c
3 *
4 * Complete reimplementation
5 * (C) 1997 Thomas Schoebel-Theuer,
6 * with heavy changes by Linus Torvalds
7 */
8
9/*
10 * Notes on the allocation strategy:
11 *
12 * The dcache is a master of the icache - whenever a dcache entry
13 * exists, the inode will always exist. "iput()" is done either when
14 * the dcache entry is deleted or garbage collected.
15 */
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/syscalls.h>
18#include <linux/string.h>
19#include <linux/mm.h>
20#include <linux/fs.h>
John McCutchan7a91bf72005-08-08 13:52:16 -040021#include <linux/fsnotify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/slab.h>
23#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/hash.h>
25#include <linux/cache.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/mount.h>
28#include <linux/file.h>
29#include <asm/uaccess.h>
30#include <linux/security.h>
31#include <linux/seqlock.h>
32#include <linux/swap.h>
33#include <linux/bootmem.h>
Al Viro5ad4e532009-03-29 19:50:06 -040034#include <linux/fs_struct.h>
Frederic Weisbecker613afbf2009-07-16 15:44:29 +020035#include <linux/hardirq.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110036#include <linux/bit_spinlock.h>
37#include <linux/rculist_bl.h>
Linus Torvalds268bb0c2011-05-20 12:50:29 -070038#include <linux/prefetch.h>
David Howellsdd179942011-08-16 15:31:30 +010039#include <linux/ratelimit.h>
Dave Chinnerf6041562013-08-28 10:18:00 +100040#include <linux/list_lru.h>
David Howells07f3f052006-09-30 20:52:18 +020041#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050042#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Nick Piggin789680d2011-01-07 17:49:30 +110044/*
45 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110046 * dcache->d_inode->i_lock protects:
47 * - i_dentry, d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110048 * dcache_hash_bucket lock protects:
49 * - the dcache hash table
50 * s_anon bl list spinlock protects:
51 * - the s_anon list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100052 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110053 * - the dcache lru lists and counters
54 * d_lock protects:
55 * - d_flags
56 * - d_name
57 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110058 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110059 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110060 * - d_parent and d_subdirs
61 * - childrens' d_child and d_parent
Nick Pigginb23fb0a2011-01-07 17:49:35 +110062 * - d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110063 *
64 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110065 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110066 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100067 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110068 * dcache_hash_bucket lock
69 * s_anon lock
Nick Piggin789680d2011-01-07 17:49:30 +110070 *
Nick Pigginda502952011-01-07 17:49:33 +110071 * If there is an ancestor relationship:
72 * dentry->d_parent->...->d_parent->d_lock
73 * ...
74 * dentry->d_parent->d_lock
75 * dentry->d_lock
76 *
77 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110078 * if (dentry1 < dentry2)
79 * dentry1->d_lock
80 * dentry2->d_lock
81 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080082int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070083EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
84
Al Viro74c3cbe2007-07-22 08:04:18 -040085__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Nick Piggin949854d2011-01-07 17:49:37 +110087EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Christoph Lametere18b8902006-12-06 20:33:20 -080089static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Waiman Long232d2d62013-09-09 12:18:13 -040091/**
92 * read_seqbegin_or_lock - begin a sequence number check or locking block
93 * lock: sequence lock
94 * seq : sequence number to be checked
95 *
96 * First try it once optimistically without taking the lock. If that fails,
97 * take the lock. The sequence number is also used as a marker for deciding
98 * whether to be a reader (even) or writer (odd).
99 * N.B. seq must be initialized to an even number to begin with.
100 */
101static inline void read_seqbegin_or_lock(seqlock_t *lock, int *seq)
102{
Al Viro48f5ec22013-09-09 15:22:25 -0400103 if (!(*seq & 1)) /* Even */
Waiman Long232d2d62013-09-09 12:18:13 -0400104 *seq = read_seqbegin(lock);
Al Viro48f5ec22013-09-09 15:22:25 -0400105 else /* Odd */
Waiman Long232d2d62013-09-09 12:18:13 -0400106 write_seqlock(lock);
107}
108
Al Viro48f5ec22013-09-09 15:22:25 -0400109static inline int need_seqretry(seqlock_t *lock, int seq)
Waiman Long232d2d62013-09-09 12:18:13 -0400110{
Al Viro48f5ec22013-09-09 15:22:25 -0400111 return !(seq & 1) && read_seqretry(lock, seq);
112}
113
114static inline void done_seqretry(seqlock_t *lock, int seq)
115{
116 if (seq & 1)
Waiman Long232d2d62013-09-09 12:18:13 -0400117 write_sequnlock(lock);
Waiman Long232d2d62013-09-09 12:18:13 -0400118}
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120/*
121 * This is the single most critical data structure when it comes
122 * to the dcache: the hashtable for lookups. Somebody should try
123 * to make this good - I've just made it work.
124 *
125 * This hash-function tries to avoid losing too many bits of hash
126 * information, yet avoid using a prime hash-size or similar.
127 */
128#define D_HASHBITS d_hash_shift
129#define D_HASHMASK d_hash_mask
130
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800131static unsigned int d_hash_mask __read_mostly;
132static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100133
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700134static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100135
Linus Torvalds8966be92012-03-02 14:23:30 -0800136static inline struct hlist_bl_head *d_hash(const struct dentry *parent,
Linus Torvalds6d7d1a02012-03-19 16:19:53 -0700137 unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100138{
Linus Torvalds6d7d1a02012-03-19 16:19:53 -0700139 hash += (unsigned long) parent / L1_CACHE_BYTES;
140 hash = hash + (hash >> D_HASHBITS);
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100141 return dentry_hashtable + (hash & D_HASHMASK);
142}
143
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144/* Statistics gathering. */
145struct dentry_stat_t dentry_stat = {
146 .age_limit = 45,
147};
148
Glauber Costa3942c072013-08-28 10:17:53 +1000149static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000150static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400151
152#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000153
154/*
155 * Here we resort to our own counters instead of using generic per-cpu counters
156 * for consistency with what the vfs inode code does. We are expected to harvest
157 * better code and performance by having our own specialized counters.
158 *
159 * Please note that the loop is done over all possible CPUs, not over all online
160 * CPUs. The reason for this is that we don't want to play games with CPUs going
161 * on and off. If one of them goes off, we will just keep their counters.
162 *
163 * glommer: See cffbc8a for details, and if you ever intend to change this,
164 * please update all vfs counters to match.
165 */
Glauber Costa3942c072013-08-28 10:17:53 +1000166static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100167{
168 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000169 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100170 for_each_possible_cpu(i)
171 sum += per_cpu(nr_dentry, i);
172 return sum < 0 ? 0 : sum;
173}
174
Dave Chinner62d36c72013-08-28 10:17:54 +1000175static long get_nr_dentry_unused(void)
176{
177 int i;
178 long sum = 0;
179 for_each_possible_cpu(i)
180 sum += per_cpu(nr_dentry_unused, i);
181 return sum < 0 ? 0 : sum;
182}
183
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400184int proc_nr_dentry(ctl_table *table, int write, void __user *buffer,
185 size_t *lenp, loff_t *ppos)
186{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100187 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000188 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000189 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400190}
191#endif
192
Linus Torvalds5483f182012-03-04 15:51:42 -0800193/*
194 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
195 * The strings are both count bytes long, and count is non-zero.
196 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700197#ifdef CONFIG_DCACHE_WORD_ACCESS
198
199#include <asm/word-at-a-time.h>
200/*
201 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
202 * aligned allocation for this particular component. We don't
203 * strictly need the load_unaligned_zeropad() safety, but it
204 * doesn't hurt either.
205 *
206 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
207 * need the careful unaligned handling.
208 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700209static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800210{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800211 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800212
213 for (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700214 a = *(unsigned long *)cs;
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700215 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800216 if (tcount < sizeof(unsigned long))
217 break;
218 if (unlikely(a != b))
219 return 1;
220 cs += sizeof(unsigned long);
221 ct += sizeof(unsigned long);
222 tcount -= sizeof(unsigned long);
223 if (!tcount)
224 return 0;
225 }
226 mask = ~(~0ul << tcount*8);
227 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700228}
229
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800230#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700231
Linus Torvalds94753db52012-05-10 12:19:19 -0700232static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700233{
Linus Torvalds5483f182012-03-04 15:51:42 -0800234 do {
235 if (*cs != *ct)
236 return 1;
237 cs++;
238 ct++;
239 tcount--;
240 } while (tcount);
241 return 0;
242}
243
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700244#endif
245
Linus Torvalds94753db52012-05-10 12:19:19 -0700246static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
247{
Linus Torvalds6326c712012-05-21 16:14:04 -0700248 const unsigned char *cs;
Linus Torvalds94753db52012-05-10 12:19:19 -0700249 /*
250 * Be careful about RCU walk racing with rename:
251 * use ACCESS_ONCE to fetch the name pointer.
252 *
253 * NOTE! Even if a rename will mean that the length
254 * was not loaded atomically, we don't care. The
255 * RCU walk will check the sequence count eventually,
256 * and catch it. And we won't overrun the buffer,
257 * because we're reading the name pointer atomically,
258 * and a dentry name is guaranteed to be properly
259 * terminated with a NUL byte.
260 *
261 * End result: even if 'len' is wrong, we'll exit
262 * early because the data cannot match (there can
263 * be no NUL in the ct/tcount data)
264 */
Linus Torvalds6326c712012-05-21 16:14:04 -0700265 cs = ACCESS_ONCE(dentry->d_name.name);
266 smp_read_barrier_depends();
267 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700268}
269
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400270static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400272 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
273
Al Virob3d9b7a2012-06-09 13:51:19 -0400274 WARN_ON(!hlist_unhashed(&dentry->d_alias));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 if (dname_external(dentry))
276 kfree(dentry->d_name.name);
277 kmem_cache_free(dentry_cache, dentry);
278}
279
280/*
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100281 * no locks, please.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 */
283static void d_free(struct dentry *dentry)
284{
Linus Torvalds0d984392013-09-08 13:46:52 -0700285 BUG_ON((int)dentry->d_lockref.count > 0);
Nick Piggin3e880fb2011-01-07 17:49:19 +1100286 this_cpu_dec(nr_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 if (dentry->d_op && dentry->d_op->d_release)
288 dentry->d_op->d_release(dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400289
Linus Torvaldsdea36672011-04-24 07:58:46 -0700290 /* if dentry was never visible to RCU, immediate free is OK */
291 if (!(dentry->d_flags & DCACHE_RCUACCESS))
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400292 __d_free(&dentry->d_u.d_rcu);
Eric Dumazetb3423412006-12-06 20:38:48 -0800293 else
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400294 call_rcu(&dentry->d_u.d_rcu, __d_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295}
296
Nick Piggin31e6b012011-01-07 17:49:52 +1100297/**
298 * dentry_rcuwalk_barrier - invalidate in-progress rcu-walk lookups
Randy Dunlapff5fdb62011-01-22 20:16:06 -0800299 * @dentry: the target dentry
Nick Piggin31e6b012011-01-07 17:49:52 +1100300 * After this call, in-progress rcu-walk path lookup will fail. This
301 * should be called after unhashing, and after changing d_inode (if
302 * the dentry has not already been unhashed).
303 */
304static inline void dentry_rcuwalk_barrier(struct dentry *dentry)
305{
306 assert_spin_locked(&dentry->d_lock);
307 /* Go through a barrier */
308 write_seqcount_barrier(&dentry->d_seq);
309}
310
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311/*
312 * Release the dentry's inode, using the filesystem
Nick Piggin31e6b012011-01-07 17:49:52 +1100313 * d_iput() operation if defined. Dentry has no refcount
314 * and is unhashed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 */
Arjan van de Ven858119e2006-01-14 13:20:43 -0800316static void dentry_iput(struct dentry * dentry)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200317 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100318 __releases(dentry->d_inode->i_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319{
320 struct inode *inode = dentry->d_inode;
321 if (inode) {
322 dentry->d_inode = NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -0400323 hlist_del_init(&dentry->d_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100325 spin_unlock(&inode->i_lock);
Linus Torvaldsf805fbd2005-09-19 19:54:29 -0700326 if (!inode->i_nlink)
327 fsnotify_inoderemove(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 if (dentry->d_op && dentry->d_op->d_iput)
329 dentry->d_op->d_iput(dentry, inode);
330 else
331 iput(inode);
332 } else {
333 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 }
335}
336
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700337/*
Nick Piggin31e6b012011-01-07 17:49:52 +1100338 * Release the dentry's inode, using the filesystem
339 * d_iput() operation if defined. dentry remains in-use.
340 */
341static void dentry_unlink_inode(struct dentry * dentry)
342 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100343 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100344{
345 struct inode *inode = dentry->d_inode;
346 dentry->d_inode = NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -0400347 hlist_del_init(&dentry->d_alias);
Nick Piggin31e6b012011-01-07 17:49:52 +1100348 dentry_rcuwalk_barrier(dentry);
349 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100350 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100351 if (!inode->i_nlink)
352 fsnotify_inoderemove(inode);
353 if (dentry->d_op && dentry->d_op->d_iput)
354 dentry->d_op->d_iput(dentry, inode);
355 else
356 iput(inode);
357}
358
359/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000360 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700361 */
362static void dentry_lru_add(struct dentry *dentry)
363{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700364 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST))) {
Dave Chinnerf6041562013-08-28 10:18:00 +1000365 if (list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru))
366 this_cpu_inc(nr_dentry_unused);
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700367 dentry->d_flags |= DCACHE_LRU_LIST;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400368 }
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700369}
370
Sage Weilf0023bc2011-10-28 10:02:42 -0700371/*
372 * Remove a dentry with references from the LRU.
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000373 *
374 * If we are on the shrink list, then we can get to try_prune_one_dentry() and
375 * lose our last reference through the parent walk. In this case, we need to
376 * remove ourselves from the shrink list, not the LRU.
Sage Weilf0023bc2011-10-28 10:02:42 -0700377 */
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700378static void dentry_lru_del(struct dentry *dentry)
379{
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000380 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
381 list_del_init(&dentry->d_lru);
382 dentry->d_flags &= ~DCACHE_SHRINK_LIST;
383 return;
384 }
385
Dave Chinnerf6041562013-08-28 10:18:00 +1000386 if (list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru))
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000387 this_cpu_dec(nr_dentry_unused);
Dave Chinnerf6041562013-08-28 10:18:00 +1000388 dentry->d_flags &= ~DCACHE_LRU_LIST;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700389}
390
Miklos Szeredid52b9082007-05-08 00:23:46 -0700391/**
392 * d_kill - kill dentry and return parent
393 * @dentry: dentry to kill
Randy Dunlapff5fdb62011-01-22 20:16:06 -0800394 * @parent: parent dentry
Miklos Szeredid52b9082007-05-08 00:23:46 -0700395 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200396 * The dentry must already be unhashed and removed from the LRU.
Miklos Szeredid52b9082007-05-08 00:23:46 -0700397 *
398 * If this is the root of the dentry tree, return NULL.
Nick Piggin23044502011-01-07 17:49:31 +1100399 *
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100400 * dentry->d_lock and parent->d_lock must be held by caller, and are dropped by
401 * d_kill.
Miklos Szeredid52b9082007-05-08 00:23:46 -0700402 */
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100403static struct dentry *d_kill(struct dentry *dentry, struct dentry *parent)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200404 __releases(dentry->d_lock)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100405 __releases(parent->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100406 __releases(dentry->d_inode->i_lock)
Miklos Szeredid52b9082007-05-08 00:23:46 -0700407{
Miklos Szeredid52b9082007-05-08 00:23:46 -0700408 list_del(&dentry->d_u.d_child);
Trond Myklebustc83ce982011-03-15 13:36:43 -0400409 /*
410 * Inform try_to_ascend() that we are no longer attached to the
411 * dentry tree
412 */
Miklos Szeredib161dfa62012-09-17 22:31:38 +0200413 dentry->d_flags |= DCACHE_DENTRY_KILLED;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100414 if (parent)
415 spin_unlock(&parent->d_lock);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700416 dentry_iput(dentry);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100417 /*
418 * dentry_iput drops the locks, at which point nobody (except
419 * transient RCU lookups) can reach this dentry.
420 */
Miklos Szeredid52b9082007-05-08 00:23:46 -0700421 d_free(dentry);
OGAWA Hirofumi871c0062008-10-16 07:50:27 +0900422 return parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700423}
424
David Howellsc6627c62011-06-07 14:09:20 +0100425/*
426 * Unhash a dentry without inserting an RCU walk barrier or checking that
427 * dentry->d_lock is locked. The caller must take care of that, if
428 * appropriate.
429 */
430static void __d_shrink(struct dentry *dentry)
431{
432 if (!d_unhashed(dentry)) {
433 struct hlist_bl_head *b;
434 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
435 b = &dentry->d_sb->s_anon;
436 else
437 b = d_hash(dentry->d_parent, dentry->d_name.hash);
438
439 hlist_bl_lock(b);
440 __hlist_bl_del(&dentry->d_hash);
441 dentry->d_hash.pprev = NULL;
442 hlist_bl_unlock(b);
443 }
444}
445
Nick Piggin789680d2011-01-07 17:49:30 +1100446/**
447 * d_drop - drop a dentry
448 * @dentry: dentry to drop
449 *
450 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
451 * be found through a VFS lookup any more. Note that this is different from
452 * deleting the dentry - d_delete will try to mark the dentry negative if
453 * possible, giving a successful _negative_ lookup, while d_drop will
454 * just make the cache lookup fail.
455 *
456 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
457 * reason (NFS timeouts or autofs deletes).
458 *
459 * __d_drop requires dentry->d_lock.
460 */
461void __d_drop(struct dentry *dentry)
462{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700463 if (!d_unhashed(dentry)) {
David Howellsc6627c62011-06-07 14:09:20 +0100464 __d_shrink(dentry);
Linus Torvaldsdea36672011-04-24 07:58:46 -0700465 dentry_rcuwalk_barrier(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +1100466 }
467}
468EXPORT_SYMBOL(__d_drop);
469
470void d_drop(struct dentry *dentry)
471{
Nick Piggin789680d2011-01-07 17:49:30 +1100472 spin_lock(&dentry->d_lock);
473 __d_drop(dentry);
474 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100475}
476EXPORT_SYMBOL(d_drop);
477
Nick Piggin77812a12011-01-07 17:49:48 +1100478/*
479 * Finish off a dentry we've decided to kill.
480 * dentry->d_lock must be held, returns with it unlocked.
481 * If ref is non-zero, then decrement the refcount too.
482 * Returns dentry requiring refcount drop, or NULL if we're done.
483 */
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000484static inline struct dentry *
485dentry_kill(struct dentry *dentry, int unlock_on_failure)
Nick Piggin77812a12011-01-07 17:49:48 +1100486 __releases(dentry->d_lock)
487{
Nick Piggin873feea2011-01-07 17:50:06 +1100488 struct inode *inode;
Nick Piggin77812a12011-01-07 17:49:48 +1100489 struct dentry *parent;
490
Nick Piggin873feea2011-01-07 17:50:06 +1100491 inode = dentry->d_inode;
492 if (inode && !spin_trylock(&inode->i_lock)) {
Nick Piggin77812a12011-01-07 17:49:48 +1100493relock:
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000494 if (unlock_on_failure) {
495 spin_unlock(&dentry->d_lock);
496 cpu_relax();
497 }
Nick Piggin77812a12011-01-07 17:49:48 +1100498 return dentry; /* try again with same dentry */
499 }
500 if (IS_ROOT(dentry))
501 parent = NULL;
502 else
503 parent = dentry->d_parent;
504 if (parent && !spin_trylock(&parent->d_lock)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100505 if (inode)
506 spin_unlock(&inode->i_lock);
Nick Piggin77812a12011-01-07 17:49:48 +1100507 goto relock;
508 }
Nick Piggin31e6b012011-01-07 17:49:52 +1100509
Linus Torvalds0d984392013-09-08 13:46:52 -0700510 /*
511 * The dentry is now unrecoverably dead to the world.
512 */
513 lockref_mark_dead(&dentry->d_lockref);
514
Sage Weilf0023bc2011-10-28 10:02:42 -0700515 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700516 * inform the fs via d_prune that this dentry is about to be
517 * unhashed and destroyed.
518 */
Yan, Zheng590fb512013-08-13 15:42:02 +0800519 if ((dentry->d_flags & DCACHE_OP_PRUNE) && !d_unhashed(dentry))
Yan, Zheng61572bb2013-04-15 14:13:21 +0800520 dentry->d_op->d_prune(dentry);
521
522 dentry_lru_del(dentry);
Nick Piggin77812a12011-01-07 17:49:48 +1100523 /* if it was on the hash then remove it */
524 __d_drop(dentry);
525 return d_kill(dentry, parent);
526}
527
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528/*
529 * This is dput
530 *
531 * This is complicated by the fact that we do not want to put
532 * dentries that are no longer on any hash chain on the unused
533 * list: we'd much rather just get rid of them immediately.
534 *
535 * However, that implies that we have to traverse the dentry
536 * tree upwards to the parents which might _also_ now be
537 * scheduled for deletion (it may have been only waiting for
538 * its last child to go away).
539 *
540 * This tail recursion is done by hand as we don't want to depend
541 * on the compiler to always get this right (gcc generally doesn't).
542 * Real recursion would eat up our stack space.
543 */
544
545/*
546 * dput - release a dentry
547 * @dentry: dentry to release
548 *
549 * Release a dentry. This will drop the usage count and if appropriate
550 * call the dentry unlink method as well as removing it from the queues and
551 * releasing its resources. If the parent dentries were scheduled for release
552 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554void dput(struct dentry *dentry)
555{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700556 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 return;
558
559repeat:
Waiman Long98474232013-08-28 18:24:59 -0700560 if (lockref_put_or_lock(&dentry->d_lockref))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700563 /* Unreachable? Get rid of it */
564 if (unlikely(d_unhashed(dentry)))
565 goto kill_it;
566
567 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100569 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 }
Nick Piggin265ac902010-10-10 05:36:24 -0400571
Jeff Layton39e3c952012-11-28 11:30:53 -0500572 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400573 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400574
Waiman Long98474232013-08-28 18:24:59 -0700575 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100576 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 return;
578
Miklos Szeredid52b9082007-05-08 00:23:46 -0700579kill_it:
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000580 dentry = dentry_kill(dentry, 1);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700581 if (dentry)
582 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700584EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585
586/**
587 * d_invalidate - invalidate a dentry
588 * @dentry: dentry to invalidate
589 *
590 * Try to invalidate the dentry if it turns out to be
591 * possible. If there are other dentries that can be
592 * reached through this one we can't delete it and we
593 * return -EBUSY. On success we return 0.
594 *
595 * no dcache lock.
596 */
597
598int d_invalidate(struct dentry * dentry)
599{
600 /*
601 * If it's already been dropped, return OK.
602 */
Nick Pigginda502952011-01-07 17:49:33 +1100603 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 if (d_unhashed(dentry)) {
Nick Pigginda502952011-01-07 17:49:33 +1100605 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 return 0;
607 }
608 /*
609 * Check whether to do a partial shrink_dcache
610 * to get rid of unused child entries.
611 */
612 if (!list_empty(&dentry->d_subdirs)) {
Nick Pigginda502952011-01-07 17:49:33 +1100613 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 shrink_dcache_parent(dentry);
Nick Pigginda502952011-01-07 17:49:33 +1100615 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 }
617
618 /*
619 * Somebody else still using it?
620 *
621 * If it's a directory, we can't drop it
622 * for fear of somebody re-populating it
623 * with children (even though dropping it
624 * would make it unreachable from the root,
625 * we might still populate it if it was a
626 * working directory or similar).
Al Viro50e69632011-11-07 16:39:57 +0000627 * We also need to leave mountpoints alone,
628 * directory or not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 */
Waiman Long98474232013-08-28 18:24:59 -0700630 if (dentry->d_lockref.count > 1 && dentry->d_inode) {
Al Viro50e69632011-11-07 16:39:57 +0000631 if (S_ISDIR(dentry->d_inode->i_mode) || d_mountpoint(dentry)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 return -EBUSY;
634 }
635 }
636
637 __d_drop(dentry);
638 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 return 0;
640}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700641EXPORT_SYMBOL(d_invalidate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100643/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100644static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645{
Waiman Long98474232013-08-28 18:24:59 -0700646 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647}
648
Nick Piggindc0474b2011-01-07 17:49:43 +1100649static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100650{
Waiman Long98474232013-08-28 18:24:59 -0700651 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100652}
653
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100654struct dentry *dget_parent(struct dentry *dentry)
655{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700656 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100657 struct dentry *ret;
658
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700659 /*
660 * Do optimistic parent lookup without any
661 * locking.
662 */
663 rcu_read_lock();
664 ret = ACCESS_ONCE(dentry->d_parent);
665 gotref = lockref_get_not_zero(&ret->d_lockref);
666 rcu_read_unlock();
667 if (likely(gotref)) {
668 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
669 return ret;
670 dput(ret);
671 }
672
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100673repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100674 /*
675 * Don't need rcu_dereference because we re-check it was correct under
676 * the lock.
677 */
678 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100679 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100680 spin_lock(&ret->d_lock);
681 if (unlikely(ret != dentry->d_parent)) {
682 spin_unlock(&ret->d_lock);
683 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100684 goto repeat;
685 }
Nick Piggina734eb42011-01-07 17:49:44 +1100686 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700687 BUG_ON(!ret->d_lockref.count);
688 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100689 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100690 return ret;
691}
692EXPORT_SYMBOL(dget_parent);
693
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694/**
695 * d_find_alias - grab a hashed alias of inode
696 * @inode: inode in question
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700697 * @want_discon: flag, used by d_splice_alias, to request
698 * that only a DISCONNECTED alias be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 *
700 * If inode has a hashed alias, or is a directory and has any alias,
701 * acquire the reference to alias and return it. Otherwise return NULL.
702 * Notice that if inode is a directory there can be only one alias and
703 * it can be unhashed only if it has no children, or if it is the root
704 * of a filesystem.
705 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700706 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700707 * any other hashed alias over that one unless @want_discon is set,
708 * in which case only return an IS_ROOT, DCACHE_DISCONNECTED alias.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 */
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700710static struct dentry *__d_find_alias(struct inode *inode, int want_discon)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711{
Nick Pigginda502952011-01-07 17:49:33 +1100712 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
Nick Pigginda502952011-01-07 17:49:33 +1100714again:
715 discon_alias = NULL;
Sasha Levinb67bfe02013-02-27 17:06:00 -0800716 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100717 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700719 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100720 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 discon_alias = alias;
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700722 } else if (!want_discon) {
Nick Piggindc0474b2011-01-07 17:49:43 +1100723 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100724 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 return alias;
726 }
727 }
Nick Pigginda502952011-01-07 17:49:33 +1100728 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 }
Nick Pigginda502952011-01-07 17:49:33 +1100730 if (discon_alias) {
731 alias = discon_alias;
732 spin_lock(&alias->d_lock);
733 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
734 if (IS_ROOT(alias) &&
735 (alias->d_flags & DCACHE_DISCONNECTED)) {
Nick Piggindc0474b2011-01-07 17:49:43 +1100736 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100737 spin_unlock(&alias->d_lock);
738 return alias;
739 }
740 }
741 spin_unlock(&alias->d_lock);
742 goto again;
743 }
744 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745}
746
Nick Pigginda502952011-01-07 17:49:33 +1100747struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748{
David Howells214fda12006-03-25 03:06:36 -0800749 struct dentry *de = NULL;
750
Al Virob3d9b7a2012-06-09 13:51:19 -0400751 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100752 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700753 de = __d_find_alias(inode, 0);
Nick Piggin873feea2011-01-07 17:50:06 +1100754 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800755 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 return de;
757}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700758EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759
760/*
761 * Try to kill dentries associated with this inode.
762 * WARNING: you must own a reference to inode.
763 */
764void d_prune_aliases(struct inode *inode)
765{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700766 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100768 spin_lock(&inode->i_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -0800769 hlist_for_each_entry(dentry, &inode->i_dentry, d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700771 if (!dentry->d_lockref.count) {
Yan, Zheng590fb512013-08-13 15:42:02 +0800772 /*
773 * inform the fs via d_prune that this dentry
774 * is about to be unhashed and destroyed.
775 */
776 if ((dentry->d_flags & DCACHE_OP_PRUNE) &&
777 !d_unhashed(dentry))
778 dentry->d_op->d_prune(dentry);
779
Nick Piggindc0474b2011-01-07 17:49:43 +1100780 __dget_dlock(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 __d_drop(dentry);
782 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100783 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 dput(dentry);
785 goto restart;
786 }
787 spin_unlock(&dentry->d_lock);
788 }
Nick Piggin873feea2011-01-07 17:50:06 +1100789 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700791EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792
793/*
Nick Piggin77812a12011-01-07 17:49:48 +1100794 * Try to throw away a dentry - free the inode, dput the parent.
795 * Requires dentry->d_lock is held, and dentry->d_count == 0.
796 * Releases dentry->d_lock.
Andrew Mortond702ccb2006-06-22 14:47:31 -0700797 *
Nick Piggin77812a12011-01-07 17:49:48 +1100798 * This may fail if locks cannot be acquired no problem, just try again.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 */
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000800static struct dentry * try_prune_one_dentry(struct dentry *dentry)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200801 __releases(dentry->d_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802{
Nick Piggin77812a12011-01-07 17:49:48 +1100803 struct dentry *parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700804
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000805 parent = dentry_kill(dentry, 0);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700806 /*
Nick Piggin77812a12011-01-07 17:49:48 +1100807 * If dentry_kill returns NULL, we have nothing more to do.
808 * if it returns the same dentry, trylocks failed. In either
809 * case, just loop again.
810 *
811 * Otherwise, we need to prune ancestors too. This is necessary
812 * to prevent quadratic behavior of shrink_dcache_parent(), but
813 * is also expected to be beneficial in reducing dentry cache
814 * fragmentation.
Miklos Szeredid52b9082007-05-08 00:23:46 -0700815 */
Nick Piggin77812a12011-01-07 17:49:48 +1100816 if (!parent)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000817 return NULL;
Nick Piggin77812a12011-01-07 17:49:48 +1100818 if (parent == dentry)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000819 return dentry;
Nick Piggin77812a12011-01-07 17:49:48 +1100820
821 /* Prune ancestors. */
822 dentry = parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700823 while (dentry) {
Waiman Long98474232013-08-28 18:24:59 -0700824 if (lockref_put_or_lock(&dentry->d_lockref))
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000825 return NULL;
826 dentry = dentry_kill(dentry, 1);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700827 }
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000828 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829}
830
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400831static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832{
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700833 struct dentry *dentry;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700834
Nick Pigginec336792011-01-07 17:49:47 +1100835 rcu_read_lock();
836 for (;;) {
Nick Pigginec336792011-01-07 17:49:47 +1100837 dentry = list_entry_rcu(list->prev, struct dentry, d_lru);
838 if (&dentry->d_lru == list)
839 break; /* empty */
840 spin_lock(&dentry->d_lock);
841 if (dentry != list_entry(list->prev, struct dentry, d_lru)) {
842 spin_unlock(&dentry->d_lock);
Nick Piggin23044502011-01-07 17:49:31 +1100843 continue;
844 }
845
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000847 * The dispose list is isolated and dentries are not accounted
848 * to the LRU here, so we can simply remove it from the list
849 * here regardless of whether it is referenced or not.
850 */
851 list_del_init(&dentry->d_lru);
852 dentry->d_flags &= ~DCACHE_SHRINK_LIST;
853
854 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000856 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 */
Waiman Long98474232013-08-28 18:24:59 -0700858 if (dentry->d_lockref.count) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700859 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 continue;
861 }
Nick Pigginec336792011-01-07 17:49:47 +1100862 rcu_read_unlock();
Nick Piggin77812a12011-01-07 17:49:48 +1100863
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000864 dentry = try_prune_one_dentry(dentry);
Nick Piggin77812a12011-01-07 17:49:48 +1100865
Nick Pigginec336792011-01-07 17:49:47 +1100866 rcu_read_lock();
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000867 if (dentry) {
868 dentry->d_flags |= DCACHE_SHRINK_LIST;
869 list_add(&dentry->d_lru, list);
870 spin_unlock(&dentry->d_lock);
871 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 }
Nick Pigginec336792011-01-07 17:49:47 +1100873 rcu_read_unlock();
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400874}
875
Dave Chinnerf6041562013-08-28 10:18:00 +1000876static enum lru_status
877dentry_lru_isolate(struct list_head *item, spinlock_t *lru_lock, void *arg)
878{
879 struct list_head *freeable = arg;
880 struct dentry *dentry = container_of(item, struct dentry, d_lru);
881
882
883 /*
884 * we are inverting the lru lock/dentry->d_lock here,
885 * so use a trylock. If we fail to get the lock, just skip
886 * it
887 */
888 if (!spin_trylock(&dentry->d_lock))
889 return LRU_SKIP;
890
891 /*
892 * Referenced dentries are still in use. If they have active
893 * counts, just remove them from the LRU. Otherwise give them
894 * another pass through the LRU.
895 */
896 if (dentry->d_lockref.count) {
897 list_del_init(&dentry->d_lru);
898 spin_unlock(&dentry->d_lock);
899 return LRU_REMOVED;
900 }
901
902 if (dentry->d_flags & DCACHE_REFERENCED) {
903 dentry->d_flags &= ~DCACHE_REFERENCED;
904 spin_unlock(&dentry->d_lock);
905
906 /*
907 * The list move itself will be made by the common LRU code. At
908 * this point, we've dropped the dentry->d_lock but keep the
909 * lru lock. This is safe to do, since every list movement is
910 * protected by the lru lock even if both locks are held.
911 *
912 * This is guaranteed by the fact that all LRU management
913 * functions are intermediated by the LRU API calls like
914 * list_lru_add and list_lru_del. List movement in this file
915 * only ever occur through this functions or through callbacks
916 * like this one, that are called from the LRU API.
917 *
918 * The only exceptions to this are functions like
919 * shrink_dentry_list, and code that first checks for the
920 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
921 * operating only with stack provided lists after they are
922 * properly isolated from the main list. It is thus, always a
923 * local access.
924 */
925 return LRU_ROTATE;
926 }
927
928 dentry->d_flags |= DCACHE_SHRINK_LIST;
929 list_move_tail(&dentry->d_lru, freeable);
930 this_cpu_dec(nr_dentry_unused);
931 spin_unlock(&dentry->d_lock);
932
933 return LRU_REMOVED;
934}
935
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400936/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000937 * prune_dcache_sb - shrink the dcache
938 * @sb: superblock
Dave Chinnerf6041562013-08-28 10:18:00 +1000939 * @nr_to_scan : number of entries to try to free
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400940 *
Dave Chinnerf6041562013-08-28 10:18:00 +1000941 * Attempt to shrink the superblock dcache LRU by @nr_to_scan entries. This is
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000942 * done when we need more memory an called from the superblock shrinker
943 * function.
944 *
945 * This function may fail to free any resources if all the dentries are in
946 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400947 */
Dave Chinner0a234c62013-08-28 10:17:57 +1000948long prune_dcache_sb(struct super_block *sb, unsigned long nr_to_scan)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400949{
Dave Chinnerf6041562013-08-28 10:18:00 +1000950 LIST_HEAD(dispose);
951 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400952
Dave Chinnerf6041562013-08-28 10:18:00 +1000953 freed = list_lru_walk(&sb->s_dentry_lru, dentry_lru_isolate,
954 &dispose, nr_to_scan);
955 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +1000956 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957}
958
Glauber Costa4e717f52013-08-28 10:18:03 +1000959static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
960 spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000961{
Glauber Costa4e717f52013-08-28 10:18:03 +1000962 struct list_head *freeable = arg;
963 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000964
Glauber Costa4e717f52013-08-28 10:18:03 +1000965 /*
966 * we are inverting the lru lock/dentry->d_lock here,
967 * so use a trylock. If we fail to get the lock, just skip
968 * it
969 */
970 if (!spin_trylock(&dentry->d_lock))
971 return LRU_SKIP;
972
973 dentry->d_flags |= DCACHE_SHRINK_LIST;
974 list_move_tail(&dentry->d_lru, freeable);
975 this_cpu_dec(nr_dentry_unused);
976 spin_unlock(&dentry->d_lock);
977
978 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000979}
980
Glauber Costa4e717f52013-08-28 10:18:03 +1000981
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700982/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 * shrink_dcache_sb - shrink dcache for a superblock
984 * @sb: superblock
985 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400986 * Shrink the dcache for the specified super block. This is used to free
987 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400989void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990{
Glauber Costa4e717f52013-08-28 10:18:03 +1000991 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400992
Glauber Costa4e717f52013-08-28 10:18:03 +1000993 do {
994 LIST_HEAD(dispose);
995
996 freed = list_lru_walk(&sb->s_dentry_lru,
997 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
998
999 this_cpu_sub(nr_dentry_unused, freed);
1000 shrink_dentry_list(&dispose);
1001 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001003EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004
1005/*
David Howellsc636ebd2006-10-11 01:22:19 -07001006 * destroy a single subtree of dentries for unmount
1007 * - see the comments on shrink_dcache_for_umount() for a description of the
1008 * locking
1009 */
1010static void shrink_dcache_for_umount_subtree(struct dentry *dentry)
1011{
1012 struct dentry *parent;
1013
1014 BUG_ON(!IS_ROOT(dentry));
1015
David Howellsc636ebd2006-10-11 01:22:19 -07001016 for (;;) {
1017 /* descend to the first leaf in the current subtree */
David Howells43c1c9c2011-06-07 14:09:30 +01001018 while (!list_empty(&dentry->d_subdirs))
David Howellsc636ebd2006-10-11 01:22:19 -07001019 dentry = list_entry(dentry->d_subdirs.next,
1020 struct dentry, d_u.d_child);
David Howellsc636ebd2006-10-11 01:22:19 -07001021
1022 /* consume the dentries from this leaf up through its parents
1023 * until we find one with children or run out altogether */
1024 do {
1025 struct inode *inode;
1026
Sage Weilf0023bc2011-10-28 10:02:42 -07001027 /*
Yan, Zheng61572bb2013-04-15 14:13:21 +08001028 * inform the fs that this dentry is about to be
Sage Weilf0023bc2011-10-28 10:02:42 -07001029 * unhashed and destroyed.
1030 */
Yan, Zheng590fb512013-08-13 15:42:02 +08001031 if ((dentry->d_flags & DCACHE_OP_PRUNE) &&
1032 !d_unhashed(dentry))
Yan, Zheng61572bb2013-04-15 14:13:21 +08001033 dentry->d_op->d_prune(dentry);
1034
1035 dentry_lru_del(dentry);
David Howells43c1c9c2011-06-07 14:09:30 +01001036 __d_shrink(dentry);
1037
Waiman Long98474232013-08-28 18:24:59 -07001038 if (dentry->d_lockref.count != 0) {
David Howellsc636ebd2006-10-11 01:22:19 -07001039 printk(KERN_ERR
1040 "BUG: Dentry %p{i=%lx,n=%s}"
1041 " still in use (%d)"
1042 " [unmount of %s %s]\n",
1043 dentry,
1044 dentry->d_inode ?
1045 dentry->d_inode->i_ino : 0UL,
1046 dentry->d_name.name,
Waiman Long98474232013-08-28 18:24:59 -07001047 dentry->d_lockref.count,
David Howellsc636ebd2006-10-11 01:22:19 -07001048 dentry->d_sb->s_type->name,
1049 dentry->d_sb->s_id);
1050 BUG();
1051 }
1052
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001053 if (IS_ROOT(dentry)) {
David Howellsc636ebd2006-10-11 01:22:19 -07001054 parent = NULL;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001055 list_del(&dentry->d_u.d_child);
1056 } else {
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09001057 parent = dentry->d_parent;
Waiman Long98474232013-08-28 18:24:59 -07001058 parent->d_lockref.count--;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001059 list_del(&dentry->d_u.d_child);
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09001060 }
David Howellsc636ebd2006-10-11 01:22:19 -07001061
David Howellsc636ebd2006-10-11 01:22:19 -07001062 inode = dentry->d_inode;
1063 if (inode) {
1064 dentry->d_inode = NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001065 hlist_del_init(&dentry->d_alias);
David Howellsc636ebd2006-10-11 01:22:19 -07001066 if (dentry->d_op && dentry->d_op->d_iput)
1067 dentry->d_op->d_iput(dentry, inode);
1068 else
1069 iput(inode);
1070 }
1071
1072 d_free(dentry);
1073
1074 /* finished when we fall off the top of the tree,
1075 * otherwise we ascend to the parent and move to the
1076 * next sibling if there is one */
1077 if (!parent)
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001078 return;
David Howellsc636ebd2006-10-11 01:22:19 -07001079 dentry = parent;
David Howellsc636ebd2006-10-11 01:22:19 -07001080 } while (list_empty(&dentry->d_subdirs));
1081
1082 dentry = list_entry(dentry->d_subdirs.next,
1083 struct dentry, d_u.d_child);
1084 }
1085}
1086
1087/*
1088 * destroy the dentries attached to a superblock on unmounting
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001089 * - we don't need to use dentry->d_lock because:
David Howellsc636ebd2006-10-11 01:22:19 -07001090 * - the superblock is detached from all mountings and open files, so the
1091 * dentry trees will not be rearranged by the VFS
1092 * - s_umount is write-locked, so the memory pressure shrinker will ignore
1093 * any dentries belonging to this superblock that it comes across
1094 * - the filesystem itself is no longer permitted to rearrange the dentries
1095 * in this superblock
1096 */
1097void shrink_dcache_for_umount(struct super_block *sb)
1098{
1099 struct dentry *dentry;
1100
1101 if (down_read_trylock(&sb->s_umount))
1102 BUG();
1103
1104 dentry = sb->s_root;
1105 sb->s_root = NULL;
Waiman Long98474232013-08-28 18:24:59 -07001106 dentry->d_lockref.count--;
David Howellsc636ebd2006-10-11 01:22:19 -07001107 shrink_dcache_for_umount_subtree(dentry);
1108
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001109 while (!hlist_bl_empty(&sb->s_anon)) {
1110 dentry = hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash);
David Howellsc636ebd2006-10-11 01:22:19 -07001111 shrink_dcache_for_umount_subtree(dentry);
1112 }
1113}
1114
1115/*
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001116 * This tries to ascend one level of parenthood, but
1117 * we can race with renaming, so we need to re-check
1118 * the parenthood after dropping the lock and check
1119 * that the sequence number still matches.
1120 */
Al Viro48f5ec22013-09-09 15:22:25 -04001121static struct dentry *try_to_ascend(struct dentry *old, unsigned seq)
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001122{
1123 struct dentry *new = old->d_parent;
1124
1125 rcu_read_lock();
1126 spin_unlock(&old->d_lock);
1127 spin_lock(&new->d_lock);
1128
1129 /*
1130 * might go back up the wrong parent if we have had a rename
1131 * or deletion
1132 */
1133 if (new != old->d_parent ||
Miklos Szeredib161dfa62012-09-17 22:31:38 +02001134 (old->d_flags & DCACHE_DENTRY_KILLED) ||
Al Viro48f5ec22013-09-09 15:22:25 -04001135 need_seqretry(&rename_lock, seq)) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001136 spin_unlock(&new->d_lock);
1137 new = NULL;
1138 }
1139 rcu_read_unlock();
1140 return new;
1141}
1142
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001144 * enum d_walk_ret - action to talke during tree walk
1145 * @D_WALK_CONTINUE: contrinue walk
1146 * @D_WALK_QUIT: quit walk
1147 * @D_WALK_NORETRY: quit when retry is needed
1148 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001150enum d_walk_ret {
1151 D_WALK_CONTINUE,
1152 D_WALK_QUIT,
1153 D_WALK_NORETRY,
1154 D_WALK_SKIP,
1155};
1156
1157/**
1158 * d_walk - walk the dentry tree
1159 * @parent: start of walk
1160 * @data: data passed to @enter() and @finish()
1161 * @enter: callback when first entering the dentry
1162 * @finish: callback when successfully finished the walk
1163 *
1164 * The @enter() and @finish() callbacks are called with d_lock held.
1165 */
1166static void d_walk(struct dentry *parent, void *data,
1167 enum d_walk_ret (*enter)(void *, struct dentry *),
1168 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169{
Nick Piggin949854d2011-01-07 17:49:37 +11001170 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001172 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001173 enum d_walk_ret ret;
1174 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001175
Nick Piggin58db63d2011-01-07 17:49:39 +11001176again:
Al Viro48f5ec22013-09-09 15:22:25 -04001177 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001178 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001179 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001180
1181 ret = enter(data, this_parent);
1182 switch (ret) {
1183 case D_WALK_CONTINUE:
1184 break;
1185 case D_WALK_QUIT:
1186 case D_WALK_SKIP:
1187 goto out_unlock;
1188 case D_WALK_NORETRY:
1189 retry = false;
1190 break;
1191 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192repeat:
1193 next = this_parent->d_subdirs.next;
1194resume:
1195 while (next != &this_parent->d_subdirs) {
1196 struct list_head *tmp = next;
Eric Dumazet5160ee62006-01-08 01:03:32 -08001197 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001199
1200 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001201
1202 ret = enter(data, dentry);
1203 switch (ret) {
1204 case D_WALK_CONTINUE:
1205 break;
1206 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001207 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001208 goto out_unlock;
1209 case D_WALK_NORETRY:
1210 retry = false;
1211 break;
1212 case D_WALK_SKIP:
1213 spin_unlock(&dentry->d_lock);
1214 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001215 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001216
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001218 spin_unlock(&this_parent->d_lock);
1219 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001221 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 goto repeat;
1223 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001224 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 }
1226 /*
1227 * All done at this level ... ascend and resume the search.
1228 */
1229 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001230 struct dentry *child = this_parent;
Al Viro48f5ec22013-09-09 15:22:25 -04001231 this_parent = try_to_ascend(this_parent, seq);
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001232 if (!this_parent)
Nick Piggin949854d2011-01-07 17:49:37 +11001233 goto rename_retry;
Nick Piggin949854d2011-01-07 17:49:37 +11001234 next = child->d_u.d_child.next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 goto resume;
1236 }
Al Viro48f5ec22013-09-09 15:22:25 -04001237 if (need_seqretry(&rename_lock, seq)) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001238 spin_unlock(&this_parent->d_lock);
1239 goto rename_retry;
1240 }
1241 if (finish)
1242 finish(data);
1243
1244out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001245 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001246 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001247 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001248
1249rename_retry:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001250 if (!retry)
1251 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001252 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001253 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001255
1256/*
1257 * Search for at least 1 mount point in the dentry's subdirs.
1258 * We descend to the next level whenever the d_subdirs
1259 * list is non-empty and continue searching.
1260 */
1261
1262/**
1263 * have_submounts - check for mounts over a dentry
1264 * @parent: dentry to check.
1265 *
1266 * Return true if the parent or its subdirectories contain
1267 * a mount point
1268 */
1269
1270static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1271{
1272 int *ret = data;
1273 if (d_mountpoint(dentry)) {
1274 *ret = 1;
1275 return D_WALK_QUIT;
1276 }
1277 return D_WALK_CONTINUE;
1278}
1279
1280int have_submounts(struct dentry *parent)
1281{
1282 int ret = 0;
1283
1284 d_walk(parent, &ret, check_mount, NULL);
1285
1286 return ret;
1287}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001288EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289
1290/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001291 * Called by mount code to set a mountpoint and check if the mountpoint is
1292 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1293 * subtree can become unreachable).
1294 *
1295 * Only one of check_submounts_and_drop() and d_set_mounted() must succeed. For
1296 * this reason take rename_lock and d_lock on dentry and ancestors.
1297 */
1298int d_set_mounted(struct dentry *dentry)
1299{
1300 struct dentry *p;
1301 int ret = -ENOENT;
1302 write_seqlock(&rename_lock);
1303 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
1304 /* Need exclusion wrt. check_submounts_and_drop() */
1305 spin_lock(&p->d_lock);
1306 if (unlikely(d_unhashed(p))) {
1307 spin_unlock(&p->d_lock);
1308 goto out;
1309 }
1310 spin_unlock(&p->d_lock);
1311 }
1312 spin_lock(&dentry->d_lock);
1313 if (!d_unlinked(dentry)) {
1314 dentry->d_flags |= DCACHE_MOUNTED;
1315 ret = 0;
1316 }
1317 spin_unlock(&dentry->d_lock);
1318out:
1319 write_sequnlock(&rename_lock);
1320 return ret;
1321}
1322
1323/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001324 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 * and move any unused dentries to the end of the unused
1326 * list for prune_dcache(). We descend to the next level
1327 * whenever the d_subdirs list is non-empty and continue
1328 * searching.
1329 *
1330 * It returns zero iff there are no unused children,
1331 * otherwise it returns the number of children moved to
1332 * the end of the unused list. This may not be the total
1333 * number of unused children, because select_parent can
1334 * drop the lock and return early due to latency
1335 * constraints.
1336 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001337
1338struct select_data {
1339 struct dentry *start;
1340 struct list_head dispose;
1341 int found;
1342};
1343
1344static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001346 struct select_data *data = _data;
1347 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001349 if (data->start == dentry)
1350 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001352 /*
1353 * move only zero ref count dentries to the dispose list.
1354 *
1355 * Those which are presently on the shrink list, being processed
1356 * by shrink_dentry_list(), shouldn't be moved. Otherwise the
1357 * loop in shrink_dcache_parent() might not make any progress
1358 * and loop forever.
1359 */
1360 if (dentry->d_lockref.count) {
1361 dentry_lru_del(dentry);
1362 } else if (!(dentry->d_flags & DCACHE_SHRINK_LIST)) {
Dave Chinnerf6041562013-08-28 10:18:00 +10001363 dentry_lru_del(dentry);
1364 list_add_tail(&dentry->d_lru, &data->dispose);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001365 dentry->d_flags |= DCACHE_SHRINK_LIST;
1366 data->found++;
1367 ret = D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 }
1369 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001370 * We can return to the caller if we have found some (this
1371 * ensures forward progress). We'll be coming back to find
1372 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001374 if (data->found && need_resched())
1375 ret = D_WALK_QUIT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001377 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378}
1379
1380/**
1381 * shrink_dcache_parent - prune dcache
1382 * @parent: parent of entries to prune
1383 *
1384 * Prune the dcache to remove unused children of the parent dentry.
1385 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001386void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001388 for (;;) {
1389 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001391 INIT_LIST_HEAD(&data.dispose);
1392 data.start = parent;
1393 data.found = 0;
1394
1395 d_walk(parent, &data, select_collect, NULL);
1396 if (!data.found)
1397 break;
1398
1399 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001400 cond_resched();
1401 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001403EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001405static enum d_walk_ret check_and_collect(void *_data, struct dentry *dentry)
1406{
1407 struct select_data *data = _data;
1408
1409 if (d_mountpoint(dentry)) {
1410 data->found = -EBUSY;
1411 return D_WALK_QUIT;
1412 }
1413
1414 return select_collect(_data, dentry);
1415}
1416
1417static void check_and_drop(void *_data)
1418{
1419 struct select_data *data = _data;
1420
1421 if (d_mountpoint(data->start))
1422 data->found = -EBUSY;
1423 if (!data->found)
1424 __d_drop(data->start);
1425}
1426
1427/**
1428 * check_submounts_and_drop - prune dcache, check for submounts and drop
1429 *
1430 * All done as a single atomic operation relative to has_unlinked_ancestor().
1431 * Returns 0 if successfully unhashed @parent. If there were submounts then
1432 * return -EBUSY.
1433 *
1434 * @dentry: dentry to prune and drop
1435 */
1436int check_submounts_and_drop(struct dentry *dentry)
1437{
1438 int ret = 0;
1439
1440 /* Negative dentries can be dropped without further checks */
1441 if (!dentry->d_inode) {
1442 d_drop(dentry);
1443 goto out;
1444 }
1445
1446 for (;;) {
1447 struct select_data data;
1448
1449 INIT_LIST_HEAD(&data.dispose);
1450 data.start = dentry;
1451 data.found = 0;
1452
1453 d_walk(dentry, &data, check_and_collect, check_and_drop);
1454 ret = data.found;
1455
1456 if (!list_empty(&data.dispose))
1457 shrink_dentry_list(&data.dispose);
1458
1459 if (ret <= 0)
1460 break;
1461
1462 cond_resched();
1463 }
1464
1465out:
1466 return ret;
1467}
1468EXPORT_SYMBOL(check_submounts_and_drop);
1469
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470/**
Al Viroa4464db2011-07-07 15:03:58 -04001471 * __d_alloc - allocate a dcache entry
1472 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473 * @name: qstr of the name
1474 *
1475 * Allocates a dentry. It returns %NULL if there is insufficient memory
1476 * available. On a success the dentry is returned. The name passed in is
1477 * copied and the copy passed in may be reused after this call.
1478 */
1479
Al Viroa4464db2011-07-07 15:03:58 -04001480struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481{
1482 struct dentry *dentry;
1483 char *dname;
1484
Mel Gormane12ba742007-10-16 01:25:52 -07001485 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 if (!dentry)
1487 return NULL;
1488
Linus Torvalds6326c712012-05-21 16:14:04 -07001489 /*
1490 * We guarantee that the inline name is always NUL-terminated.
1491 * This way the memcpy() done by the name switching in rename
1492 * will still always have a NUL at the end, even if we might
1493 * be overwriting an internal NUL character
1494 */
1495 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 if (name->len > DNAME_INLINE_LEN-1) {
1497 dname = kmalloc(name->len + 1, GFP_KERNEL);
1498 if (!dname) {
1499 kmem_cache_free(dentry_cache, dentry);
1500 return NULL;
1501 }
1502 } else {
1503 dname = dentry->d_iname;
1504 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505
1506 dentry->d_name.len = name->len;
1507 dentry->d_name.hash = name->hash;
1508 memcpy(dname, name->name, name->len);
1509 dname[name->len] = 0;
1510
Linus Torvalds6326c712012-05-21 16:14:04 -07001511 /* Make sure we always see the terminating NUL character */
1512 smp_wmb();
1513 dentry->d_name.name = dname;
1514
Waiman Long98474232013-08-28 18:24:59 -07001515 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001516 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001518 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001520 dentry->d_parent = dentry;
1521 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 dentry->d_op = NULL;
1523 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001524 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 INIT_LIST_HEAD(&dentry->d_lru);
1526 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Virob3d9b7a2012-06-09 13:51:19 -04001527 INIT_HLIST_NODE(&dentry->d_alias);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001528 INIT_LIST_HEAD(&dentry->d_u.d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001529 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530
Nick Piggin3e880fb2011-01-07 17:49:19 +11001531 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001532
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 return dentry;
1534}
Al Viroa4464db2011-07-07 15:03:58 -04001535
1536/**
1537 * d_alloc - allocate a dcache entry
1538 * @parent: parent of entry to allocate
1539 * @name: qstr of the name
1540 *
1541 * Allocates a dentry. It returns %NULL if there is insufficient memory
1542 * available. On a success the dentry is returned. The name passed in is
1543 * copied and the copy passed in may be reused after this call.
1544 */
1545struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1546{
1547 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1548 if (!dentry)
1549 return NULL;
1550
1551 spin_lock(&parent->d_lock);
1552 /*
1553 * don't need child lock because it is not subject
1554 * to concurrency here
1555 */
1556 __dget_dlock(parent);
1557 dentry->d_parent = parent;
1558 list_add(&dentry->d_u.d_child, &parent->d_subdirs);
1559 spin_unlock(&parent->d_lock);
1560
1561 return dentry;
1562}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001563EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564
Nick Piggin4b936882011-01-07 17:50:07 +11001565struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1566{
Al Viroa4464db2011-07-07 15:03:58 -04001567 struct dentry *dentry = __d_alloc(sb, name);
1568 if (dentry)
Nick Piggin4b936882011-01-07 17:50:07 +11001569 dentry->d_flags |= DCACHE_DISCONNECTED;
Nick Piggin4b936882011-01-07 17:50:07 +11001570 return dentry;
1571}
1572EXPORT_SYMBOL(d_alloc_pseudo);
1573
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1575{
1576 struct qstr q;
1577
1578 q.name = name;
1579 q.len = strlen(name);
1580 q.hash = full_name_hash(q.name, q.len);
1581 return d_alloc(parent, &q);
1582}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001583EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584
Nick Pigginfb045ad2011-01-07 17:49:55 +11001585void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1586{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001587 WARN_ON_ONCE(dentry->d_op);
1588 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001589 DCACHE_OP_COMPARE |
1590 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001591 DCACHE_OP_WEAK_REVALIDATE |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001592 DCACHE_OP_DELETE ));
1593 dentry->d_op = op;
1594 if (!op)
1595 return;
1596 if (op->d_hash)
1597 dentry->d_flags |= DCACHE_OP_HASH;
1598 if (op->d_compare)
1599 dentry->d_flags |= DCACHE_OP_COMPARE;
1600 if (op->d_revalidate)
1601 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001602 if (op->d_weak_revalidate)
1603 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001604 if (op->d_delete)
1605 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001606 if (op->d_prune)
1607 dentry->d_flags |= DCACHE_OP_PRUNE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001608
1609}
1610EXPORT_SYMBOL(d_set_d_op);
1611
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001612static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1613{
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001614 spin_lock(&dentry->d_lock);
David Howells9875cf82011-01-14 18:45:21 +00001615 if (inode) {
1616 if (unlikely(IS_AUTOMOUNT(inode)))
1617 dentry->d_flags |= DCACHE_NEED_AUTOMOUNT;
Al Virob3d9b7a2012-06-09 13:51:19 -04001618 hlist_add_head(&dentry->d_alias, &inode->i_dentry);
David Howells9875cf82011-01-14 18:45:21 +00001619 }
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001620 dentry->d_inode = inode;
Nick Piggin31e6b012011-01-07 17:49:52 +11001621 dentry_rcuwalk_barrier(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001622 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001623 fsnotify_d_instantiate(dentry, inode);
1624}
1625
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626/**
1627 * d_instantiate - fill in inode information for a dentry
1628 * @entry: dentry to complete
1629 * @inode: inode to attach to this dentry
1630 *
1631 * Fill in inode information in the entry.
1632 *
1633 * This turns negative dentries into productive full members
1634 * of society.
1635 *
1636 * NOTE! This assumes that the inode count has been incremented
1637 * (or otherwise set) by the caller to indicate that it is now
1638 * in use by the dcache.
1639 */
1640
1641void d_instantiate(struct dentry *entry, struct inode * inode)
1642{
Al Virob3d9b7a2012-06-09 13:51:19 -04001643 BUG_ON(!hlist_unhashed(&entry->d_alias));
Nick Piggin873feea2011-01-07 17:50:06 +11001644 if (inode)
1645 spin_lock(&inode->i_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001646 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001647 if (inode)
1648 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 security_d_instantiate(entry, inode);
1650}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001651EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652
1653/**
1654 * d_instantiate_unique - instantiate a non-aliased dentry
1655 * @entry: dentry to instantiate
1656 * @inode: inode to attach to this dentry
1657 *
1658 * Fill in inode information in the entry. On success, it returns NULL.
1659 * If an unhashed alias of "entry" already exists, then we return the
Oleg Drokine866cfa2006-01-09 20:52:51 -08001660 * aliased dentry instead and drop one reference to inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 *
1662 * Note that in order to avoid conflicts with rename() etc, the caller
1663 * had better be holding the parent directory semaphore.
Oleg Drokine866cfa2006-01-09 20:52:51 -08001664 *
1665 * This also assumes that the inode count has been incremented
1666 * (or otherwise set) by the caller to indicate that it is now
1667 * in use by the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 */
David Howells770bfad2006-08-22 20:06:07 -04001669static struct dentry *__d_instantiate_unique(struct dentry *entry,
1670 struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671{
1672 struct dentry *alias;
1673 int len = entry->d_name.len;
1674 const char *name = entry->d_name.name;
1675 unsigned int hash = entry->d_name.hash;
1676
David Howells770bfad2006-08-22 20:06:07 -04001677 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001678 __d_instantiate(entry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001679 return NULL;
1680 }
1681
Sasha Levinb67bfe02013-02-27 17:06:00 -08001682 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Piggin9abca362011-01-07 17:49:36 +11001683 /*
1684 * Don't need alias->d_lock here, because aliases with
1685 * d_parent == entry->d_parent are not subject to name or
1686 * parent changes, because the parent inode i_mutex is held.
1687 */
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001688 if (alias->d_name.hash != hash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 continue;
1690 if (alias->d_parent != entry->d_parent)
1691 continue;
Linus Torvaldsee983e82012-05-10 12:37:10 -07001692 if (alias->d_name.len != len)
1693 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001694 if (dentry_cmp(alias, name, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 continue;
Nick Piggindc0474b2011-01-07 17:49:43 +11001696 __dget(alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 return alias;
1698 }
David Howells770bfad2006-08-22 20:06:07 -04001699
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001700 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 return NULL;
1702}
David Howells770bfad2006-08-22 20:06:07 -04001703
1704struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1705{
1706 struct dentry *result;
1707
Al Virob3d9b7a2012-06-09 13:51:19 -04001708 BUG_ON(!hlist_unhashed(&entry->d_alias));
David Howells770bfad2006-08-22 20:06:07 -04001709
Nick Piggin873feea2011-01-07 17:50:06 +11001710 if (inode)
1711 spin_lock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001712 result = __d_instantiate_unique(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001713 if (inode)
1714 spin_unlock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001715
1716 if (!result) {
1717 security_d_instantiate(entry, inode);
1718 return NULL;
1719 }
1720
1721 BUG_ON(!d_unhashed(result));
1722 iput(inode);
1723 return result;
1724}
1725
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726EXPORT_SYMBOL(d_instantiate_unique);
1727
Al Viroadc0e912012-01-08 16:49:21 -05001728struct dentry *d_make_root(struct inode *root_inode)
1729{
1730 struct dentry *res = NULL;
1731
1732 if (root_inode) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07001733 static const struct qstr name = QSTR_INIT("/", 1);
Al Viroadc0e912012-01-08 16:49:21 -05001734
1735 res = __d_alloc(root_inode->i_sb, &name);
1736 if (res)
1737 d_instantiate(res, root_inode);
1738 else
1739 iput(root_inode);
1740 }
1741 return res;
1742}
1743EXPORT_SYMBOL(d_make_root);
1744
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001745static struct dentry * __d_find_any_alias(struct inode *inode)
1746{
1747 struct dentry *alias;
1748
Al Virob3d9b7a2012-06-09 13:51:19 -04001749 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001750 return NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001751 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001752 __dget(alias);
1753 return alias;
1754}
1755
Sage Weil46f72b32012-01-10 09:04:37 -08001756/**
1757 * d_find_any_alias - find any alias for a given inode
1758 * @inode: inode to find an alias for
1759 *
1760 * If any aliases exist for the given inode, take and return a
1761 * reference for one of them. If no aliases exist, return %NULL.
1762 */
1763struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001764{
1765 struct dentry *de;
1766
1767 spin_lock(&inode->i_lock);
1768 de = __d_find_any_alias(inode);
1769 spin_unlock(&inode->i_lock);
1770 return de;
1771}
Sage Weil46f72b32012-01-10 09:04:37 -08001772EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001773
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774/**
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001775 * d_obtain_alias - find or allocate a dentry for a given inode
1776 * @inode: inode to allocate the dentry for
1777 *
1778 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1779 * similar open by handle operations. The returned dentry may be anonymous,
1780 * or may have a full name (if the inode was already in the cache).
1781 *
1782 * When called on a directory inode, we must ensure that the inode only ever
1783 * has one dentry. If a dentry is found, that is returned instead of
1784 * allocating a new one.
1785 *
1786 * On successful return, the reference to the inode has been transferred
Christoph Hellwig44003722008-08-11 15:49:04 +02001787 * to the dentry. In case of an error the reference on the inode is released.
1788 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1789 * be passed in and will be the error will be propagate to the return value,
1790 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001791 */
1792struct dentry *d_obtain_alias(struct inode *inode)
1793{
NeilBrownb911a6b2012-11-08 16:09:37 -08001794 static const struct qstr anonstring = QSTR_INIT("/", 1);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001795 struct dentry *tmp;
1796 struct dentry *res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001797
1798 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001799 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001800 if (IS_ERR(inode))
1801 return ERR_CAST(inode);
1802
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001803 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001804 if (res)
1805 goto out_iput;
1806
Al Viroa4464db2011-07-07 15:03:58 -04001807 tmp = __d_alloc(inode->i_sb, &anonstring);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001808 if (!tmp) {
1809 res = ERR_PTR(-ENOMEM);
1810 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001811 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001812
Nick Piggin873feea2011-01-07 17:50:06 +11001813 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001814 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001815 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001816 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001817 dput(tmp);
1818 goto out_iput;
1819 }
1820
1821 /* attach a disconnected dentry */
1822 spin_lock(&tmp->d_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001823 tmp->d_inode = inode;
1824 tmp->d_flags |= DCACHE_DISCONNECTED;
Al Virob3d9b7a2012-06-09 13:51:19 -04001825 hlist_add_head(&tmp->d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001826 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001827 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001828 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001829 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001830 spin_unlock(&inode->i_lock);
Josef Bacik24ff6662010-11-18 20:52:55 -05001831 security_d_instantiate(tmp, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001832
Christoph Hellwig9308a612008-08-11 15:49:12 +02001833 return tmp;
1834
1835 out_iput:
Josef Bacik24ff6662010-11-18 20:52:55 -05001836 if (res && !IS_ERR(res))
1837 security_d_instantiate(res, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001838 iput(inode);
1839 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001840}
Benny Halevyadc48722009-02-27 14:02:59 -08001841EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842
1843/**
1844 * d_splice_alias - splice a disconnected dentry into the tree if one exists
1845 * @inode: the inode which may have a disconnected dentry
1846 * @dentry: a negative dentry which we want to point to the inode.
1847 *
1848 * If inode is a directory and has a 'disconnected' dentry (i.e. IS_ROOT and
1849 * DCACHE_DISCONNECTED), then d_move that in place of the given dentry
1850 * and return it, else simply d_add the inode to the dentry and return NULL.
1851 *
1852 * This is needed in the lookup routine of any filesystem that is exportable
1853 * (via knfsd) so that we can build dcache paths to directories effectively.
1854 *
1855 * If a dentry was found and moved, then it is returned. Otherwise NULL
1856 * is returned. This matches the expected return value of ->lookup.
1857 *
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001858 * Cluster filesystems may call this function with a negative, hashed dentry.
1859 * In that case, we know that the inode will be a regular file, and also this
1860 * will only occur during atomic_open. So we need to check for the dentry
1861 * being already hashed only in the final case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 */
1863struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
1864{
1865 struct dentry *new = NULL;
1866
Al Viroa9049372011-07-08 21:20:11 -04001867 if (IS_ERR(inode))
1868 return ERR_CAST(inode);
1869
NeilBrown21c0d8f2006-10-04 02:16:16 -07001870 if (inode && S_ISDIR(inode->i_mode)) {
Nick Piggin873feea2011-01-07 17:50:06 +11001871 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001872 new = __d_find_alias(inode, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873 if (new) {
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001874 BUG_ON(!(new->d_flags & DCACHE_DISCONNECTED));
Nick Piggin873feea2011-01-07 17:50:06 +11001875 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 security_d_instantiate(new, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 d_move(new, dentry);
1878 iput(inode);
1879 } else {
Nick Piggin873feea2011-01-07 17:50:06 +11001880 /* already taking inode->i_lock, so d_add() by hand */
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001881 __d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001882 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 security_d_instantiate(dentry, inode);
1884 d_rehash(dentry);
1885 }
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001886 } else {
1887 d_instantiate(dentry, inode);
1888 if (d_unhashed(dentry))
1889 d_rehash(dentry);
1890 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891 return new;
1892}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001893EXPORT_SYMBOL(d_splice_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894
Barry Naujok94035402008-05-21 16:50:46 +10001895/**
1896 * d_add_ci - lookup or allocate new dentry with case-exact name
1897 * @inode: the inode case-insensitive lookup has found
1898 * @dentry: the negative dentry that was passed to the parent's lookup func
1899 * @name: the case-exact name to be associated with the returned dentry
1900 *
1901 * This is to avoid filling the dcache with case-insensitive names to the
1902 * same inode, only the actual correct case is stored in the dcache for
1903 * case-insensitive filesystems.
1904 *
1905 * For a case-insensitive lookup match and if the the case-exact dentry
1906 * already exists in in the dcache, use it and return it.
1907 *
1908 * If no entry exists with the exact case name, allocate new dentry with
1909 * the exact case, and return the spliced entry.
1910 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001911struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001912 struct qstr *name)
1913{
Barry Naujok94035402008-05-21 16:50:46 +10001914 struct dentry *found;
1915 struct dentry *new;
1916
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001917 /*
1918 * First check if a dentry matching the name already exists,
1919 * if not go ahead and create it now.
1920 */
Barry Naujok94035402008-05-21 16:50:46 +10001921 found = d_hash_and_lookup(dentry->d_parent, name);
Al Viro4f522a22013-02-11 23:20:37 -05001922 if (unlikely(IS_ERR(found)))
1923 goto err_out;
Barry Naujok94035402008-05-21 16:50:46 +10001924 if (!found) {
1925 new = d_alloc(dentry->d_parent, name);
1926 if (!new) {
Al Viro4f522a22013-02-11 23:20:37 -05001927 found = ERR_PTR(-ENOMEM);
Barry Naujok94035402008-05-21 16:50:46 +10001928 goto err_out;
1929 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001930
Barry Naujok94035402008-05-21 16:50:46 +10001931 found = d_splice_alias(inode, new);
1932 if (found) {
1933 dput(new);
1934 return found;
1935 }
1936 return new;
1937 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001938
1939 /*
1940 * If a matching dentry exists, and it's not negative use it.
1941 *
1942 * Decrement the reference count to balance the iget() done
1943 * earlier on.
1944 */
Barry Naujok94035402008-05-21 16:50:46 +10001945 if (found->d_inode) {
1946 if (unlikely(found->d_inode != inode)) {
1947 /* This can't happen because bad inodes are unhashed. */
1948 BUG_ON(!is_bad_inode(inode));
1949 BUG_ON(!is_bad_inode(found->d_inode));
1950 }
Barry Naujok94035402008-05-21 16:50:46 +10001951 iput(inode);
1952 return found;
1953 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001954
Barry Naujok94035402008-05-21 16:50:46 +10001955 /*
1956 * Negative dentry: instantiate it unless the inode is a directory and
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001957 * already has a dentry.
Barry Naujok94035402008-05-21 16:50:46 +10001958 */
Al Viro4513d892011-07-17 10:52:14 -04001959 new = d_splice_alias(inode, found);
1960 if (new) {
1961 dput(found);
1962 found = new;
Barry Naujok94035402008-05-21 16:50:46 +10001963 }
Al Viro4513d892011-07-17 10:52:14 -04001964 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001965
1966err_out:
1967 iput(inode);
Al Viro4f522a22013-02-11 23:20:37 -05001968 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001969}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001970EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001972/*
1973 * Do the slow-case of the dentry name compare.
1974 *
1975 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07001976 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001977 * filesystem can rely on them, and can use the 'name' and
1978 * 'len' information without worrying about walking off the
1979 * end of memory etc.
1980 *
1981 * Thus the read_seqcount_retry() and the "duplicate" info
1982 * in arguments (the low-level filesystem should not look
1983 * at the dentry inode or name contents directly, since
1984 * rename can change them while we're in RCU mode).
1985 */
1986enum slow_d_compare {
1987 D_COMP_OK,
1988 D_COMP_NOMATCH,
1989 D_COMP_SEQRETRY,
1990};
1991
1992static noinline enum slow_d_compare slow_dentry_cmp(
1993 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001994 struct dentry *dentry,
1995 unsigned int seq,
1996 const struct qstr *name)
1997{
1998 int tlen = dentry->d_name.len;
1999 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002000
2001 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2002 cpu_relax();
2003 return D_COMP_SEQRETRY;
2004 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002005 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002006 return D_COMP_NOMATCH;
2007 return D_COMP_OK;
2008}
2009
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002011 * __d_lookup_rcu - search for a dentry (racy, store-free)
2012 * @parent: parent dentry
2013 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002014 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002015 * Returns: dentry, or NULL
2016 *
2017 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2018 * resolution (store-free path walking) design described in
2019 * Documentation/filesystems/path-lookup.txt.
2020 *
2021 * This is not to be used outside core vfs.
2022 *
2023 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2024 * held, and rcu_read_lock held. The returned dentry must not be stored into
2025 * without taking d_lock and checking d_seq sequence count against @seq
2026 * returned here.
2027 *
Linus Torvalds15570082013-09-02 11:38:06 -07002028 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002029 * function.
2030 *
2031 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2032 * the returned dentry, so long as its parent's seqlock is checked after the
2033 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2034 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002035 *
2036 * NOTE! The caller *has* to check the resulting dentry against the sequence
2037 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002038 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002039struct dentry *__d_lookup_rcu(const struct dentry *parent,
2040 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002041 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002042{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002043 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002044 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002045 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002046 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002047 struct dentry *dentry;
2048
2049 /*
2050 * Note: There is significant duplication with __d_lookup_rcu which is
2051 * required to prevent single threaded performance regressions
2052 * especially on architectures where smp_rmb (in seqcounts) are costly.
2053 * Keep the two functions in sync.
2054 */
2055
2056 /*
2057 * The hash list is protected using RCU.
2058 *
2059 * Carefully use d_seq when comparing a candidate dentry, to avoid
2060 * races with d_move().
2061 *
2062 * It is possible that concurrent renames can mess up our list
2063 * walk here and result in missing our dentry, resulting in the
2064 * false-negative result. d_lookup() protects against concurrent
2065 * renames using rename_lock seqlock.
2066 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002067 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002068 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002069 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002070 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002071
Nick Piggin31e6b012011-01-07 17:49:52 +11002072seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002073 /*
2074 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002075 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002076 *
2077 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002078 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002079 *
2080 * NOTE! We do a "raw" seqcount_begin here. That means that
2081 * we don't wait for the sequence count to stabilize if it
2082 * is in the middle of a sequence change. If we do the slow
2083 * dentry compare, we will do seqretries until it is stable,
2084 * and if we end up with a successful lookup, we actually
2085 * want to exit RCU lookup anyway.
2086 */
2087 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002088 if (dentry->d_parent != parent)
2089 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002090 if (d_unhashed(dentry))
2091 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002092
2093 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002094 if (dentry->d_name.hash != hashlen_hash(hashlen))
2095 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002096 *seqp = seq;
2097 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002098 case D_COMP_OK:
2099 return dentry;
2100 case D_COMP_NOMATCH:
2101 continue;
2102 default:
2103 goto seqretry;
2104 }
2105 }
2106
Linus Torvalds26fe5752012-05-10 13:14:12 -07002107 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002108 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002109 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002110 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002111 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002112 }
2113 return NULL;
2114}
2115
2116/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 * d_lookup - search for a dentry
2118 * @parent: parent dentry
2119 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002120 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002122 * d_lookup searches the children of the parent dentry for the name in
2123 * question. If the dentry is found its reference count is incremented and the
2124 * dentry is returned. The caller must use dput to free the entry when it has
2125 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126 */
Al Viroda2d8452013-01-24 18:29:34 -05002127struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128{
Nick Piggin31e6b012011-01-07 17:49:52 +11002129 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002130 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131
2132 do {
2133 seq = read_seqbegin(&rename_lock);
2134 dentry = __d_lookup(parent, name);
2135 if (dentry)
2136 break;
2137 } while (read_seqretry(&rename_lock, seq));
2138 return dentry;
2139}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002140EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141
Nick Piggin31e6b012011-01-07 17:49:52 +11002142/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002143 * __d_lookup - search for a dentry (racy)
2144 * @parent: parent dentry
2145 * @name: qstr of name we wish to find
2146 * Returns: dentry, or NULL
2147 *
2148 * __d_lookup is like d_lookup, however it may (rarely) return a
2149 * false-negative result due to unrelated rename activity.
2150 *
2151 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2152 * however it must be used carefully, eg. with a following d_lookup in
2153 * the case of failure.
2154 *
2155 * __d_lookup callers must be commented.
2156 */
Al Viroa713ca22013-01-24 18:27:00 -05002157struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158{
2159 unsigned int len = name->len;
2160 unsigned int hash = name->hash;
2161 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002162 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002163 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002164 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002165 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166
Nick Pigginb04f7842010-08-18 04:37:34 +10002167 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002168 * Note: There is significant duplication with __d_lookup_rcu which is
2169 * required to prevent single threaded performance regressions
2170 * especially on architectures where smp_rmb (in seqcounts) are costly.
2171 * Keep the two functions in sync.
2172 */
2173
2174 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002175 * The hash list is protected using RCU.
2176 *
2177 * Take d_lock when comparing a candidate dentry, to avoid races
2178 * with d_move().
2179 *
2180 * It is possible that concurrent renames can mess up our list
2181 * walk here and result in missing our dentry, resulting in the
2182 * false-negative result. d_lookup() protects against concurrent
2183 * renames using rename_lock seqlock.
2184 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002185 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002186 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187 rcu_read_lock();
2188
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002189 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 if (dentry->d_name.hash != hash)
2192 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193
2194 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 if (dentry->d_parent != parent)
2196 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002197 if (d_unhashed(dentry))
2198 goto next;
2199
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 /*
2201 * It is safe to compare names since d_move() cannot
2202 * change the qstr (protected by d_lock).
2203 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002204 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002205 int tlen = dentry->d_name.len;
2206 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002207 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 goto next;
2209 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002210 if (dentry->d_name.len != len)
2211 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002212 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213 goto next;
2214 }
2215
Waiman Long98474232013-08-28 18:24:59 -07002216 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002217 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 spin_unlock(&dentry->d_lock);
2219 break;
2220next:
2221 spin_unlock(&dentry->d_lock);
2222 }
2223 rcu_read_unlock();
2224
2225 return found;
2226}
2227
2228/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002229 * d_hash_and_lookup - hash the qstr then search for a dentry
2230 * @dir: Directory to search in
2231 * @name: qstr of name we wish to find
2232 *
Al Viro4f522a22013-02-11 23:20:37 -05002233 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002234 */
2235struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2236{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002237 /*
2238 * Check for a fs-specific hash function. Note that we must
2239 * calculate the standard hash first, as the d_op->d_hash()
2240 * routine may choose to leave the hash value unchanged.
2241 */
2242 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002243 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002244 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002245 if (unlikely(err < 0))
2246 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002247 }
Al Viro4f522a22013-02-11 23:20:37 -05002248 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002249}
Al Viro4f522a22013-02-11 23:20:37 -05002250EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002251
2252/**
Nick Piggin786a5e12011-01-07 17:49:16 +11002253 * d_validate - verify dentry provided from insecure source (deprecated)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 * @dentry: The dentry alleged to be valid child of @dparent
Randy Dunlapff5fdb62011-01-22 20:16:06 -08002255 * @dparent: The parent dentry (known to be valid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 *
2257 * An insecure source has sent us a dentry, here we verify it and dget() it.
2258 * This is used by ncpfs in its readdir implementation.
2259 * Zero is returned in the dentry is invalid.
Nick Piggin786a5e12011-01-07 17:49:16 +11002260 *
2261 * This function is slow for big directories, and deprecated, do not use it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 */
Nick Piggind3a23e12011-01-05 20:01:21 +11002263int d_validate(struct dentry *dentry, struct dentry *dparent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264{
Nick Piggin786a5e12011-01-07 17:49:16 +11002265 struct dentry *child;
Nick Piggind3a23e12011-01-05 20:01:21 +11002266
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002267 spin_lock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002268 list_for_each_entry(child, &dparent->d_subdirs, d_u.d_child) {
2269 if (dentry == child) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002270 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Nick Piggindc0474b2011-01-07 17:49:43 +11002271 __dget_dlock(dentry);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002272 spin_unlock(&dentry->d_lock);
2273 spin_unlock(&dparent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274 return 1;
2275 }
2276 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002277 spin_unlock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002278
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279 return 0;
2280}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002281EXPORT_SYMBOL(d_validate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282
2283/*
2284 * When a file is deleted, we have two options:
2285 * - turn this dentry into a negative dentry
2286 * - unhash this dentry and free it.
2287 *
2288 * Usually, we want to just turn this into
2289 * a negative dentry, but if anybody else is
2290 * currently using the dentry or the inode
2291 * we can't do that and we fall back on removing
2292 * it from the hash queues and waiting for
2293 * it to be deleted later when it has no users
2294 */
2295
2296/**
2297 * d_delete - delete a dentry
2298 * @dentry: The dentry to delete
2299 *
2300 * Turn the dentry into a negative dentry if possible, otherwise
2301 * remove it from the hash queues so it can be deleted later
2302 */
2303
2304void d_delete(struct dentry * dentry)
2305{
Nick Piggin873feea2011-01-07 17:50:06 +11002306 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002307 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308 /*
2309 * Are we the only user?
2310 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002311again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002313 inode = dentry->d_inode;
2314 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002315 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002316 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002317 spin_unlock(&dentry->d_lock);
2318 cpu_relax();
2319 goto again;
2320 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002321 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002322 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002323 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 return;
2325 }
2326
2327 if (!d_unhashed(dentry))
2328 __d_drop(dentry);
2329
2330 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002331
2332 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002334EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002336static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002338 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002339 hlist_bl_lock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -07002340 entry->d_flags |= DCACHE_RCUACCESS;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002341 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002342 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343}
2344
David Howells770bfad2006-08-22 20:06:07 -04002345static void _d_rehash(struct dentry * entry)
2346{
2347 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2348}
2349
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350/**
2351 * d_rehash - add an entry back to the hash
2352 * @entry: dentry to add to the hash
2353 *
2354 * Adds a dentry to the hash according to its name.
2355 */
2356
2357void d_rehash(struct dentry * entry)
2358{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002360 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002363EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002365/**
2366 * dentry_update_name_case - update case insensitive dentry with a new name
2367 * @dentry: dentry to be updated
2368 * @name: new name
2369 *
2370 * Update a case insensitive dentry with new case of name.
2371 *
2372 * dentry must have been returned by d_lookup with name @name. Old and new
2373 * name lengths must match (ie. no d_compare which allows mismatched name
2374 * lengths).
2375 *
2376 * Parent inode i_mutex must be held over d_lookup and into this call (to
2377 * keep renames and concurrent inserts, and readdir(2) away).
2378 */
2379void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2380{
Linus Torvalds7ebfa572011-04-15 07:34:26 -07002381 BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002382 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2383
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002384 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002385 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002386 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002387 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002388 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002389}
2390EXPORT_SYMBOL(dentry_update_name_case);
2391
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392static void switch_names(struct dentry *dentry, struct dentry *target)
2393{
2394 if (dname_external(target)) {
2395 if (dname_external(dentry)) {
2396 /*
2397 * Both external: swap the pointers
2398 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002399 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400 } else {
2401 /*
2402 * dentry:internal, target:external. Steal target's
2403 * storage and make target internal.
2404 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002405 memcpy(target->d_iname, dentry->d_name.name,
2406 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407 dentry->d_name.name = target->d_name.name;
2408 target->d_name.name = target->d_iname;
2409 }
2410 } else {
2411 if (dname_external(dentry)) {
2412 /*
2413 * dentry:external, target:internal. Give dentry's
2414 * storage to target and make dentry internal
2415 */
2416 memcpy(dentry->d_iname, target->d_name.name,
2417 target->d_name.len + 1);
2418 target->d_name.name = dentry->d_name.name;
2419 dentry->d_name.name = dentry->d_iname;
2420 } else {
2421 /*
2422 * Both are internal. Just copy target to dentry
2423 */
2424 memcpy(dentry->d_iname, target->d_name.name,
2425 target->d_name.len + 1);
Al Virodc711ca2008-11-03 15:03:50 -05002426 dentry->d_name.len = target->d_name.len;
2427 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428 }
2429 }
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002430 swap(dentry->d_name.len, target->d_name.len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431}
2432
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002433static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2434{
2435 /*
2436 * XXXX: do we really need to take target->d_lock?
2437 */
2438 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2439 spin_lock(&target->d_parent->d_lock);
2440 else {
2441 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2442 spin_lock(&dentry->d_parent->d_lock);
2443 spin_lock_nested(&target->d_parent->d_lock,
2444 DENTRY_D_LOCK_NESTED);
2445 } else {
2446 spin_lock(&target->d_parent->d_lock);
2447 spin_lock_nested(&dentry->d_parent->d_lock,
2448 DENTRY_D_LOCK_NESTED);
2449 }
2450 }
2451 if (target < dentry) {
2452 spin_lock_nested(&target->d_lock, 2);
2453 spin_lock_nested(&dentry->d_lock, 3);
2454 } else {
2455 spin_lock_nested(&dentry->d_lock, 2);
2456 spin_lock_nested(&target->d_lock, 3);
2457 }
2458}
2459
2460static void dentry_unlock_parents_for_move(struct dentry *dentry,
2461 struct dentry *target)
2462{
2463 if (target->d_parent != dentry->d_parent)
2464 spin_unlock(&dentry->d_parent->d_lock);
2465 if (target->d_parent != target)
2466 spin_unlock(&target->d_parent->d_lock);
2467}
2468
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002470 * When switching names, the actual string doesn't strictly have to
2471 * be preserved in the target - because we're dropping the target
2472 * anyway. As such, we can just do a simple memcpy() to copy over
2473 * the new name before we switch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474 *
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002475 * Note that we have to be a lot more careful about getting the hash
2476 * switched - we have to switch the hash value properly even if it
2477 * then no longer matches the actual (corrupted) string of the target.
2478 * The hash value has to match the hash queue that the dentry is on..
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002480/*
Al Viro18367502011-07-12 21:42:24 -04002481 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482 * @dentry: entry to move
2483 * @target: new dentry
2484 *
2485 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002486 * dcache entries should not be moved in this way. Caller must hold
2487 * rename_lock, the i_mutex of the source and target directories,
2488 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489 */
Al Viro18367502011-07-12 21:42:24 -04002490static void __d_move(struct dentry * dentry, struct dentry * target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492 if (!dentry->d_inode)
2493 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2494
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002495 BUG_ON(d_ancestor(dentry, target));
2496 BUG_ON(d_ancestor(target, dentry));
2497
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002498 dentry_lock_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002499
Nick Piggin31e6b012011-01-07 17:49:52 +11002500 write_seqcount_begin(&dentry->d_seq);
2501 write_seqcount_begin(&target->d_seq);
2502
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002503 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2504
2505 /*
2506 * Move the dentry to the target hash queue. Don't bother checking
2507 * for the same hash queue because of how unlikely it is.
2508 */
2509 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002510 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002511
2512 /* Unhash the target: dput() will then get rid of it */
2513 __d_drop(target);
2514
Eric Dumazet5160ee62006-01-08 01:03:32 -08002515 list_del(&dentry->d_u.d_child);
2516 list_del(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517
2518 /* Switch the names.. */
2519 switch_names(dentry, target);
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002520 swap(dentry->d_name.hash, target->d_name.hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521
2522 /* ... and switch the parents */
2523 if (IS_ROOT(dentry)) {
2524 dentry->d_parent = target->d_parent;
2525 target->d_parent = target;
Eric Dumazet5160ee62006-01-08 01:03:32 -08002526 INIT_LIST_HEAD(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002527 } else {
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002528 swap(dentry->d_parent, target->d_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002529
2530 /* And add them back to the (new) parent lists */
Eric Dumazet5160ee62006-01-08 01:03:32 -08002531 list_add(&target->d_u.d_child, &target->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532 }
2533
Eric Dumazet5160ee62006-01-08 01:03:32 -08002534 list_add(&dentry->d_u.d_child, &dentry->d_parent->d_subdirs);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002535
Nick Piggin31e6b012011-01-07 17:49:52 +11002536 write_seqcount_end(&target->d_seq);
2537 write_seqcount_end(&dentry->d_seq);
2538
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002539 dentry_unlock_parents_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002540 spin_unlock(&target->d_lock);
Nick Pigginc32ccd82006-03-25 03:07:09 -08002541 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002542 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002543}
2544
2545/*
2546 * d_move - move a dentry
2547 * @dentry: entry to move
2548 * @target: new dentry
2549 *
2550 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002551 * dcache entries should not be moved in this way. See the locking
2552 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002553 */
2554void d_move(struct dentry *dentry, struct dentry *target)
2555{
2556 write_seqlock(&rename_lock);
2557 __d_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002559}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002560EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002561
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002562/**
2563 * d_ancestor - search for an ancestor
2564 * @p1: ancestor dentry
2565 * @p2: child dentry
2566 *
2567 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2568 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002569 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002570struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002571{
2572 struct dentry *p;
2573
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002574 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002575 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002576 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002577 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002578 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002579}
2580
2581/*
2582 * This helper attempts to cope with remotely renamed directories
2583 *
2584 * It assumes that the caller is already holding
Al Viro18367502011-07-12 21:42:24 -04002585 * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002586 *
2587 * Note: If ever the locking in lock_rename() changes, then please
2588 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002589 */
Nick Piggin873feea2011-01-07 17:50:06 +11002590static struct dentry *__d_unalias(struct inode *inode,
2591 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002592{
2593 struct mutex *m1 = NULL, *m2 = NULL;
Al Viroee3efa92012-06-08 15:59:33 -04002594 struct dentry *ret = ERR_PTR(-EBUSY);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002595
2596 /* If alias and dentry share a parent, then no extra locks required */
2597 if (alias->d_parent == dentry->d_parent)
2598 goto out_unalias;
2599
Trond Myklebust9eaef272006-10-21 10:24:20 -07002600 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002601 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2602 goto out_err;
2603 m1 = &dentry->d_sb->s_vfs_rename_mutex;
2604 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
2605 goto out_err;
2606 m2 = &alias->d_parent->d_inode->i_mutex;
2607out_unalias:
Al Viroee3efa92012-06-08 15:59:33 -04002608 if (likely(!d_mountpoint(alias))) {
2609 __d_move(alias, dentry);
2610 ret = alias;
2611 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002612out_err:
Nick Piggin873feea2011-01-07 17:50:06 +11002613 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002614 if (m2)
2615 mutex_unlock(m2);
2616 if (m1)
2617 mutex_unlock(m1);
2618 return ret;
2619}
2620
2621/*
David Howells770bfad2006-08-22 20:06:07 -04002622 * Prepare an anonymous dentry for life in the superblock's dentry tree as a
2623 * named dentry in place of the dentry to be replaced.
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002624 * returns with anon->d_lock held!
David Howells770bfad2006-08-22 20:06:07 -04002625 */
2626static void __d_materialise_dentry(struct dentry *dentry, struct dentry *anon)
2627{
Al Viro740da422013-01-30 10:13:38 -05002628 struct dentry *dparent;
David Howells770bfad2006-08-22 20:06:07 -04002629
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002630 dentry_lock_for_move(anon, dentry);
David Howells770bfad2006-08-22 20:06:07 -04002631
Nick Piggin31e6b012011-01-07 17:49:52 +11002632 write_seqcount_begin(&dentry->d_seq);
2633 write_seqcount_begin(&anon->d_seq);
2634
David Howells770bfad2006-08-22 20:06:07 -04002635 dparent = dentry->d_parent;
David Howells770bfad2006-08-22 20:06:07 -04002636
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002637 switch_names(dentry, anon);
2638 swap(dentry->d_name.hash, anon->d_name.hash);
2639
Al Viro740da422013-01-30 10:13:38 -05002640 dentry->d_parent = dentry;
2641 list_del_init(&dentry->d_u.d_child);
2642 anon->d_parent = dparent;
Wei Yongjun9ed53b12013-03-12 00:10:50 +08002643 list_move(&anon->d_u.d_child, &dparent->d_subdirs);
David Howells770bfad2006-08-22 20:06:07 -04002644
Nick Piggin31e6b012011-01-07 17:49:52 +11002645 write_seqcount_end(&dentry->d_seq);
2646 write_seqcount_end(&anon->d_seq);
2647
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002648 dentry_unlock_parents_for_move(anon, dentry);
2649 spin_unlock(&dentry->d_lock);
2650
2651 /* anon->d_lock still locked, returns locked */
David Howells770bfad2006-08-22 20:06:07 -04002652 anon->d_flags &= ~DCACHE_DISCONNECTED;
2653}
2654
2655/**
2656 * d_materialise_unique - introduce an inode into the tree
2657 * @dentry: candidate dentry
2658 * @inode: inode to bind to the dentry, to which aliases may be attached
2659 *
2660 * Introduces an dentry into the tree, substituting an extant disconnected
Jeff Laytonc46c8872011-07-26 13:33:16 -04002661 * root directory alias in its place if there is one. Caller must hold the
2662 * i_mutex of the parent directory.
David Howells770bfad2006-08-22 20:06:07 -04002663 */
2664struct dentry *d_materialise_unique(struct dentry *dentry, struct inode *inode)
2665{
Trond Myklebust9eaef272006-10-21 10:24:20 -07002666 struct dentry *actual;
David Howells770bfad2006-08-22 20:06:07 -04002667
2668 BUG_ON(!d_unhashed(dentry));
2669
David Howells770bfad2006-08-22 20:06:07 -04002670 if (!inode) {
2671 actual = dentry;
OGAWA Hirofumi360da902008-10-16 07:50:28 +09002672 __d_instantiate(dentry, NULL);
Nick Piggin357f8e62011-01-07 17:49:42 +11002673 d_rehash(actual);
2674 goto out_nolock;
David Howells770bfad2006-08-22 20:06:07 -04002675 }
2676
Nick Piggin873feea2011-01-07 17:50:06 +11002677 spin_lock(&inode->i_lock);
Nick Piggin357f8e62011-01-07 17:49:42 +11002678
Trond Myklebust9eaef272006-10-21 10:24:20 -07002679 if (S_ISDIR(inode->i_mode)) {
2680 struct dentry *alias;
David Howells770bfad2006-08-22 20:06:07 -04002681
Trond Myklebust9eaef272006-10-21 10:24:20 -07002682 /* Does an aliased dentry already exist? */
Linus Torvalds32ba9c32012-06-08 10:34:03 -07002683 alias = __d_find_alias(inode, 0);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002684 if (alias) {
2685 actual = alias;
Al Viro18367502011-07-12 21:42:24 -04002686 write_seqlock(&rename_lock);
2687
2688 if (d_ancestor(alias, dentry)) {
2689 /* Check for loops */
2690 actual = ERR_PTR(-ELOOP);
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002691 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002692 } else if (IS_ROOT(alias)) {
2693 /* Is this an anonymous mountpoint that we
2694 * could splice into our tree? */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002695 __d_materialise_dentry(dentry, alias);
Al Viro18367502011-07-12 21:42:24 -04002696 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002697 __d_drop(alias);
2698 goto found;
Al Viro18367502011-07-12 21:42:24 -04002699 } else {
2700 /* Nope, but we must(!) avoid directory
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002701 * aliasing. This drops inode->i_lock */
Al Viro18367502011-07-12 21:42:24 -04002702 actual = __d_unalias(inode, dentry, alias);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002703 }
Al Viro18367502011-07-12 21:42:24 -04002704 write_sequnlock(&rename_lock);
David Howellsdd179942011-08-16 15:31:30 +01002705 if (IS_ERR(actual)) {
2706 if (PTR_ERR(actual) == -ELOOP)
2707 pr_warn_ratelimited(
2708 "VFS: Lookup of '%s' in %s %s"
2709 " would have caused loop\n",
2710 dentry->d_name.name,
2711 inode->i_sb->s_type->name,
2712 inode->i_sb->s_id);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002713 dput(alias);
David Howellsdd179942011-08-16 15:31:30 +01002714 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002715 goto out_nolock;
2716 }
David Howells770bfad2006-08-22 20:06:07 -04002717 }
2718
2719 /* Add a unique reference */
2720 actual = __d_instantiate_unique(dentry, inode);
2721 if (!actual)
2722 actual = dentry;
Nick Piggin357f8e62011-01-07 17:49:42 +11002723 else
2724 BUG_ON(!d_unhashed(actual));
David Howells770bfad2006-08-22 20:06:07 -04002725
David Howells770bfad2006-08-22 20:06:07 -04002726 spin_lock(&actual->d_lock);
2727found:
2728 _d_rehash(actual);
2729 spin_unlock(&actual->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002730 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002731out_nolock:
David Howells770bfad2006-08-22 20:06:07 -04002732 if (actual == dentry) {
2733 security_d_instantiate(dentry, inode);
2734 return NULL;
2735 }
2736
2737 iput(inode);
2738 return actual;
David Howells770bfad2006-08-22 20:06:07 -04002739}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002740EXPORT_SYMBOL_GPL(d_materialise_unique);
David Howells770bfad2006-08-22 20:06:07 -04002741
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002742static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002743{
2744 *buflen -= namelen;
2745 if (*buflen < 0)
2746 return -ENAMETOOLONG;
2747 *buffer -= namelen;
2748 memcpy(*buffer, str, namelen);
2749 return 0;
2750}
2751
Waiman Long232d2d62013-09-09 12:18:13 -04002752/**
2753 * prepend_name - prepend a pathname in front of current buffer pointer
2754 * buffer: buffer pointer
2755 * buflen: allocated length of the buffer
2756 * name: name string and length qstr structure
2757 *
2758 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
2759 * make sure that either the old or the new name pointer and length are
2760 * fetched. However, there may be mismatch between length and pointer.
2761 * The length cannot be trusted, we need to copy it byte-by-byte until
2762 * the length is reached or a null byte is found. It also prepends "/" at
2763 * the beginning of the name. The sequence number check at the caller will
2764 * retry it again when a d_move() does happen. So any garbage in the buffer
2765 * due to mismatched pointer and length will be discarded.
2766 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002767static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2768{
Waiman Long232d2d62013-09-09 12:18:13 -04002769 const char *dname = ACCESS_ONCE(name->name);
2770 u32 dlen = ACCESS_ONCE(name->len);
2771 char *p;
2772
2773 if (*buflen < dlen + 1)
2774 return -ENAMETOOLONG;
2775 *buflen -= dlen + 1;
2776 p = *buffer -= dlen + 1;
2777 *p++ = '/';
2778 while (dlen--) {
2779 char c = *dname++;
2780 if (!c)
2781 break;
2782 *p++ = c;
2783 }
2784 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002785}
2786
Linus Torvalds1da177e2005-04-16 15:20:36 -07002787/**
Randy Dunlap208898c2010-11-18 15:02:49 -08002788 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002789 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002790 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002791 * @buffer: pointer to the end of the buffer
2792 * @buflen: pointer to buffer length
2793 *
Waiman Long232d2d62013-09-09 12:18:13 -04002794 * The function tries to write out the pathname without taking any lock other
2795 * than the RCU read lock to make sure that dentries won't go away. It only
2796 * checks the sequence number of the global rename_lock as any change in the
2797 * dentry's d_seq will be preceded by changes in the rename_lock sequence
2798 * number. If the sequence number had been change, it will restart the whole
2799 * pathname back-tracing sequence again. It performs a total of 3 trials of
2800 * lockless back-tracing sequences before falling back to take the
2801 * rename_lock.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002802 */
Al Viro02125a82011-12-05 08:43:34 -05002803static int prepend_path(const struct path *path,
2804 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002805 char **buffer, int *buflen)
2806{
2807 struct dentry *dentry = path->dentry;
2808 struct vfsmount *vfsmnt = path->mnt;
Al Viro0714a532011-11-24 22:19:58 -05002809 struct mount *mnt = real_mount(vfsmnt);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002810 int error = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04002811 unsigned seq = 0;
2812 char *bptr;
2813 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002814
Al Viro48f5ec22013-09-09 15:22:25 -04002815 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002816restart:
2817 bptr = *buffer;
2818 blen = *buflen;
2819 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002820 while (dentry != root->dentry || vfsmnt != root->mnt) {
2821 struct dentry * parent;
2822
2823 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
2824 /* Global root? */
Waiman Long232d2d62013-09-09 12:18:13 -04002825 if (mnt_has_parent(mnt)) {
2826 dentry = mnt->mnt_mountpoint;
2827 mnt = mnt->mnt_parent;
2828 vfsmnt = &mnt->mnt;
2829 continue;
2830 }
2831 /*
2832 * Filesystems needing to implement special "root names"
2833 * should do so with ->d_dname()
2834 */
2835 if (IS_ROOT(dentry) &&
2836 (dentry->d_name.len != 1 ||
2837 dentry->d_name.name[0] != '/')) {
2838 WARN(1, "Root dentry has weird name <%.*s>\n",
2839 (int) dentry->d_name.len,
2840 dentry->d_name.name);
2841 }
2842 if (!error)
2843 error = is_mounted(vfsmnt) ? 1 : 2;
2844 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002845 }
2846 parent = dentry->d_parent;
2847 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002848 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002849 if (error)
2850 break;
2851
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002852 dentry = parent;
2853 }
Al Viro48f5ec22013-09-09 15:22:25 -04002854 if (!(seq & 1))
2855 rcu_read_unlock();
2856 if (need_seqretry(&rename_lock, seq)) {
2857 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04002858 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002859 }
Al Viro48f5ec22013-09-09 15:22:25 -04002860 done_seqretry(&rename_lock, seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002861
Waiman Long232d2d62013-09-09 12:18:13 -04002862 if (error >= 0 && bptr == *buffer) {
2863 if (--blen < 0)
2864 error = -ENAMETOOLONG;
2865 else
2866 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002867 }
Waiman Long232d2d62013-09-09 12:18:13 -04002868 *buffer = bptr;
2869 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04002870 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002871}
2872
2873/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002874 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002875 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002876 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07002877 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07002878 * @buflen: buffer length
2879 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002880 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002881 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002882 * Returns a pointer into the buffer or an error code if the
2883 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08002884 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04002885 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002886 *
Al Viro02125a82011-12-05 08:43:34 -05002887 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002888 */
Al Viro02125a82011-12-05 08:43:34 -05002889char *__d_path(const struct path *path,
2890 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002891 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002892{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002893 char *res = buf + buflen;
2894 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002896 prepend(&res, &buflen, "\0", 1);
Al Viro7ea600b2013-03-26 18:25:57 -04002897 br_read_lock(&vfsmount_lock);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002898 error = prepend_path(path, root, &res, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04002899 br_read_unlock(&vfsmount_lock);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002900
Al Viro02125a82011-12-05 08:43:34 -05002901 if (error < 0)
2902 return ERR_PTR(error);
2903 if (error > 0)
2904 return NULL;
2905 return res;
2906}
2907
2908char *d_absolute_path(const struct path *path,
2909 char *buf, int buflen)
2910{
2911 struct path root = {};
2912 char *res = buf + buflen;
2913 int error;
2914
2915 prepend(&res, &buflen, "\0", 1);
Al Viro7ea600b2013-03-26 18:25:57 -04002916 br_read_lock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002917 error = prepend_path(path, &root, &res, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04002918 br_read_unlock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002919
2920 if (error > 1)
2921 error = -EINVAL;
2922 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002923 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002924 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002925}
2926
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002927/*
2928 * same as __d_path but appends "(deleted)" for unlinked files.
2929 */
Al Viro02125a82011-12-05 08:43:34 -05002930static int path_with_deleted(const struct path *path,
2931 const struct path *root,
2932 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002933{
2934 prepend(buf, buflen, "\0", 1);
2935 if (d_unlinked(path->dentry)) {
2936 int error = prepend(buf, buflen, " (deleted)", 10);
2937 if (error)
2938 return error;
2939 }
2940
2941 return prepend_path(path, root, buf, buflen);
2942}
2943
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002944static int prepend_unreachable(char **buffer, int *buflen)
2945{
2946 return prepend(buffer, buflen, "(unreachable)", 13);
2947}
2948
Jan Bluncka03a8a702008-02-14 19:38:32 -08002949/**
2950 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08002951 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08002952 * @buf: buffer to return value in
2953 * @buflen: buffer length
2954 *
2955 * Convert a dentry into an ASCII path name. If the entry has been deleted
2956 * the string " (deleted)" is appended. Note that this is ambiguous.
2957 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002958 * Returns a pointer into the buffer or an error code if the path was
2959 * too long. Note: Callers should use the returned pointer, not the passed
2960 * in buffer, to use the name! The implementation often starts at an offset
2961 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002962 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002963 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002964 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07002965char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002966{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002967 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08002968 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002969 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002970
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002971 /*
2972 * We have various synthetic filesystems that never get mounted. On
2973 * these filesystems dentries are never used for lookup purposes, and
2974 * thus don't need to be hashed. They also don't need a name until a
2975 * user wants to identify the object in /proc/pid/fd/. The little hack
2976 * below allows us to generate a name for these objects on demand:
2977 */
Jan Blunckcf28b482008-02-14 19:38:44 -08002978 if (path->dentry->d_op && path->dentry->d_op->d_dname)
2979 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002980
Miklos Szeredif7ad3c62010-08-10 11:41:36 +02002981 get_fs_root(current->fs, &root);
Al Viro7ea600b2013-03-26 18:25:57 -04002982 br_read_lock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002983 error = path_with_deleted(path, &root, &res, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04002984 br_read_unlock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002985 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002986 res = ERR_PTR(error);
Jan Blunck6ac08c32008-02-14 19:34:38 -08002987 path_put(&root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002988 return res;
2989}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002990EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002991
2992/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002993 * Helper function for dentry_operations.d_dname() members
2994 */
2995char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
2996 const char *fmt, ...)
2997{
2998 va_list args;
2999 char temp[64];
3000 int sz;
3001
3002 va_start(args, fmt);
3003 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3004 va_end(args);
3005
3006 if (sz > sizeof(temp) || sz > buflen)
3007 return ERR_PTR(-ENAMETOOLONG);
3008
3009 buffer += buflen - sz;
3010 return memcpy(buffer, temp, sz);
3011}
3012
Al Viro118b2302013-08-24 12:08:17 -04003013char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3014{
3015 char *end = buffer + buflen;
3016 /* these dentries are never renamed, so d_lock is not needed */
3017 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003018 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003019 prepend(&end, &buflen, "/", 1))
3020 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003021 return end;
Al Viro118b2302013-08-24 12:08:17 -04003022}
3023
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003024/*
Ram Pai6092d042008-03-27 13:06:20 +01003025 * Write full pathname from the root of the filesystem into the buffer.
3026 */
Nick Pigginec2447c2011-01-07 17:49:29 +11003027static char *__dentry_path(struct dentry *dentry, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003028{
Waiman Long232d2d62013-09-09 12:18:13 -04003029 char *end, *retval;
3030 int len, seq = 0;
3031 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003032
Al Viro48f5ec22013-09-09 15:22:25 -04003033 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003034restart:
3035 end = buf + buflen;
3036 len = buflen;
3037 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003038 if (buflen < 1)
3039 goto Elong;
3040 /* Get '/' right */
3041 retval = end-1;
3042 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003043 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003044 while (!IS_ROOT(dentry)) {
3045 struct dentry *parent = dentry->d_parent;
Nick Piggin9abca362011-01-07 17:49:36 +11003046 int error;
Ram Pai6092d042008-03-27 13:06:20 +01003047
Ram Pai6092d042008-03-27 13:06:20 +01003048 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003049 error = prepend_name(&end, &len, &dentry->d_name);
3050 if (error)
3051 break;
Ram Pai6092d042008-03-27 13:06:20 +01003052
3053 retval = end;
3054 dentry = parent;
3055 }
Al Viro48f5ec22013-09-09 15:22:25 -04003056 if (!(seq & 1))
3057 rcu_read_unlock();
3058 if (need_seqretry(&rename_lock, seq)) {
3059 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003060 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003061 }
3062 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003063 if (error)
3064 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003065 return retval;
3066Elong:
3067 return ERR_PTR(-ENAMETOOLONG);
3068}
Nick Pigginec2447c2011-01-07 17:49:29 +11003069
3070char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3071{
Waiman Long232d2d62013-09-09 12:18:13 -04003072 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003073}
3074EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003075
3076char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3077{
3078 char *p = NULL;
3079 char *retval;
3080
Al Viroc1031352010-06-06 22:31:14 -04003081 if (d_unlinked(dentry)) {
3082 p = buf + buflen;
3083 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3084 goto Elong;
3085 buflen++;
3086 }
3087 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003088 if (!IS_ERR(retval) && p)
3089 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003090 return retval;
3091Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003092 return ERR_PTR(-ENAMETOOLONG);
3093}
3094
3095/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003096 * NOTE! The user-level library version returns a
3097 * character pointer. The kernel system call just
3098 * returns the length of the buffer filled (which
3099 * includes the ending '\0' character), or a negative
3100 * error value. So libc would do something like
3101 *
3102 * char *getcwd(char * buf, size_t size)
3103 * {
3104 * int retval;
3105 *
3106 * retval = sys_getcwd(buf, size);
3107 * if (retval >= 0)
3108 * return buf;
3109 * errno = -retval;
3110 * return NULL;
3111 * }
3112 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003113SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003114{
Linus Torvalds552ce542007-02-13 12:08:18 -08003115 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003116 struct path pwd, root;
Linus Torvalds552ce542007-02-13 12:08:18 -08003117 char *page = (char *) __get_free_page(GFP_USER);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003118
3119 if (!page)
3120 return -ENOMEM;
3121
Miklos Szeredif7ad3c62010-08-10 11:41:36 +02003122 get_fs_root_and_pwd(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003123
Linus Torvalds552ce542007-02-13 12:08:18 -08003124 error = -ENOENT;
Al Viro7ea600b2013-03-26 18:25:57 -04003125 br_read_lock(&vfsmount_lock);
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003126 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003127 unsigned long len;
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003128 char *cwd = page + PAGE_SIZE;
3129 int buflen = PAGE_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003130
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003131 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003132 error = prepend_path(&pwd, &root, &cwd, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04003133 br_read_unlock(&vfsmount_lock);
Linus Torvalds552ce542007-02-13 12:08:18 -08003134
Al Viro02125a82011-12-05 08:43:34 -05003135 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003136 goto out;
3137
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003138 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003139 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003140 error = prepend_unreachable(&cwd, &buflen);
3141 if (error)
3142 goto out;
3143 }
3144
Linus Torvalds552ce542007-02-13 12:08:18 -08003145 error = -ERANGE;
3146 len = PAGE_SIZE + page - cwd;
3147 if (len <= size) {
3148 error = len;
3149 if (copy_to_user(buf, cwd, len))
3150 error = -EFAULT;
3151 }
Nick Piggin949854d2011-01-07 17:49:37 +11003152 } else {
Al Viro7ea600b2013-03-26 18:25:57 -04003153 br_read_unlock(&vfsmount_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003154 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003155
3156out:
Jan Blunck6ac08c32008-02-14 19:34:38 -08003157 path_put(&pwd);
3158 path_put(&root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003159 free_page((unsigned long) page);
3160 return error;
3161}
3162
3163/*
3164 * Test whether new_dentry is a subdirectory of old_dentry.
3165 *
3166 * Trivially implemented using the dcache structure
3167 */
3168
3169/**
3170 * is_subdir - is new dentry a subdirectory of old_dentry
3171 * @new_dentry: new dentry
3172 * @old_dentry: old dentry
3173 *
3174 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
3175 * Returns 0 otherwise.
3176 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3177 */
3178
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003179int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003180{
3181 int result;
Nick Piggin949854d2011-01-07 17:49:37 +11003182 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003183
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003184 if (new_dentry == old_dentry)
3185 return 1;
3186
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003187 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003188 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003189 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003190 /*
3191 * Need rcu_readlock to protect against the d_parent trashing
3192 * due to d_move
3193 */
3194 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003195 if (d_ancestor(old_dentry, new_dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003196 result = 1;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003197 else
3198 result = 0;
Nick Piggin949854d2011-01-07 17:49:37 +11003199 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003200 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003201
3202 return result;
3203}
3204
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003205static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003206{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003207 struct dentry *root = data;
3208 if (dentry != root) {
3209 if (d_unhashed(dentry) || !dentry->d_inode)
3210 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003211
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003212 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3213 dentry->d_flags |= DCACHE_GENOCIDE;
3214 dentry->d_lockref.count--;
3215 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003216 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003217 return D_WALK_CONTINUE;
3218}
Nick Piggin58db63d2011-01-07 17:49:39 +11003219
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003220void d_genocide(struct dentry *parent)
3221{
3222 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003223}
3224
Al Viro60545d02013-06-07 01:20:27 -04003225void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003226{
Al Viro60545d02013-06-07 01:20:27 -04003227 inode_dec_link_count(inode);
3228 BUG_ON(dentry->d_name.name != dentry->d_iname ||
3229 !hlist_unhashed(&dentry->d_alias) ||
3230 !d_unlinked(dentry));
3231 spin_lock(&dentry->d_parent->d_lock);
3232 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3233 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3234 (unsigned long long)inode->i_ino);
3235 spin_unlock(&dentry->d_lock);
3236 spin_unlock(&dentry->d_parent->d_lock);
3237 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003238}
Al Viro60545d02013-06-07 01:20:27 -04003239EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003240
3241static __initdata unsigned long dhash_entries;
3242static int __init set_dhash_entries(char *str)
3243{
3244 if (!str)
3245 return 0;
3246 dhash_entries = simple_strtoul(str, &str, 0);
3247 return 1;
3248}
3249__setup("dhash_entries=", set_dhash_entries);
3250
3251static void __init dcache_init_early(void)
3252{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003253 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003254
3255 /* If hashes are distributed across NUMA nodes, defer
3256 * hash allocation until vmalloc space is available.
3257 */
3258 if (hashdist)
3259 return;
3260
3261 dentry_hashtable =
3262 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003263 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003264 dhash_entries,
3265 13,
3266 HASH_EARLY,
3267 &d_hash_shift,
3268 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003269 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003270 0);
3271
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003272 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003273 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003274}
3275
Denis Cheng74bf17c2007-10-16 23:26:30 -07003276static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003277{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003278 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003279
3280 /*
3281 * A constructor could be added for stable state like the lists,
3282 * but it is probably not worth it because of the cache nature
3283 * of the dcache.
3284 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003285 dentry_cache = KMEM_CACHE(dentry,
3286 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003287
3288 /* Hash may have been set up in dcache_init_early */
3289 if (!hashdist)
3290 return;
3291
3292 dentry_hashtable =
3293 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003294 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003295 dhash_entries,
3296 13,
3297 0,
3298 &d_hash_shift,
3299 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003300 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003301 0);
3302
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003303 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003304 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003305}
3306
3307/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003308struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003309EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003310
Linus Torvalds1da177e2005-04-16 15:20:36 -07003311EXPORT_SYMBOL(d_genocide);
3312
Linus Torvalds1da177e2005-04-16 15:20:36 -07003313void __init vfs_caches_init_early(void)
3314{
3315 dcache_init_early();
3316 inode_init_early();
3317}
3318
3319void __init vfs_caches_init(unsigned long mempages)
3320{
3321 unsigned long reserve;
3322
3323 /* Base hash sizes on available memory, with a reserve equal to
3324 150% of current kernel size */
3325
3326 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
3327 mempages -= reserve;
3328
3329 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003330 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003331
Denis Cheng74bf17c2007-10-16 23:26:30 -07003332 dcache_init();
3333 inode_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003334 files_init(mempages);
Denis Cheng74bf17c2007-10-16 23:26:30 -07003335 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003336 bdev_cache_init();
3337 chrdev_init();
3338}