blob: 38a4a03499a28cb2ca6a268f6d0f044a658992c2 [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
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000959/*
960 * Mark all the dentries as on being the dispose list so we don't think they are
961 * still on the LRU if we try to kill them from ascending the parent chain in
962 * try_prune_one_dentry() rather than directly from the dispose list.
963 */
964static void
965shrink_dcache_list(
966 struct list_head *dispose)
967{
968 struct dentry *dentry;
969
970 rcu_read_lock();
971 list_for_each_entry_rcu(dentry, dispose, d_lru) {
972 spin_lock(&dentry->d_lock);
973 dentry->d_flags |= DCACHE_SHRINK_LIST;
974 spin_unlock(&dentry->d_lock);
975 }
976 rcu_read_unlock();
977 shrink_dentry_list(dispose);
978}
979
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700980/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 * shrink_dcache_sb - shrink dcache for a superblock
982 * @sb: superblock
983 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400984 * Shrink the dcache for the specified super block. This is used to free
985 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400987void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988{
Dave Chinnerf6041562013-08-28 10:18:00 +1000989 long disposed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400990
Dave Chinnerf6041562013-08-28 10:18:00 +1000991 disposed = list_lru_dispose_all(&sb->s_dentry_lru, shrink_dcache_list);
992 this_cpu_sub(nr_dentry_unused, disposed);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700994EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995
996/*
David Howellsc636ebd2006-10-11 01:22:19 -0700997 * destroy a single subtree of dentries for unmount
998 * - see the comments on shrink_dcache_for_umount() for a description of the
999 * locking
1000 */
1001static void shrink_dcache_for_umount_subtree(struct dentry *dentry)
1002{
1003 struct dentry *parent;
1004
1005 BUG_ON(!IS_ROOT(dentry));
1006
David Howellsc636ebd2006-10-11 01:22:19 -07001007 for (;;) {
1008 /* descend to the first leaf in the current subtree */
David Howells43c1c9c2011-06-07 14:09:30 +01001009 while (!list_empty(&dentry->d_subdirs))
David Howellsc636ebd2006-10-11 01:22:19 -07001010 dentry = list_entry(dentry->d_subdirs.next,
1011 struct dentry, d_u.d_child);
David Howellsc636ebd2006-10-11 01:22:19 -07001012
1013 /* consume the dentries from this leaf up through its parents
1014 * until we find one with children or run out altogether */
1015 do {
1016 struct inode *inode;
1017
Sage Weilf0023bc2011-10-28 10:02:42 -07001018 /*
Yan, Zheng61572bb2013-04-15 14:13:21 +08001019 * inform the fs that this dentry is about to be
Sage Weilf0023bc2011-10-28 10:02:42 -07001020 * unhashed and destroyed.
1021 */
Yan, Zheng590fb512013-08-13 15:42:02 +08001022 if ((dentry->d_flags & DCACHE_OP_PRUNE) &&
1023 !d_unhashed(dentry))
Yan, Zheng61572bb2013-04-15 14:13:21 +08001024 dentry->d_op->d_prune(dentry);
1025
1026 dentry_lru_del(dentry);
David Howells43c1c9c2011-06-07 14:09:30 +01001027 __d_shrink(dentry);
1028
Waiman Long98474232013-08-28 18:24:59 -07001029 if (dentry->d_lockref.count != 0) {
David Howellsc636ebd2006-10-11 01:22:19 -07001030 printk(KERN_ERR
1031 "BUG: Dentry %p{i=%lx,n=%s}"
1032 " still in use (%d)"
1033 " [unmount of %s %s]\n",
1034 dentry,
1035 dentry->d_inode ?
1036 dentry->d_inode->i_ino : 0UL,
1037 dentry->d_name.name,
Waiman Long98474232013-08-28 18:24:59 -07001038 dentry->d_lockref.count,
David Howellsc636ebd2006-10-11 01:22:19 -07001039 dentry->d_sb->s_type->name,
1040 dentry->d_sb->s_id);
1041 BUG();
1042 }
1043
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001044 if (IS_ROOT(dentry)) {
David Howellsc636ebd2006-10-11 01:22:19 -07001045 parent = NULL;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001046 list_del(&dentry->d_u.d_child);
1047 } else {
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09001048 parent = dentry->d_parent;
Waiman Long98474232013-08-28 18:24:59 -07001049 parent->d_lockref.count--;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001050 list_del(&dentry->d_u.d_child);
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09001051 }
David Howellsc636ebd2006-10-11 01:22:19 -07001052
David Howellsc636ebd2006-10-11 01:22:19 -07001053 inode = dentry->d_inode;
1054 if (inode) {
1055 dentry->d_inode = NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001056 hlist_del_init(&dentry->d_alias);
David Howellsc636ebd2006-10-11 01:22:19 -07001057 if (dentry->d_op && dentry->d_op->d_iput)
1058 dentry->d_op->d_iput(dentry, inode);
1059 else
1060 iput(inode);
1061 }
1062
1063 d_free(dentry);
1064
1065 /* finished when we fall off the top of the tree,
1066 * otherwise we ascend to the parent and move to the
1067 * next sibling if there is one */
1068 if (!parent)
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001069 return;
David Howellsc636ebd2006-10-11 01:22:19 -07001070 dentry = parent;
David Howellsc636ebd2006-10-11 01:22:19 -07001071 } while (list_empty(&dentry->d_subdirs));
1072
1073 dentry = list_entry(dentry->d_subdirs.next,
1074 struct dentry, d_u.d_child);
1075 }
1076}
1077
1078/*
1079 * destroy the dentries attached to a superblock on unmounting
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001080 * - we don't need to use dentry->d_lock because:
David Howellsc636ebd2006-10-11 01:22:19 -07001081 * - the superblock is detached from all mountings and open files, so the
1082 * dentry trees will not be rearranged by the VFS
1083 * - s_umount is write-locked, so the memory pressure shrinker will ignore
1084 * any dentries belonging to this superblock that it comes across
1085 * - the filesystem itself is no longer permitted to rearrange the dentries
1086 * in this superblock
1087 */
1088void shrink_dcache_for_umount(struct super_block *sb)
1089{
1090 struct dentry *dentry;
1091
1092 if (down_read_trylock(&sb->s_umount))
1093 BUG();
1094
1095 dentry = sb->s_root;
1096 sb->s_root = NULL;
Waiman Long98474232013-08-28 18:24:59 -07001097 dentry->d_lockref.count--;
David Howellsc636ebd2006-10-11 01:22:19 -07001098 shrink_dcache_for_umount_subtree(dentry);
1099
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001100 while (!hlist_bl_empty(&sb->s_anon)) {
1101 dentry = hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash);
David Howellsc636ebd2006-10-11 01:22:19 -07001102 shrink_dcache_for_umount_subtree(dentry);
1103 }
1104}
1105
1106/*
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001107 * This tries to ascend one level of parenthood, but
1108 * we can race with renaming, so we need to re-check
1109 * the parenthood after dropping the lock and check
1110 * that the sequence number still matches.
1111 */
Al Viro48f5ec22013-09-09 15:22:25 -04001112static struct dentry *try_to_ascend(struct dentry *old, unsigned seq)
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001113{
1114 struct dentry *new = old->d_parent;
1115
1116 rcu_read_lock();
1117 spin_unlock(&old->d_lock);
1118 spin_lock(&new->d_lock);
1119
1120 /*
1121 * might go back up the wrong parent if we have had a rename
1122 * or deletion
1123 */
1124 if (new != old->d_parent ||
Miklos Szeredib161dfa62012-09-17 22:31:38 +02001125 (old->d_flags & DCACHE_DENTRY_KILLED) ||
Al Viro48f5ec22013-09-09 15:22:25 -04001126 need_seqretry(&rename_lock, seq)) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001127 spin_unlock(&new->d_lock);
1128 new = NULL;
1129 }
1130 rcu_read_unlock();
1131 return new;
1132}
1133
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001135 * enum d_walk_ret - action to talke during tree walk
1136 * @D_WALK_CONTINUE: contrinue walk
1137 * @D_WALK_QUIT: quit walk
1138 * @D_WALK_NORETRY: quit when retry is needed
1139 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001141enum d_walk_ret {
1142 D_WALK_CONTINUE,
1143 D_WALK_QUIT,
1144 D_WALK_NORETRY,
1145 D_WALK_SKIP,
1146};
1147
1148/**
1149 * d_walk - walk the dentry tree
1150 * @parent: start of walk
1151 * @data: data passed to @enter() and @finish()
1152 * @enter: callback when first entering the dentry
1153 * @finish: callback when successfully finished the walk
1154 *
1155 * The @enter() and @finish() callbacks are called with d_lock held.
1156 */
1157static void d_walk(struct dentry *parent, void *data,
1158 enum d_walk_ret (*enter)(void *, struct dentry *),
1159 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160{
Nick Piggin949854d2011-01-07 17:49:37 +11001161 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001163 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001164 enum d_walk_ret ret;
1165 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001166
Nick Piggin58db63d2011-01-07 17:49:39 +11001167again:
Al Viro48f5ec22013-09-09 15:22:25 -04001168 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001169 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001170 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001171
1172 ret = enter(data, this_parent);
1173 switch (ret) {
1174 case D_WALK_CONTINUE:
1175 break;
1176 case D_WALK_QUIT:
1177 case D_WALK_SKIP:
1178 goto out_unlock;
1179 case D_WALK_NORETRY:
1180 retry = false;
1181 break;
1182 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183repeat:
1184 next = this_parent->d_subdirs.next;
1185resume:
1186 while (next != &this_parent->d_subdirs) {
1187 struct list_head *tmp = next;
Eric Dumazet5160ee62006-01-08 01:03:32 -08001188 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001190
1191 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001192
1193 ret = enter(data, dentry);
1194 switch (ret) {
1195 case D_WALK_CONTINUE:
1196 break;
1197 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001198 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001199 goto out_unlock;
1200 case D_WALK_NORETRY:
1201 retry = false;
1202 break;
1203 case D_WALK_SKIP:
1204 spin_unlock(&dentry->d_lock);
1205 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001206 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001207
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001209 spin_unlock(&this_parent->d_lock);
1210 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001212 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 goto repeat;
1214 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001215 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 }
1217 /*
1218 * All done at this level ... ascend and resume the search.
1219 */
1220 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001221 struct dentry *child = this_parent;
Al Viro48f5ec22013-09-09 15:22:25 -04001222 this_parent = try_to_ascend(this_parent, seq);
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001223 if (!this_parent)
Nick Piggin949854d2011-01-07 17:49:37 +11001224 goto rename_retry;
Nick Piggin949854d2011-01-07 17:49:37 +11001225 next = child->d_u.d_child.next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 goto resume;
1227 }
Al Viro48f5ec22013-09-09 15:22:25 -04001228 if (need_seqretry(&rename_lock, seq)) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001229 spin_unlock(&this_parent->d_lock);
1230 goto rename_retry;
1231 }
1232 if (finish)
1233 finish(data);
1234
1235out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001236 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001237 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001238 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001239
1240rename_retry:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001241 if (!retry)
1242 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001243 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001244 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001246
1247/*
1248 * Search for at least 1 mount point in the dentry's subdirs.
1249 * We descend to the next level whenever the d_subdirs
1250 * list is non-empty and continue searching.
1251 */
1252
1253/**
1254 * have_submounts - check for mounts over a dentry
1255 * @parent: dentry to check.
1256 *
1257 * Return true if the parent or its subdirectories contain
1258 * a mount point
1259 */
1260
1261static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1262{
1263 int *ret = data;
1264 if (d_mountpoint(dentry)) {
1265 *ret = 1;
1266 return D_WALK_QUIT;
1267 }
1268 return D_WALK_CONTINUE;
1269}
1270
1271int have_submounts(struct dentry *parent)
1272{
1273 int ret = 0;
1274
1275 d_walk(parent, &ret, check_mount, NULL);
1276
1277 return ret;
1278}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001279EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280
1281/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001282 * Called by mount code to set a mountpoint and check if the mountpoint is
1283 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1284 * subtree can become unreachable).
1285 *
1286 * Only one of check_submounts_and_drop() and d_set_mounted() must succeed. For
1287 * this reason take rename_lock and d_lock on dentry and ancestors.
1288 */
1289int d_set_mounted(struct dentry *dentry)
1290{
1291 struct dentry *p;
1292 int ret = -ENOENT;
1293 write_seqlock(&rename_lock);
1294 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
1295 /* Need exclusion wrt. check_submounts_and_drop() */
1296 spin_lock(&p->d_lock);
1297 if (unlikely(d_unhashed(p))) {
1298 spin_unlock(&p->d_lock);
1299 goto out;
1300 }
1301 spin_unlock(&p->d_lock);
1302 }
1303 spin_lock(&dentry->d_lock);
1304 if (!d_unlinked(dentry)) {
1305 dentry->d_flags |= DCACHE_MOUNTED;
1306 ret = 0;
1307 }
1308 spin_unlock(&dentry->d_lock);
1309out:
1310 write_sequnlock(&rename_lock);
1311 return ret;
1312}
1313
1314/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001315 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 * and move any unused dentries to the end of the unused
1317 * list for prune_dcache(). We descend to the next level
1318 * whenever the d_subdirs list is non-empty and continue
1319 * searching.
1320 *
1321 * It returns zero iff there are no unused children,
1322 * otherwise it returns the number of children moved to
1323 * the end of the unused list. This may not be the total
1324 * number of unused children, because select_parent can
1325 * drop the lock and return early due to latency
1326 * constraints.
1327 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001328
1329struct select_data {
1330 struct dentry *start;
1331 struct list_head dispose;
1332 int found;
1333};
1334
1335static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001337 struct select_data *data = _data;
1338 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001340 if (data->start == dentry)
1341 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001343 /*
1344 * move only zero ref count dentries to the dispose list.
1345 *
1346 * Those which are presently on the shrink list, being processed
1347 * by shrink_dentry_list(), shouldn't be moved. Otherwise the
1348 * loop in shrink_dcache_parent() might not make any progress
1349 * and loop forever.
1350 */
1351 if (dentry->d_lockref.count) {
1352 dentry_lru_del(dentry);
1353 } else if (!(dentry->d_flags & DCACHE_SHRINK_LIST)) {
Dave Chinnerf6041562013-08-28 10:18:00 +10001354 dentry_lru_del(dentry);
1355 list_add_tail(&dentry->d_lru, &data->dispose);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001356 dentry->d_flags |= DCACHE_SHRINK_LIST;
1357 data->found++;
1358 ret = D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 }
1360 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001361 * We can return to the caller if we have found some (this
1362 * ensures forward progress). We'll be coming back to find
1363 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001365 if (data->found && need_resched())
1366 ret = D_WALK_QUIT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001368 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369}
1370
1371/**
1372 * shrink_dcache_parent - prune dcache
1373 * @parent: parent of entries to prune
1374 *
1375 * Prune the dcache to remove unused children of the parent dentry.
1376 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001377void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001379 for (;;) {
1380 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001382 INIT_LIST_HEAD(&data.dispose);
1383 data.start = parent;
1384 data.found = 0;
1385
1386 d_walk(parent, &data, select_collect, NULL);
1387 if (!data.found)
1388 break;
1389
1390 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001391 cond_resched();
1392 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001394EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001396static enum d_walk_ret check_and_collect(void *_data, struct dentry *dentry)
1397{
1398 struct select_data *data = _data;
1399
1400 if (d_mountpoint(dentry)) {
1401 data->found = -EBUSY;
1402 return D_WALK_QUIT;
1403 }
1404
1405 return select_collect(_data, dentry);
1406}
1407
1408static void check_and_drop(void *_data)
1409{
1410 struct select_data *data = _data;
1411
1412 if (d_mountpoint(data->start))
1413 data->found = -EBUSY;
1414 if (!data->found)
1415 __d_drop(data->start);
1416}
1417
1418/**
1419 * check_submounts_and_drop - prune dcache, check for submounts and drop
1420 *
1421 * All done as a single atomic operation relative to has_unlinked_ancestor().
1422 * Returns 0 if successfully unhashed @parent. If there were submounts then
1423 * return -EBUSY.
1424 *
1425 * @dentry: dentry to prune and drop
1426 */
1427int check_submounts_and_drop(struct dentry *dentry)
1428{
1429 int ret = 0;
1430
1431 /* Negative dentries can be dropped without further checks */
1432 if (!dentry->d_inode) {
1433 d_drop(dentry);
1434 goto out;
1435 }
1436
1437 for (;;) {
1438 struct select_data data;
1439
1440 INIT_LIST_HEAD(&data.dispose);
1441 data.start = dentry;
1442 data.found = 0;
1443
1444 d_walk(dentry, &data, check_and_collect, check_and_drop);
1445 ret = data.found;
1446
1447 if (!list_empty(&data.dispose))
1448 shrink_dentry_list(&data.dispose);
1449
1450 if (ret <= 0)
1451 break;
1452
1453 cond_resched();
1454 }
1455
1456out:
1457 return ret;
1458}
1459EXPORT_SYMBOL(check_submounts_and_drop);
1460
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461/**
Al Viroa4464db2011-07-07 15:03:58 -04001462 * __d_alloc - allocate a dcache entry
1463 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 * @name: qstr of the name
1465 *
1466 * Allocates a dentry. It returns %NULL if there is insufficient memory
1467 * available. On a success the dentry is returned. The name passed in is
1468 * copied and the copy passed in may be reused after this call.
1469 */
1470
Al Viroa4464db2011-07-07 15:03:58 -04001471struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472{
1473 struct dentry *dentry;
1474 char *dname;
1475
Mel Gormane12ba742007-10-16 01:25:52 -07001476 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 if (!dentry)
1478 return NULL;
1479
Linus Torvalds6326c712012-05-21 16:14:04 -07001480 /*
1481 * We guarantee that the inline name is always NUL-terminated.
1482 * This way the memcpy() done by the name switching in rename
1483 * will still always have a NUL at the end, even if we might
1484 * be overwriting an internal NUL character
1485 */
1486 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487 if (name->len > DNAME_INLINE_LEN-1) {
1488 dname = kmalloc(name->len + 1, GFP_KERNEL);
1489 if (!dname) {
1490 kmem_cache_free(dentry_cache, dentry);
1491 return NULL;
1492 }
1493 } else {
1494 dname = dentry->d_iname;
1495 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496
1497 dentry->d_name.len = name->len;
1498 dentry->d_name.hash = name->hash;
1499 memcpy(dname, name->name, name->len);
1500 dname[name->len] = 0;
1501
Linus Torvalds6326c712012-05-21 16:14:04 -07001502 /* Make sure we always see the terminating NUL character */
1503 smp_wmb();
1504 dentry->d_name.name = dname;
1505
Waiman Long98474232013-08-28 18:24:59 -07001506 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001507 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001509 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001511 dentry->d_parent = dentry;
1512 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 dentry->d_op = NULL;
1514 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001515 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 INIT_LIST_HEAD(&dentry->d_lru);
1517 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Virob3d9b7a2012-06-09 13:51:19 -04001518 INIT_HLIST_NODE(&dentry->d_alias);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001519 INIT_LIST_HEAD(&dentry->d_u.d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001520 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521
Nick Piggin3e880fb2011-01-07 17:49:19 +11001522 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001523
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 return dentry;
1525}
Al Viroa4464db2011-07-07 15:03:58 -04001526
1527/**
1528 * d_alloc - allocate a dcache entry
1529 * @parent: parent of entry to allocate
1530 * @name: qstr of the name
1531 *
1532 * Allocates a dentry. It returns %NULL if there is insufficient memory
1533 * available. On a success the dentry is returned. The name passed in is
1534 * copied and the copy passed in may be reused after this call.
1535 */
1536struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1537{
1538 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1539 if (!dentry)
1540 return NULL;
1541
1542 spin_lock(&parent->d_lock);
1543 /*
1544 * don't need child lock because it is not subject
1545 * to concurrency here
1546 */
1547 __dget_dlock(parent);
1548 dentry->d_parent = parent;
1549 list_add(&dentry->d_u.d_child, &parent->d_subdirs);
1550 spin_unlock(&parent->d_lock);
1551
1552 return dentry;
1553}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001554EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555
Nick Piggin4b936882011-01-07 17:50:07 +11001556struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1557{
Al Viroa4464db2011-07-07 15:03:58 -04001558 struct dentry *dentry = __d_alloc(sb, name);
1559 if (dentry)
Nick Piggin4b936882011-01-07 17:50:07 +11001560 dentry->d_flags |= DCACHE_DISCONNECTED;
Nick Piggin4b936882011-01-07 17:50:07 +11001561 return dentry;
1562}
1563EXPORT_SYMBOL(d_alloc_pseudo);
1564
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1566{
1567 struct qstr q;
1568
1569 q.name = name;
1570 q.len = strlen(name);
1571 q.hash = full_name_hash(q.name, q.len);
1572 return d_alloc(parent, &q);
1573}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001574EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575
Nick Pigginfb045ad2011-01-07 17:49:55 +11001576void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1577{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001578 WARN_ON_ONCE(dentry->d_op);
1579 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001580 DCACHE_OP_COMPARE |
1581 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001582 DCACHE_OP_WEAK_REVALIDATE |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001583 DCACHE_OP_DELETE ));
1584 dentry->d_op = op;
1585 if (!op)
1586 return;
1587 if (op->d_hash)
1588 dentry->d_flags |= DCACHE_OP_HASH;
1589 if (op->d_compare)
1590 dentry->d_flags |= DCACHE_OP_COMPARE;
1591 if (op->d_revalidate)
1592 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001593 if (op->d_weak_revalidate)
1594 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001595 if (op->d_delete)
1596 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001597 if (op->d_prune)
1598 dentry->d_flags |= DCACHE_OP_PRUNE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001599
1600}
1601EXPORT_SYMBOL(d_set_d_op);
1602
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001603static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1604{
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001605 spin_lock(&dentry->d_lock);
David Howells9875cf82011-01-14 18:45:21 +00001606 if (inode) {
1607 if (unlikely(IS_AUTOMOUNT(inode)))
1608 dentry->d_flags |= DCACHE_NEED_AUTOMOUNT;
Al Virob3d9b7a2012-06-09 13:51:19 -04001609 hlist_add_head(&dentry->d_alias, &inode->i_dentry);
David Howells9875cf82011-01-14 18:45:21 +00001610 }
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001611 dentry->d_inode = inode;
Nick Piggin31e6b012011-01-07 17:49:52 +11001612 dentry_rcuwalk_barrier(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001613 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001614 fsnotify_d_instantiate(dentry, inode);
1615}
1616
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617/**
1618 * d_instantiate - fill in inode information for a dentry
1619 * @entry: dentry to complete
1620 * @inode: inode to attach to this dentry
1621 *
1622 * Fill in inode information in the entry.
1623 *
1624 * This turns negative dentries into productive full members
1625 * of society.
1626 *
1627 * NOTE! This assumes that the inode count has been incremented
1628 * (or otherwise set) by the caller to indicate that it is now
1629 * in use by the dcache.
1630 */
1631
1632void d_instantiate(struct dentry *entry, struct inode * inode)
1633{
Al Virob3d9b7a2012-06-09 13:51:19 -04001634 BUG_ON(!hlist_unhashed(&entry->d_alias));
Nick Piggin873feea2011-01-07 17:50:06 +11001635 if (inode)
1636 spin_lock(&inode->i_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001637 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001638 if (inode)
1639 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 security_d_instantiate(entry, inode);
1641}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001642EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
1644/**
1645 * d_instantiate_unique - instantiate a non-aliased dentry
1646 * @entry: dentry to instantiate
1647 * @inode: inode to attach to this dentry
1648 *
1649 * Fill in inode information in the entry. On success, it returns NULL.
1650 * If an unhashed alias of "entry" already exists, then we return the
Oleg Drokine866cfa2006-01-09 20:52:51 -08001651 * aliased dentry instead and drop one reference to inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652 *
1653 * Note that in order to avoid conflicts with rename() etc, the caller
1654 * had better be holding the parent directory semaphore.
Oleg Drokine866cfa2006-01-09 20:52:51 -08001655 *
1656 * This also assumes that the inode count has been incremented
1657 * (or otherwise set) by the caller to indicate that it is now
1658 * in use by the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659 */
David Howells770bfad2006-08-22 20:06:07 -04001660static struct dentry *__d_instantiate_unique(struct dentry *entry,
1661 struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662{
1663 struct dentry *alias;
1664 int len = entry->d_name.len;
1665 const char *name = entry->d_name.name;
1666 unsigned int hash = entry->d_name.hash;
1667
David Howells770bfad2006-08-22 20:06:07 -04001668 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001669 __d_instantiate(entry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001670 return NULL;
1671 }
1672
Sasha Levinb67bfe02013-02-27 17:06:00 -08001673 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Piggin9abca362011-01-07 17:49:36 +11001674 /*
1675 * Don't need alias->d_lock here, because aliases with
1676 * d_parent == entry->d_parent are not subject to name or
1677 * parent changes, because the parent inode i_mutex is held.
1678 */
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001679 if (alias->d_name.hash != hash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 continue;
1681 if (alias->d_parent != entry->d_parent)
1682 continue;
Linus Torvaldsee983e82012-05-10 12:37:10 -07001683 if (alias->d_name.len != len)
1684 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001685 if (dentry_cmp(alias, name, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 continue;
Nick Piggindc0474b2011-01-07 17:49:43 +11001687 __dget(alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 return alias;
1689 }
David Howells770bfad2006-08-22 20:06:07 -04001690
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001691 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 return NULL;
1693}
David Howells770bfad2006-08-22 20:06:07 -04001694
1695struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1696{
1697 struct dentry *result;
1698
Al Virob3d9b7a2012-06-09 13:51:19 -04001699 BUG_ON(!hlist_unhashed(&entry->d_alias));
David Howells770bfad2006-08-22 20:06:07 -04001700
Nick Piggin873feea2011-01-07 17:50:06 +11001701 if (inode)
1702 spin_lock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001703 result = __d_instantiate_unique(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001704 if (inode)
1705 spin_unlock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001706
1707 if (!result) {
1708 security_d_instantiate(entry, inode);
1709 return NULL;
1710 }
1711
1712 BUG_ON(!d_unhashed(result));
1713 iput(inode);
1714 return result;
1715}
1716
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717EXPORT_SYMBOL(d_instantiate_unique);
1718
Al Viroadc0e912012-01-08 16:49:21 -05001719struct dentry *d_make_root(struct inode *root_inode)
1720{
1721 struct dentry *res = NULL;
1722
1723 if (root_inode) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07001724 static const struct qstr name = QSTR_INIT("/", 1);
Al Viroadc0e912012-01-08 16:49:21 -05001725
1726 res = __d_alloc(root_inode->i_sb, &name);
1727 if (res)
1728 d_instantiate(res, root_inode);
1729 else
1730 iput(root_inode);
1731 }
1732 return res;
1733}
1734EXPORT_SYMBOL(d_make_root);
1735
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001736static struct dentry * __d_find_any_alias(struct inode *inode)
1737{
1738 struct dentry *alias;
1739
Al Virob3d9b7a2012-06-09 13:51:19 -04001740 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001741 return NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001742 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001743 __dget(alias);
1744 return alias;
1745}
1746
Sage Weil46f72b32012-01-10 09:04:37 -08001747/**
1748 * d_find_any_alias - find any alias for a given inode
1749 * @inode: inode to find an alias for
1750 *
1751 * If any aliases exist for the given inode, take and return a
1752 * reference for one of them. If no aliases exist, return %NULL.
1753 */
1754struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001755{
1756 struct dentry *de;
1757
1758 spin_lock(&inode->i_lock);
1759 de = __d_find_any_alias(inode);
1760 spin_unlock(&inode->i_lock);
1761 return de;
1762}
Sage Weil46f72b32012-01-10 09:04:37 -08001763EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001764
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765/**
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001766 * d_obtain_alias - find or allocate a dentry for a given inode
1767 * @inode: inode to allocate the dentry for
1768 *
1769 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1770 * similar open by handle operations. The returned dentry may be anonymous,
1771 * or may have a full name (if the inode was already in the cache).
1772 *
1773 * When called on a directory inode, we must ensure that the inode only ever
1774 * has one dentry. If a dentry is found, that is returned instead of
1775 * allocating a new one.
1776 *
1777 * On successful return, the reference to the inode has been transferred
Christoph Hellwig44003722008-08-11 15:49:04 +02001778 * to the dentry. In case of an error the reference on the inode is released.
1779 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1780 * be passed in and will be the error will be propagate to the return value,
1781 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001782 */
1783struct dentry *d_obtain_alias(struct inode *inode)
1784{
NeilBrownb911a6b2012-11-08 16:09:37 -08001785 static const struct qstr anonstring = QSTR_INIT("/", 1);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001786 struct dentry *tmp;
1787 struct dentry *res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001788
1789 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001790 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001791 if (IS_ERR(inode))
1792 return ERR_CAST(inode);
1793
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001794 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001795 if (res)
1796 goto out_iput;
1797
Al Viroa4464db2011-07-07 15:03:58 -04001798 tmp = __d_alloc(inode->i_sb, &anonstring);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001799 if (!tmp) {
1800 res = ERR_PTR(-ENOMEM);
1801 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001802 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001803
Nick Piggin873feea2011-01-07 17:50:06 +11001804 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001805 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001806 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001807 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001808 dput(tmp);
1809 goto out_iput;
1810 }
1811
1812 /* attach a disconnected dentry */
1813 spin_lock(&tmp->d_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001814 tmp->d_inode = inode;
1815 tmp->d_flags |= DCACHE_DISCONNECTED;
Al Virob3d9b7a2012-06-09 13:51:19 -04001816 hlist_add_head(&tmp->d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001817 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001818 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001819 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001820 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001821 spin_unlock(&inode->i_lock);
Josef Bacik24ff6662010-11-18 20:52:55 -05001822 security_d_instantiate(tmp, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001823
Christoph Hellwig9308a612008-08-11 15:49:12 +02001824 return tmp;
1825
1826 out_iput:
Josef Bacik24ff6662010-11-18 20:52:55 -05001827 if (res && !IS_ERR(res))
1828 security_d_instantiate(res, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001829 iput(inode);
1830 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001831}
Benny Halevyadc48722009-02-27 14:02:59 -08001832EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833
1834/**
1835 * d_splice_alias - splice a disconnected dentry into the tree if one exists
1836 * @inode: the inode which may have a disconnected dentry
1837 * @dentry: a negative dentry which we want to point to the inode.
1838 *
1839 * If inode is a directory and has a 'disconnected' dentry (i.e. IS_ROOT and
1840 * DCACHE_DISCONNECTED), then d_move that in place of the given dentry
1841 * and return it, else simply d_add the inode to the dentry and return NULL.
1842 *
1843 * This is needed in the lookup routine of any filesystem that is exportable
1844 * (via knfsd) so that we can build dcache paths to directories effectively.
1845 *
1846 * If a dentry was found and moved, then it is returned. Otherwise NULL
1847 * is returned. This matches the expected return value of ->lookup.
1848 *
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001849 * Cluster filesystems may call this function with a negative, hashed dentry.
1850 * In that case, we know that the inode will be a regular file, and also this
1851 * will only occur during atomic_open. So we need to check for the dentry
1852 * being already hashed only in the final case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853 */
1854struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
1855{
1856 struct dentry *new = NULL;
1857
Al Viroa9049372011-07-08 21:20:11 -04001858 if (IS_ERR(inode))
1859 return ERR_CAST(inode);
1860
NeilBrown21c0d8f2006-10-04 02:16:16 -07001861 if (inode && S_ISDIR(inode->i_mode)) {
Nick Piggin873feea2011-01-07 17:50:06 +11001862 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001863 new = __d_find_alias(inode, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 if (new) {
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001865 BUG_ON(!(new->d_flags & DCACHE_DISCONNECTED));
Nick Piggin873feea2011-01-07 17:50:06 +11001866 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 security_d_instantiate(new, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 d_move(new, dentry);
1869 iput(inode);
1870 } else {
Nick Piggin873feea2011-01-07 17:50:06 +11001871 /* already taking inode->i_lock, so d_add() by hand */
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001872 __d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001873 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874 security_d_instantiate(dentry, inode);
1875 d_rehash(dentry);
1876 }
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001877 } else {
1878 d_instantiate(dentry, inode);
1879 if (d_unhashed(dentry))
1880 d_rehash(dentry);
1881 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882 return new;
1883}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001884EXPORT_SYMBOL(d_splice_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885
Barry Naujok94035402008-05-21 16:50:46 +10001886/**
1887 * d_add_ci - lookup or allocate new dentry with case-exact name
1888 * @inode: the inode case-insensitive lookup has found
1889 * @dentry: the negative dentry that was passed to the parent's lookup func
1890 * @name: the case-exact name to be associated with the returned dentry
1891 *
1892 * This is to avoid filling the dcache with case-insensitive names to the
1893 * same inode, only the actual correct case is stored in the dcache for
1894 * case-insensitive filesystems.
1895 *
1896 * For a case-insensitive lookup match and if the the case-exact dentry
1897 * already exists in in the dcache, use it and return it.
1898 *
1899 * If no entry exists with the exact case name, allocate new dentry with
1900 * the exact case, and return the spliced entry.
1901 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001902struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001903 struct qstr *name)
1904{
Barry Naujok94035402008-05-21 16:50:46 +10001905 struct dentry *found;
1906 struct dentry *new;
1907
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001908 /*
1909 * First check if a dentry matching the name already exists,
1910 * if not go ahead and create it now.
1911 */
Barry Naujok94035402008-05-21 16:50:46 +10001912 found = d_hash_and_lookup(dentry->d_parent, name);
Al Viro4f522a22013-02-11 23:20:37 -05001913 if (unlikely(IS_ERR(found)))
1914 goto err_out;
Barry Naujok94035402008-05-21 16:50:46 +10001915 if (!found) {
1916 new = d_alloc(dentry->d_parent, name);
1917 if (!new) {
Al Viro4f522a22013-02-11 23:20:37 -05001918 found = ERR_PTR(-ENOMEM);
Barry Naujok94035402008-05-21 16:50:46 +10001919 goto err_out;
1920 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001921
Barry Naujok94035402008-05-21 16:50:46 +10001922 found = d_splice_alias(inode, new);
1923 if (found) {
1924 dput(new);
1925 return found;
1926 }
1927 return new;
1928 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001929
1930 /*
1931 * If a matching dentry exists, and it's not negative use it.
1932 *
1933 * Decrement the reference count to balance the iget() done
1934 * earlier on.
1935 */
Barry Naujok94035402008-05-21 16:50:46 +10001936 if (found->d_inode) {
1937 if (unlikely(found->d_inode != inode)) {
1938 /* This can't happen because bad inodes are unhashed. */
1939 BUG_ON(!is_bad_inode(inode));
1940 BUG_ON(!is_bad_inode(found->d_inode));
1941 }
Barry Naujok94035402008-05-21 16:50:46 +10001942 iput(inode);
1943 return found;
1944 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001945
Barry Naujok94035402008-05-21 16:50:46 +10001946 /*
1947 * Negative dentry: instantiate it unless the inode is a directory and
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001948 * already has a dentry.
Barry Naujok94035402008-05-21 16:50:46 +10001949 */
Al Viro4513d892011-07-17 10:52:14 -04001950 new = d_splice_alias(inode, found);
1951 if (new) {
1952 dput(found);
1953 found = new;
Barry Naujok94035402008-05-21 16:50:46 +10001954 }
Al Viro4513d892011-07-17 10:52:14 -04001955 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001956
1957err_out:
1958 iput(inode);
Al Viro4f522a22013-02-11 23:20:37 -05001959 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001960}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001961EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001963/*
1964 * Do the slow-case of the dentry name compare.
1965 *
1966 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07001967 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001968 * filesystem can rely on them, and can use the 'name' and
1969 * 'len' information without worrying about walking off the
1970 * end of memory etc.
1971 *
1972 * Thus the read_seqcount_retry() and the "duplicate" info
1973 * in arguments (the low-level filesystem should not look
1974 * at the dentry inode or name contents directly, since
1975 * rename can change them while we're in RCU mode).
1976 */
1977enum slow_d_compare {
1978 D_COMP_OK,
1979 D_COMP_NOMATCH,
1980 D_COMP_SEQRETRY,
1981};
1982
1983static noinline enum slow_d_compare slow_dentry_cmp(
1984 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001985 struct dentry *dentry,
1986 unsigned int seq,
1987 const struct qstr *name)
1988{
1989 int tlen = dentry->d_name.len;
1990 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001991
1992 if (read_seqcount_retry(&dentry->d_seq, seq)) {
1993 cpu_relax();
1994 return D_COMP_SEQRETRY;
1995 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07001996 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001997 return D_COMP_NOMATCH;
1998 return D_COMP_OK;
1999}
2000
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002002 * __d_lookup_rcu - search for a dentry (racy, store-free)
2003 * @parent: parent dentry
2004 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002005 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002006 * Returns: dentry, or NULL
2007 *
2008 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2009 * resolution (store-free path walking) design described in
2010 * Documentation/filesystems/path-lookup.txt.
2011 *
2012 * This is not to be used outside core vfs.
2013 *
2014 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2015 * held, and rcu_read_lock held. The returned dentry must not be stored into
2016 * without taking d_lock and checking d_seq sequence count against @seq
2017 * returned here.
2018 *
Linus Torvalds15570082013-09-02 11:38:06 -07002019 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002020 * function.
2021 *
2022 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2023 * the returned dentry, so long as its parent's seqlock is checked after the
2024 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2025 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002026 *
2027 * NOTE! The caller *has* to check the resulting dentry against the sequence
2028 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002029 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002030struct dentry *__d_lookup_rcu(const struct dentry *parent,
2031 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002032 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002033{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002034 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002035 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002036 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002037 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002038 struct dentry *dentry;
2039
2040 /*
2041 * Note: There is significant duplication with __d_lookup_rcu which is
2042 * required to prevent single threaded performance regressions
2043 * especially on architectures where smp_rmb (in seqcounts) are costly.
2044 * Keep the two functions in sync.
2045 */
2046
2047 /*
2048 * The hash list is protected using RCU.
2049 *
2050 * Carefully use d_seq when comparing a candidate dentry, to avoid
2051 * races with d_move().
2052 *
2053 * It is possible that concurrent renames can mess up our list
2054 * walk here and result in missing our dentry, resulting in the
2055 * false-negative result. d_lookup() protects against concurrent
2056 * renames using rename_lock seqlock.
2057 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002058 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002059 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002060 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002061 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002062
Nick Piggin31e6b012011-01-07 17:49:52 +11002063seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002064 /*
2065 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002066 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002067 *
2068 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002069 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002070 *
2071 * NOTE! We do a "raw" seqcount_begin here. That means that
2072 * we don't wait for the sequence count to stabilize if it
2073 * is in the middle of a sequence change. If we do the slow
2074 * dentry compare, we will do seqretries until it is stable,
2075 * and if we end up with a successful lookup, we actually
2076 * want to exit RCU lookup anyway.
2077 */
2078 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002079 if (dentry->d_parent != parent)
2080 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002081 if (d_unhashed(dentry))
2082 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002083
2084 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002085 if (dentry->d_name.hash != hashlen_hash(hashlen))
2086 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002087 *seqp = seq;
2088 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002089 case D_COMP_OK:
2090 return dentry;
2091 case D_COMP_NOMATCH:
2092 continue;
2093 default:
2094 goto seqretry;
2095 }
2096 }
2097
Linus Torvalds26fe5752012-05-10 13:14:12 -07002098 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002099 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002100 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002101 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002102 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002103 }
2104 return NULL;
2105}
2106
2107/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108 * d_lookup - search for a dentry
2109 * @parent: parent dentry
2110 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002111 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002113 * d_lookup searches the children of the parent dentry for the name in
2114 * question. If the dentry is found its reference count is incremented and the
2115 * dentry is returned. The caller must use dput to free the entry when it has
2116 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 */
Al Viroda2d8452013-01-24 18:29:34 -05002118struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119{
Nick Piggin31e6b012011-01-07 17:49:52 +11002120 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002121 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122
2123 do {
2124 seq = read_seqbegin(&rename_lock);
2125 dentry = __d_lookup(parent, name);
2126 if (dentry)
2127 break;
2128 } while (read_seqretry(&rename_lock, seq));
2129 return dentry;
2130}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002131EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132
Nick Piggin31e6b012011-01-07 17:49:52 +11002133/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002134 * __d_lookup - search for a dentry (racy)
2135 * @parent: parent dentry
2136 * @name: qstr of name we wish to find
2137 * Returns: dentry, or NULL
2138 *
2139 * __d_lookup is like d_lookup, however it may (rarely) return a
2140 * false-negative result due to unrelated rename activity.
2141 *
2142 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2143 * however it must be used carefully, eg. with a following d_lookup in
2144 * the case of failure.
2145 *
2146 * __d_lookup callers must be commented.
2147 */
Al Viroa713ca22013-01-24 18:27:00 -05002148struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149{
2150 unsigned int len = name->len;
2151 unsigned int hash = name->hash;
2152 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002153 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002154 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002155 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002156 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157
Nick Pigginb04f7842010-08-18 04:37:34 +10002158 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002159 * Note: There is significant duplication with __d_lookup_rcu which is
2160 * required to prevent single threaded performance regressions
2161 * especially on architectures where smp_rmb (in seqcounts) are costly.
2162 * Keep the two functions in sync.
2163 */
2164
2165 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002166 * The hash list is protected using RCU.
2167 *
2168 * Take d_lock when comparing a candidate dentry, to avoid races
2169 * with d_move().
2170 *
2171 * It is possible that concurrent renames can mess up our list
2172 * walk here and result in missing our dentry, resulting in the
2173 * false-negative result. d_lookup() protects against concurrent
2174 * renames using rename_lock seqlock.
2175 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002176 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002177 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178 rcu_read_lock();
2179
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002180 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 if (dentry->d_name.hash != hash)
2183 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184
2185 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186 if (dentry->d_parent != parent)
2187 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002188 if (d_unhashed(dentry))
2189 goto next;
2190
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 /*
2192 * It is safe to compare names since d_move() cannot
2193 * change the qstr (protected by d_lock).
2194 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002195 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002196 int tlen = dentry->d_name.len;
2197 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002198 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199 goto next;
2200 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002201 if (dentry->d_name.len != len)
2202 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002203 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 goto next;
2205 }
2206
Waiman Long98474232013-08-28 18:24:59 -07002207 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002208 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 spin_unlock(&dentry->d_lock);
2210 break;
2211next:
2212 spin_unlock(&dentry->d_lock);
2213 }
2214 rcu_read_unlock();
2215
2216 return found;
2217}
2218
2219/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002220 * d_hash_and_lookup - hash the qstr then search for a dentry
2221 * @dir: Directory to search in
2222 * @name: qstr of name we wish to find
2223 *
Al Viro4f522a22013-02-11 23:20:37 -05002224 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002225 */
2226struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2227{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002228 /*
2229 * Check for a fs-specific hash function. Note that we must
2230 * calculate the standard hash first, as the d_op->d_hash()
2231 * routine may choose to leave the hash value unchanged.
2232 */
2233 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002234 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002235 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002236 if (unlikely(err < 0))
2237 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002238 }
Al Viro4f522a22013-02-11 23:20:37 -05002239 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002240}
Al Viro4f522a22013-02-11 23:20:37 -05002241EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002242
2243/**
Nick Piggin786a5e12011-01-07 17:49:16 +11002244 * d_validate - verify dentry provided from insecure source (deprecated)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 * @dentry: The dentry alleged to be valid child of @dparent
Randy Dunlapff5fdb62011-01-22 20:16:06 -08002246 * @dparent: The parent dentry (known to be valid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247 *
2248 * An insecure source has sent us a dentry, here we verify it and dget() it.
2249 * This is used by ncpfs in its readdir implementation.
2250 * Zero is returned in the dentry is invalid.
Nick Piggin786a5e12011-01-07 17:49:16 +11002251 *
2252 * This function is slow for big directories, and deprecated, do not use it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 */
Nick Piggind3a23e12011-01-05 20:01:21 +11002254int d_validate(struct dentry *dentry, struct dentry *dparent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255{
Nick Piggin786a5e12011-01-07 17:49:16 +11002256 struct dentry *child;
Nick Piggind3a23e12011-01-05 20:01:21 +11002257
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002258 spin_lock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002259 list_for_each_entry(child, &dparent->d_subdirs, d_u.d_child) {
2260 if (dentry == child) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002261 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Nick Piggindc0474b2011-01-07 17:49:43 +11002262 __dget_dlock(dentry);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002263 spin_unlock(&dentry->d_lock);
2264 spin_unlock(&dparent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 return 1;
2266 }
2267 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002268 spin_unlock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002269
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270 return 0;
2271}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002272EXPORT_SYMBOL(d_validate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273
2274/*
2275 * When a file is deleted, we have two options:
2276 * - turn this dentry into a negative dentry
2277 * - unhash this dentry and free it.
2278 *
2279 * Usually, we want to just turn this into
2280 * a negative dentry, but if anybody else is
2281 * currently using the dentry or the inode
2282 * we can't do that and we fall back on removing
2283 * it from the hash queues and waiting for
2284 * it to be deleted later when it has no users
2285 */
2286
2287/**
2288 * d_delete - delete a dentry
2289 * @dentry: The dentry to delete
2290 *
2291 * Turn the dentry into a negative dentry if possible, otherwise
2292 * remove it from the hash queues so it can be deleted later
2293 */
2294
2295void d_delete(struct dentry * dentry)
2296{
Nick Piggin873feea2011-01-07 17:50:06 +11002297 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002298 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299 /*
2300 * Are we the only user?
2301 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002302again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002304 inode = dentry->d_inode;
2305 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002306 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002307 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002308 spin_unlock(&dentry->d_lock);
2309 cpu_relax();
2310 goto again;
2311 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002312 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002313 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002314 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 return;
2316 }
2317
2318 if (!d_unhashed(dentry))
2319 __d_drop(dentry);
2320
2321 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002322
2323 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002325EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002327static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002329 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002330 hlist_bl_lock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -07002331 entry->d_flags |= DCACHE_RCUACCESS;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002332 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002333 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334}
2335
David Howells770bfad2006-08-22 20:06:07 -04002336static void _d_rehash(struct dentry * entry)
2337{
2338 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2339}
2340
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341/**
2342 * d_rehash - add an entry back to the hash
2343 * @entry: dentry to add to the hash
2344 *
2345 * Adds a dentry to the hash according to its name.
2346 */
2347
2348void d_rehash(struct dentry * entry)
2349{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002351 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002354EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002356/**
2357 * dentry_update_name_case - update case insensitive dentry with a new name
2358 * @dentry: dentry to be updated
2359 * @name: new name
2360 *
2361 * Update a case insensitive dentry with new case of name.
2362 *
2363 * dentry must have been returned by d_lookup with name @name. Old and new
2364 * name lengths must match (ie. no d_compare which allows mismatched name
2365 * lengths).
2366 *
2367 * Parent inode i_mutex must be held over d_lookup and into this call (to
2368 * keep renames and concurrent inserts, and readdir(2) away).
2369 */
2370void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2371{
Linus Torvalds7ebfa572011-04-15 07:34:26 -07002372 BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002373 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2374
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002375 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002376 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002377 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002378 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002379 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002380}
2381EXPORT_SYMBOL(dentry_update_name_case);
2382
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383static void switch_names(struct dentry *dentry, struct dentry *target)
2384{
2385 if (dname_external(target)) {
2386 if (dname_external(dentry)) {
2387 /*
2388 * Both external: swap the pointers
2389 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002390 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391 } else {
2392 /*
2393 * dentry:internal, target:external. Steal target's
2394 * storage and make target internal.
2395 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002396 memcpy(target->d_iname, dentry->d_name.name,
2397 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398 dentry->d_name.name = target->d_name.name;
2399 target->d_name.name = target->d_iname;
2400 }
2401 } else {
2402 if (dname_external(dentry)) {
2403 /*
2404 * dentry:external, target:internal. Give dentry's
2405 * storage to target and make dentry internal
2406 */
2407 memcpy(dentry->d_iname, target->d_name.name,
2408 target->d_name.len + 1);
2409 target->d_name.name = dentry->d_name.name;
2410 dentry->d_name.name = dentry->d_iname;
2411 } else {
2412 /*
2413 * Both are internal. Just copy target to dentry
2414 */
2415 memcpy(dentry->d_iname, target->d_name.name,
2416 target->d_name.len + 1);
Al Virodc711ca2008-11-03 15:03:50 -05002417 dentry->d_name.len = target->d_name.len;
2418 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419 }
2420 }
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002421 swap(dentry->d_name.len, target->d_name.len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002422}
2423
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002424static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2425{
2426 /*
2427 * XXXX: do we really need to take target->d_lock?
2428 */
2429 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2430 spin_lock(&target->d_parent->d_lock);
2431 else {
2432 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2433 spin_lock(&dentry->d_parent->d_lock);
2434 spin_lock_nested(&target->d_parent->d_lock,
2435 DENTRY_D_LOCK_NESTED);
2436 } else {
2437 spin_lock(&target->d_parent->d_lock);
2438 spin_lock_nested(&dentry->d_parent->d_lock,
2439 DENTRY_D_LOCK_NESTED);
2440 }
2441 }
2442 if (target < dentry) {
2443 spin_lock_nested(&target->d_lock, 2);
2444 spin_lock_nested(&dentry->d_lock, 3);
2445 } else {
2446 spin_lock_nested(&dentry->d_lock, 2);
2447 spin_lock_nested(&target->d_lock, 3);
2448 }
2449}
2450
2451static void dentry_unlock_parents_for_move(struct dentry *dentry,
2452 struct dentry *target)
2453{
2454 if (target->d_parent != dentry->d_parent)
2455 spin_unlock(&dentry->d_parent->d_lock);
2456 if (target->d_parent != target)
2457 spin_unlock(&target->d_parent->d_lock);
2458}
2459
Linus Torvalds1da177e2005-04-16 15:20:36 -07002460/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002461 * When switching names, the actual string doesn't strictly have to
2462 * be preserved in the target - because we're dropping the target
2463 * anyway. As such, we can just do a simple memcpy() to copy over
2464 * the new name before we switch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465 *
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002466 * Note that we have to be a lot more careful about getting the hash
2467 * switched - we have to switch the hash value properly even if it
2468 * then no longer matches the actual (corrupted) string of the target.
2469 * The hash value has to match the hash queue that the dentry is on..
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002471/*
Al Viro18367502011-07-12 21:42:24 -04002472 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002473 * @dentry: entry to move
2474 * @target: new dentry
2475 *
2476 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002477 * dcache entries should not be moved in this way. Caller must hold
2478 * rename_lock, the i_mutex of the source and target directories,
2479 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480 */
Al Viro18367502011-07-12 21:42:24 -04002481static void __d_move(struct dentry * dentry, struct dentry * target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483 if (!dentry->d_inode)
2484 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2485
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002486 BUG_ON(d_ancestor(dentry, target));
2487 BUG_ON(d_ancestor(target, dentry));
2488
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002489 dentry_lock_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490
Nick Piggin31e6b012011-01-07 17:49:52 +11002491 write_seqcount_begin(&dentry->d_seq);
2492 write_seqcount_begin(&target->d_seq);
2493
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002494 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2495
2496 /*
2497 * Move the dentry to the target hash queue. Don't bother checking
2498 * for the same hash queue because of how unlikely it is.
2499 */
2500 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002501 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002502
2503 /* Unhash the target: dput() will then get rid of it */
2504 __d_drop(target);
2505
Eric Dumazet5160ee62006-01-08 01:03:32 -08002506 list_del(&dentry->d_u.d_child);
2507 list_del(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002508
2509 /* Switch the names.. */
2510 switch_names(dentry, target);
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002511 swap(dentry->d_name.hash, target->d_name.hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512
2513 /* ... and switch the parents */
2514 if (IS_ROOT(dentry)) {
2515 dentry->d_parent = target->d_parent;
2516 target->d_parent = target;
Eric Dumazet5160ee62006-01-08 01:03:32 -08002517 INIT_LIST_HEAD(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518 } else {
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002519 swap(dentry->d_parent, target->d_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520
2521 /* And add them back to the (new) parent lists */
Eric Dumazet5160ee62006-01-08 01:03:32 -08002522 list_add(&target->d_u.d_child, &target->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002523 }
2524
Eric Dumazet5160ee62006-01-08 01:03:32 -08002525 list_add(&dentry->d_u.d_child, &dentry->d_parent->d_subdirs);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002526
Nick Piggin31e6b012011-01-07 17:49:52 +11002527 write_seqcount_end(&target->d_seq);
2528 write_seqcount_end(&dentry->d_seq);
2529
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002530 dentry_unlock_parents_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531 spin_unlock(&target->d_lock);
Nick Pigginc32ccd82006-03-25 03:07:09 -08002532 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002534}
2535
2536/*
2537 * d_move - move a dentry
2538 * @dentry: entry to move
2539 * @target: new dentry
2540 *
2541 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002542 * dcache entries should not be moved in this way. See the locking
2543 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002544 */
2545void d_move(struct dentry *dentry, struct dentry *target)
2546{
2547 write_seqlock(&rename_lock);
2548 __d_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002549 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002550}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002551EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002552
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002553/**
2554 * d_ancestor - search for an ancestor
2555 * @p1: ancestor dentry
2556 * @p2: child dentry
2557 *
2558 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2559 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002560 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002561struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002562{
2563 struct dentry *p;
2564
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002565 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002566 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002567 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002568 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002569 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002570}
2571
2572/*
2573 * This helper attempts to cope with remotely renamed directories
2574 *
2575 * It assumes that the caller is already holding
Al Viro18367502011-07-12 21:42:24 -04002576 * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002577 *
2578 * Note: If ever the locking in lock_rename() changes, then please
2579 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002580 */
Nick Piggin873feea2011-01-07 17:50:06 +11002581static struct dentry *__d_unalias(struct inode *inode,
2582 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002583{
2584 struct mutex *m1 = NULL, *m2 = NULL;
Al Viroee3efa92012-06-08 15:59:33 -04002585 struct dentry *ret = ERR_PTR(-EBUSY);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002586
2587 /* If alias and dentry share a parent, then no extra locks required */
2588 if (alias->d_parent == dentry->d_parent)
2589 goto out_unalias;
2590
Trond Myklebust9eaef272006-10-21 10:24:20 -07002591 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002592 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2593 goto out_err;
2594 m1 = &dentry->d_sb->s_vfs_rename_mutex;
2595 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
2596 goto out_err;
2597 m2 = &alias->d_parent->d_inode->i_mutex;
2598out_unalias:
Al Viroee3efa92012-06-08 15:59:33 -04002599 if (likely(!d_mountpoint(alias))) {
2600 __d_move(alias, dentry);
2601 ret = alias;
2602 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002603out_err:
Nick Piggin873feea2011-01-07 17:50:06 +11002604 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002605 if (m2)
2606 mutex_unlock(m2);
2607 if (m1)
2608 mutex_unlock(m1);
2609 return ret;
2610}
2611
2612/*
David Howells770bfad2006-08-22 20:06:07 -04002613 * Prepare an anonymous dentry for life in the superblock's dentry tree as a
2614 * named dentry in place of the dentry to be replaced.
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002615 * returns with anon->d_lock held!
David Howells770bfad2006-08-22 20:06:07 -04002616 */
2617static void __d_materialise_dentry(struct dentry *dentry, struct dentry *anon)
2618{
Al Viro740da422013-01-30 10:13:38 -05002619 struct dentry *dparent;
David Howells770bfad2006-08-22 20:06:07 -04002620
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002621 dentry_lock_for_move(anon, dentry);
David Howells770bfad2006-08-22 20:06:07 -04002622
Nick Piggin31e6b012011-01-07 17:49:52 +11002623 write_seqcount_begin(&dentry->d_seq);
2624 write_seqcount_begin(&anon->d_seq);
2625
David Howells770bfad2006-08-22 20:06:07 -04002626 dparent = dentry->d_parent;
David Howells770bfad2006-08-22 20:06:07 -04002627
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002628 switch_names(dentry, anon);
2629 swap(dentry->d_name.hash, anon->d_name.hash);
2630
Al Viro740da422013-01-30 10:13:38 -05002631 dentry->d_parent = dentry;
2632 list_del_init(&dentry->d_u.d_child);
2633 anon->d_parent = dparent;
Wei Yongjun9ed53b12013-03-12 00:10:50 +08002634 list_move(&anon->d_u.d_child, &dparent->d_subdirs);
David Howells770bfad2006-08-22 20:06:07 -04002635
Nick Piggin31e6b012011-01-07 17:49:52 +11002636 write_seqcount_end(&dentry->d_seq);
2637 write_seqcount_end(&anon->d_seq);
2638
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002639 dentry_unlock_parents_for_move(anon, dentry);
2640 spin_unlock(&dentry->d_lock);
2641
2642 /* anon->d_lock still locked, returns locked */
David Howells770bfad2006-08-22 20:06:07 -04002643 anon->d_flags &= ~DCACHE_DISCONNECTED;
2644}
2645
2646/**
2647 * d_materialise_unique - introduce an inode into the tree
2648 * @dentry: candidate dentry
2649 * @inode: inode to bind to the dentry, to which aliases may be attached
2650 *
2651 * Introduces an dentry into the tree, substituting an extant disconnected
Jeff Laytonc46c8872011-07-26 13:33:16 -04002652 * root directory alias in its place if there is one. Caller must hold the
2653 * i_mutex of the parent directory.
David Howells770bfad2006-08-22 20:06:07 -04002654 */
2655struct dentry *d_materialise_unique(struct dentry *dentry, struct inode *inode)
2656{
Trond Myklebust9eaef272006-10-21 10:24:20 -07002657 struct dentry *actual;
David Howells770bfad2006-08-22 20:06:07 -04002658
2659 BUG_ON(!d_unhashed(dentry));
2660
David Howells770bfad2006-08-22 20:06:07 -04002661 if (!inode) {
2662 actual = dentry;
OGAWA Hirofumi360da902008-10-16 07:50:28 +09002663 __d_instantiate(dentry, NULL);
Nick Piggin357f8e62011-01-07 17:49:42 +11002664 d_rehash(actual);
2665 goto out_nolock;
David Howells770bfad2006-08-22 20:06:07 -04002666 }
2667
Nick Piggin873feea2011-01-07 17:50:06 +11002668 spin_lock(&inode->i_lock);
Nick Piggin357f8e62011-01-07 17:49:42 +11002669
Trond Myklebust9eaef272006-10-21 10:24:20 -07002670 if (S_ISDIR(inode->i_mode)) {
2671 struct dentry *alias;
David Howells770bfad2006-08-22 20:06:07 -04002672
Trond Myklebust9eaef272006-10-21 10:24:20 -07002673 /* Does an aliased dentry already exist? */
Linus Torvalds32ba9c32012-06-08 10:34:03 -07002674 alias = __d_find_alias(inode, 0);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002675 if (alias) {
2676 actual = alias;
Al Viro18367502011-07-12 21:42:24 -04002677 write_seqlock(&rename_lock);
2678
2679 if (d_ancestor(alias, dentry)) {
2680 /* Check for loops */
2681 actual = ERR_PTR(-ELOOP);
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002682 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002683 } else if (IS_ROOT(alias)) {
2684 /* Is this an anonymous mountpoint that we
2685 * could splice into our tree? */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002686 __d_materialise_dentry(dentry, alias);
Al Viro18367502011-07-12 21:42:24 -04002687 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002688 __d_drop(alias);
2689 goto found;
Al Viro18367502011-07-12 21:42:24 -04002690 } else {
2691 /* Nope, but we must(!) avoid directory
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002692 * aliasing. This drops inode->i_lock */
Al Viro18367502011-07-12 21:42:24 -04002693 actual = __d_unalias(inode, dentry, alias);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002694 }
Al Viro18367502011-07-12 21:42:24 -04002695 write_sequnlock(&rename_lock);
David Howellsdd179942011-08-16 15:31:30 +01002696 if (IS_ERR(actual)) {
2697 if (PTR_ERR(actual) == -ELOOP)
2698 pr_warn_ratelimited(
2699 "VFS: Lookup of '%s' in %s %s"
2700 " would have caused loop\n",
2701 dentry->d_name.name,
2702 inode->i_sb->s_type->name,
2703 inode->i_sb->s_id);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002704 dput(alias);
David Howellsdd179942011-08-16 15:31:30 +01002705 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002706 goto out_nolock;
2707 }
David Howells770bfad2006-08-22 20:06:07 -04002708 }
2709
2710 /* Add a unique reference */
2711 actual = __d_instantiate_unique(dentry, inode);
2712 if (!actual)
2713 actual = dentry;
Nick Piggin357f8e62011-01-07 17:49:42 +11002714 else
2715 BUG_ON(!d_unhashed(actual));
David Howells770bfad2006-08-22 20:06:07 -04002716
David Howells770bfad2006-08-22 20:06:07 -04002717 spin_lock(&actual->d_lock);
2718found:
2719 _d_rehash(actual);
2720 spin_unlock(&actual->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002721 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002722out_nolock:
David Howells770bfad2006-08-22 20:06:07 -04002723 if (actual == dentry) {
2724 security_d_instantiate(dentry, inode);
2725 return NULL;
2726 }
2727
2728 iput(inode);
2729 return actual;
David Howells770bfad2006-08-22 20:06:07 -04002730}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002731EXPORT_SYMBOL_GPL(d_materialise_unique);
David Howells770bfad2006-08-22 20:06:07 -04002732
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002733static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002734{
2735 *buflen -= namelen;
2736 if (*buflen < 0)
2737 return -ENAMETOOLONG;
2738 *buffer -= namelen;
2739 memcpy(*buffer, str, namelen);
2740 return 0;
2741}
2742
Waiman Long232d2d62013-09-09 12:18:13 -04002743/**
2744 * prepend_name - prepend a pathname in front of current buffer pointer
2745 * buffer: buffer pointer
2746 * buflen: allocated length of the buffer
2747 * name: name string and length qstr structure
2748 *
2749 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
2750 * make sure that either the old or the new name pointer and length are
2751 * fetched. However, there may be mismatch between length and pointer.
2752 * The length cannot be trusted, we need to copy it byte-by-byte until
2753 * the length is reached or a null byte is found. It also prepends "/" at
2754 * the beginning of the name. The sequence number check at the caller will
2755 * retry it again when a d_move() does happen. So any garbage in the buffer
2756 * due to mismatched pointer and length will be discarded.
2757 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002758static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2759{
Waiman Long232d2d62013-09-09 12:18:13 -04002760 const char *dname = ACCESS_ONCE(name->name);
2761 u32 dlen = ACCESS_ONCE(name->len);
2762 char *p;
2763
2764 if (*buflen < dlen + 1)
2765 return -ENAMETOOLONG;
2766 *buflen -= dlen + 1;
2767 p = *buffer -= dlen + 1;
2768 *p++ = '/';
2769 while (dlen--) {
2770 char c = *dname++;
2771 if (!c)
2772 break;
2773 *p++ = c;
2774 }
2775 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002776}
2777
Linus Torvalds1da177e2005-04-16 15:20:36 -07002778/**
Randy Dunlap208898c2010-11-18 15:02:49 -08002779 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002780 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002781 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002782 * @buffer: pointer to the end of the buffer
2783 * @buflen: pointer to buffer length
2784 *
Waiman Long232d2d62013-09-09 12:18:13 -04002785 * The function tries to write out the pathname without taking any lock other
2786 * than the RCU read lock to make sure that dentries won't go away. It only
2787 * checks the sequence number of the global rename_lock as any change in the
2788 * dentry's d_seq will be preceded by changes in the rename_lock sequence
2789 * number. If the sequence number had been change, it will restart the whole
2790 * pathname back-tracing sequence again. It performs a total of 3 trials of
2791 * lockless back-tracing sequences before falling back to take the
2792 * rename_lock.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002793 */
Al Viro02125a82011-12-05 08:43:34 -05002794static int prepend_path(const struct path *path,
2795 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002796 char **buffer, int *buflen)
2797{
2798 struct dentry *dentry = path->dentry;
2799 struct vfsmount *vfsmnt = path->mnt;
Al Viro0714a532011-11-24 22:19:58 -05002800 struct mount *mnt = real_mount(vfsmnt);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002801 int error = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04002802 unsigned seq = 0;
2803 char *bptr;
2804 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002805
Al Viro48f5ec22013-09-09 15:22:25 -04002806 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002807restart:
2808 bptr = *buffer;
2809 blen = *buflen;
2810 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002811 while (dentry != root->dentry || vfsmnt != root->mnt) {
2812 struct dentry * parent;
2813
2814 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
2815 /* Global root? */
Waiman Long232d2d62013-09-09 12:18:13 -04002816 if (mnt_has_parent(mnt)) {
2817 dentry = mnt->mnt_mountpoint;
2818 mnt = mnt->mnt_parent;
2819 vfsmnt = &mnt->mnt;
2820 continue;
2821 }
2822 /*
2823 * Filesystems needing to implement special "root names"
2824 * should do so with ->d_dname()
2825 */
2826 if (IS_ROOT(dentry) &&
2827 (dentry->d_name.len != 1 ||
2828 dentry->d_name.name[0] != '/')) {
2829 WARN(1, "Root dentry has weird name <%.*s>\n",
2830 (int) dentry->d_name.len,
2831 dentry->d_name.name);
2832 }
2833 if (!error)
2834 error = is_mounted(vfsmnt) ? 1 : 2;
2835 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002836 }
2837 parent = dentry->d_parent;
2838 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002839 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002840 if (error)
2841 break;
2842
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002843 dentry = parent;
2844 }
Al Viro48f5ec22013-09-09 15:22:25 -04002845 if (!(seq & 1))
2846 rcu_read_unlock();
2847 if (need_seqretry(&rename_lock, seq)) {
2848 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04002849 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002850 }
Al Viro48f5ec22013-09-09 15:22:25 -04002851 done_seqretry(&rename_lock, seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002852
Waiman Long232d2d62013-09-09 12:18:13 -04002853 if (error >= 0 && bptr == *buffer) {
2854 if (--blen < 0)
2855 error = -ENAMETOOLONG;
2856 else
2857 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002858 }
Waiman Long232d2d62013-09-09 12:18:13 -04002859 *buffer = bptr;
2860 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04002861 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002862}
2863
2864/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002865 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002866 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002867 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07002868 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07002869 * @buflen: buffer length
2870 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002871 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002872 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002873 * Returns a pointer into the buffer or an error code if the
2874 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08002875 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04002876 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002877 *
Al Viro02125a82011-12-05 08:43:34 -05002878 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002879 */
Al Viro02125a82011-12-05 08:43:34 -05002880char *__d_path(const struct path *path,
2881 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002882 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002883{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002884 char *res = buf + buflen;
2885 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002886
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002887 prepend(&res, &buflen, "\0", 1);
Al Viro7ea600b2013-03-26 18:25:57 -04002888 br_read_lock(&vfsmount_lock);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002889 error = prepend_path(path, root, &res, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04002890 br_read_unlock(&vfsmount_lock);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002891
Al Viro02125a82011-12-05 08:43:34 -05002892 if (error < 0)
2893 return ERR_PTR(error);
2894 if (error > 0)
2895 return NULL;
2896 return res;
2897}
2898
2899char *d_absolute_path(const struct path *path,
2900 char *buf, int buflen)
2901{
2902 struct path root = {};
2903 char *res = buf + buflen;
2904 int error;
2905
2906 prepend(&res, &buflen, "\0", 1);
Al Viro7ea600b2013-03-26 18:25:57 -04002907 br_read_lock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002908 error = prepend_path(path, &root, &res, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04002909 br_read_unlock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002910
2911 if (error > 1)
2912 error = -EINVAL;
2913 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002914 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002915 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002916}
2917
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002918/*
2919 * same as __d_path but appends "(deleted)" for unlinked files.
2920 */
Al Viro02125a82011-12-05 08:43:34 -05002921static int path_with_deleted(const struct path *path,
2922 const struct path *root,
2923 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002924{
2925 prepend(buf, buflen, "\0", 1);
2926 if (d_unlinked(path->dentry)) {
2927 int error = prepend(buf, buflen, " (deleted)", 10);
2928 if (error)
2929 return error;
2930 }
2931
2932 return prepend_path(path, root, buf, buflen);
2933}
2934
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002935static int prepend_unreachable(char **buffer, int *buflen)
2936{
2937 return prepend(buffer, buflen, "(unreachable)", 13);
2938}
2939
Jan Bluncka03a8a702008-02-14 19:38:32 -08002940/**
2941 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08002942 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08002943 * @buf: buffer to return value in
2944 * @buflen: buffer length
2945 *
2946 * Convert a dentry into an ASCII path name. If the entry has been deleted
2947 * the string " (deleted)" is appended. Note that this is ambiguous.
2948 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002949 * Returns a pointer into the buffer or an error code if the path was
2950 * too long. Note: Callers should use the returned pointer, not the passed
2951 * in buffer, to use the name! The implementation often starts at an offset
2952 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002953 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002954 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002955 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07002956char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002957{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002958 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08002959 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002960 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002961
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002962 /*
2963 * We have various synthetic filesystems that never get mounted. On
2964 * these filesystems dentries are never used for lookup purposes, and
2965 * thus don't need to be hashed. They also don't need a name until a
2966 * user wants to identify the object in /proc/pid/fd/. The little hack
2967 * below allows us to generate a name for these objects on demand:
2968 */
Jan Blunckcf28b482008-02-14 19:38:44 -08002969 if (path->dentry->d_op && path->dentry->d_op->d_dname)
2970 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002971
Miklos Szeredif7ad3c62010-08-10 11:41:36 +02002972 get_fs_root(current->fs, &root);
Al Viro7ea600b2013-03-26 18:25:57 -04002973 br_read_lock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002974 error = path_with_deleted(path, &root, &res, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04002975 br_read_unlock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002976 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002977 res = ERR_PTR(error);
Jan Blunck6ac08c32008-02-14 19:34:38 -08002978 path_put(&root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002979 return res;
2980}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002981EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002982
2983/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002984 * Helper function for dentry_operations.d_dname() members
2985 */
2986char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
2987 const char *fmt, ...)
2988{
2989 va_list args;
2990 char temp[64];
2991 int sz;
2992
2993 va_start(args, fmt);
2994 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
2995 va_end(args);
2996
2997 if (sz > sizeof(temp) || sz > buflen)
2998 return ERR_PTR(-ENAMETOOLONG);
2999
3000 buffer += buflen - sz;
3001 return memcpy(buffer, temp, sz);
3002}
3003
Al Viro118b2302013-08-24 12:08:17 -04003004char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3005{
3006 char *end = buffer + buflen;
3007 /* these dentries are never renamed, so d_lock is not needed */
3008 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003009 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003010 prepend(&end, &buflen, "/", 1))
3011 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003012 return end;
Al Viro118b2302013-08-24 12:08:17 -04003013}
3014
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003015/*
Ram Pai6092d042008-03-27 13:06:20 +01003016 * Write full pathname from the root of the filesystem into the buffer.
3017 */
Nick Pigginec2447c2011-01-07 17:49:29 +11003018static char *__dentry_path(struct dentry *dentry, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003019{
Waiman Long232d2d62013-09-09 12:18:13 -04003020 char *end, *retval;
3021 int len, seq = 0;
3022 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003023
Al Viro48f5ec22013-09-09 15:22:25 -04003024 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003025restart:
3026 end = buf + buflen;
3027 len = buflen;
3028 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003029 if (buflen < 1)
3030 goto Elong;
3031 /* Get '/' right */
3032 retval = end-1;
3033 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003034 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003035 while (!IS_ROOT(dentry)) {
3036 struct dentry *parent = dentry->d_parent;
Nick Piggin9abca362011-01-07 17:49:36 +11003037 int error;
Ram Pai6092d042008-03-27 13:06:20 +01003038
Ram Pai6092d042008-03-27 13:06:20 +01003039 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003040 error = prepend_name(&end, &len, &dentry->d_name);
3041 if (error)
3042 break;
Ram Pai6092d042008-03-27 13:06:20 +01003043
3044 retval = end;
3045 dentry = parent;
3046 }
Al Viro48f5ec22013-09-09 15:22:25 -04003047 if (!(seq & 1))
3048 rcu_read_unlock();
3049 if (need_seqretry(&rename_lock, seq)) {
3050 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003051 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003052 }
3053 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003054 if (error)
3055 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003056 return retval;
3057Elong:
3058 return ERR_PTR(-ENAMETOOLONG);
3059}
Nick Pigginec2447c2011-01-07 17:49:29 +11003060
3061char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3062{
Waiman Long232d2d62013-09-09 12:18:13 -04003063 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003064}
3065EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003066
3067char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3068{
3069 char *p = NULL;
3070 char *retval;
3071
Al Viroc1031352010-06-06 22:31:14 -04003072 if (d_unlinked(dentry)) {
3073 p = buf + buflen;
3074 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3075 goto Elong;
3076 buflen++;
3077 }
3078 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003079 if (!IS_ERR(retval) && p)
3080 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003081 return retval;
3082Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003083 return ERR_PTR(-ENAMETOOLONG);
3084}
3085
3086/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003087 * NOTE! The user-level library version returns a
3088 * character pointer. The kernel system call just
3089 * returns the length of the buffer filled (which
3090 * includes the ending '\0' character), or a negative
3091 * error value. So libc would do something like
3092 *
3093 * char *getcwd(char * buf, size_t size)
3094 * {
3095 * int retval;
3096 *
3097 * retval = sys_getcwd(buf, size);
3098 * if (retval >= 0)
3099 * return buf;
3100 * errno = -retval;
3101 * return NULL;
3102 * }
3103 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003104SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003105{
Linus Torvalds552ce542007-02-13 12:08:18 -08003106 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003107 struct path pwd, root;
Linus Torvalds552ce542007-02-13 12:08:18 -08003108 char *page = (char *) __get_free_page(GFP_USER);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003109
3110 if (!page)
3111 return -ENOMEM;
3112
Miklos Szeredif7ad3c62010-08-10 11:41:36 +02003113 get_fs_root_and_pwd(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003114
Linus Torvalds552ce542007-02-13 12:08:18 -08003115 error = -ENOENT;
Al Viro7ea600b2013-03-26 18:25:57 -04003116 br_read_lock(&vfsmount_lock);
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003117 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003118 unsigned long len;
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003119 char *cwd = page + PAGE_SIZE;
3120 int buflen = PAGE_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003121
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003122 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003123 error = prepend_path(&pwd, &root, &cwd, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04003124 br_read_unlock(&vfsmount_lock);
Linus Torvalds552ce542007-02-13 12:08:18 -08003125
Al Viro02125a82011-12-05 08:43:34 -05003126 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003127 goto out;
3128
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003129 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003130 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003131 error = prepend_unreachable(&cwd, &buflen);
3132 if (error)
3133 goto out;
3134 }
3135
Linus Torvalds552ce542007-02-13 12:08:18 -08003136 error = -ERANGE;
3137 len = PAGE_SIZE + page - cwd;
3138 if (len <= size) {
3139 error = len;
3140 if (copy_to_user(buf, cwd, len))
3141 error = -EFAULT;
3142 }
Nick Piggin949854d2011-01-07 17:49:37 +11003143 } else {
Al Viro7ea600b2013-03-26 18:25:57 -04003144 br_read_unlock(&vfsmount_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003145 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003146
3147out:
Jan Blunck6ac08c32008-02-14 19:34:38 -08003148 path_put(&pwd);
3149 path_put(&root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003150 free_page((unsigned long) page);
3151 return error;
3152}
3153
3154/*
3155 * Test whether new_dentry is a subdirectory of old_dentry.
3156 *
3157 * Trivially implemented using the dcache structure
3158 */
3159
3160/**
3161 * is_subdir - is new dentry a subdirectory of old_dentry
3162 * @new_dentry: new dentry
3163 * @old_dentry: old dentry
3164 *
3165 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
3166 * Returns 0 otherwise.
3167 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3168 */
3169
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003170int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003171{
3172 int result;
Nick Piggin949854d2011-01-07 17:49:37 +11003173 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003174
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003175 if (new_dentry == old_dentry)
3176 return 1;
3177
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003178 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003179 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003180 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003181 /*
3182 * Need rcu_readlock to protect against the d_parent trashing
3183 * due to d_move
3184 */
3185 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003186 if (d_ancestor(old_dentry, new_dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003187 result = 1;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003188 else
3189 result = 0;
Nick Piggin949854d2011-01-07 17:49:37 +11003190 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003191 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003192
3193 return result;
3194}
3195
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003196static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003197{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003198 struct dentry *root = data;
3199 if (dentry != root) {
3200 if (d_unhashed(dentry) || !dentry->d_inode)
3201 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003202
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003203 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3204 dentry->d_flags |= DCACHE_GENOCIDE;
3205 dentry->d_lockref.count--;
3206 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003207 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003208 return D_WALK_CONTINUE;
3209}
Nick Piggin58db63d2011-01-07 17:49:39 +11003210
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003211void d_genocide(struct dentry *parent)
3212{
3213 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003214}
3215
Al Viro60545d02013-06-07 01:20:27 -04003216void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003217{
Al Viro60545d02013-06-07 01:20:27 -04003218 inode_dec_link_count(inode);
3219 BUG_ON(dentry->d_name.name != dentry->d_iname ||
3220 !hlist_unhashed(&dentry->d_alias) ||
3221 !d_unlinked(dentry));
3222 spin_lock(&dentry->d_parent->d_lock);
3223 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3224 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3225 (unsigned long long)inode->i_ino);
3226 spin_unlock(&dentry->d_lock);
3227 spin_unlock(&dentry->d_parent->d_lock);
3228 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003229}
Al Viro60545d02013-06-07 01:20:27 -04003230EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003231
3232static __initdata unsigned long dhash_entries;
3233static int __init set_dhash_entries(char *str)
3234{
3235 if (!str)
3236 return 0;
3237 dhash_entries = simple_strtoul(str, &str, 0);
3238 return 1;
3239}
3240__setup("dhash_entries=", set_dhash_entries);
3241
3242static void __init dcache_init_early(void)
3243{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003244 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003245
3246 /* If hashes are distributed across NUMA nodes, defer
3247 * hash allocation until vmalloc space is available.
3248 */
3249 if (hashdist)
3250 return;
3251
3252 dentry_hashtable =
3253 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003254 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003255 dhash_entries,
3256 13,
3257 HASH_EARLY,
3258 &d_hash_shift,
3259 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003260 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003261 0);
3262
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003263 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003264 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003265}
3266
Denis Cheng74bf17c2007-10-16 23:26:30 -07003267static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003268{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003269 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003270
3271 /*
3272 * A constructor could be added for stable state like the lists,
3273 * but it is probably not worth it because of the cache nature
3274 * of the dcache.
3275 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003276 dentry_cache = KMEM_CACHE(dentry,
3277 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003278
3279 /* Hash may have been set up in dcache_init_early */
3280 if (!hashdist)
3281 return;
3282
3283 dentry_hashtable =
3284 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003285 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003286 dhash_entries,
3287 13,
3288 0,
3289 &d_hash_shift,
3290 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003291 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003292 0);
3293
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003294 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003295 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003296}
3297
3298/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003299struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003300EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003301
Linus Torvalds1da177e2005-04-16 15:20:36 -07003302EXPORT_SYMBOL(d_genocide);
3303
Linus Torvalds1da177e2005-04-16 15:20:36 -07003304void __init vfs_caches_init_early(void)
3305{
3306 dcache_init_early();
3307 inode_init_early();
3308}
3309
3310void __init vfs_caches_init(unsigned long mempages)
3311{
3312 unsigned long reserve;
3313
3314 /* Base hash sizes on available memory, with a reserve equal to
3315 150% of current kernel size */
3316
3317 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
3318 mempages -= reserve;
3319
3320 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003321 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003322
Denis Cheng74bf17c2007-10-16 23:26:30 -07003323 dcache_init();
3324 inode_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003325 files_init(mempages);
Denis Cheng74bf17c2007-10-16 23:26:30 -07003326 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003327 bdev_cache_init();
3328 chrdev_init();
3329}