blob: 03161240e744b30e32fcebd7dbf8f65d5f2eef21 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/dcache.c
3 *
4 * Complete reimplementation
5 * (C) 1997 Thomas Schoebel-Theuer,
6 * with heavy changes by Linus Torvalds
7 */
8
9/*
10 * Notes on the allocation strategy:
11 *
12 * The dcache is a master of the icache - whenever a dcache entry
13 * exists, the inode will always exist. "iput()" is done either when
14 * the dcache entry is deleted or garbage collected.
15 */
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/syscalls.h>
18#include <linux/string.h>
19#include <linux/mm.h>
20#include <linux/fs.h>
John McCutchan7a91bf72005-08-08 13:52:16 -040021#include <linux/fsnotify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/slab.h>
23#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/hash.h>
25#include <linux/cache.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/mount.h>
28#include <linux/file.h>
29#include <asm/uaccess.h>
30#include <linux/security.h>
31#include <linux/seqlock.h>
32#include <linux/swap.h>
33#include <linux/bootmem.h>
Al Viro5ad4e532009-03-29 19:50:06 -040034#include <linux/fs_struct.h>
Frederic Weisbecker613afbf2009-07-16 15:44:29 +020035#include <linux/hardirq.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110036#include <linux/bit_spinlock.h>
37#include <linux/rculist_bl.h>
Linus Torvalds268bb0c2011-05-20 12:50:29 -070038#include <linux/prefetch.h>
David Howellsdd179942011-08-16 15:31:30 +010039#include <linux/ratelimit.h>
David Howells07f3f052006-09-30 20:52:18 +020040#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050041#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Nick Piggin789680d2011-01-07 17:49:30 +110043/*
44 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110045 * dcache->d_inode->i_lock protects:
46 * - i_dentry, d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110047 * dcache_hash_bucket lock protects:
48 * - the dcache hash table
49 * s_anon bl list spinlock protects:
50 * - the s_anon list (see __d_drop)
Nick Piggin23044502011-01-07 17:49:31 +110051 * dcache_lru_lock protects:
52 * - the dcache lru lists and counters
53 * d_lock protects:
54 * - d_flags
55 * - d_name
56 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110057 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110058 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110059 * - d_parent and d_subdirs
60 * - childrens' d_child and d_parent
Nick Pigginb23fb0a2011-01-07 17:49:35 +110061 * - d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110062 *
63 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110064 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110065 * dentry->d_lock
66 * dcache_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110067 * dcache_hash_bucket lock
68 * s_anon lock
Nick Piggin789680d2011-01-07 17:49:30 +110069 *
Nick Pigginda502952011-01-07 17:49:33 +110070 * If there is an ancestor relationship:
71 * dentry->d_parent->...->d_parent->d_lock
72 * ...
73 * dentry->d_parent->d_lock
74 * dentry->d_lock
75 *
76 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110077 * if (dentry1 < dentry2)
78 * dentry1->d_lock
79 * dentry2->d_lock
80 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080081int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
83
Nick Piggin23044502011-01-07 17:49:31 +110084static __cacheline_aligned_in_smp DEFINE_SPINLOCK(dcache_lru_lock);
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/*
Sage Weilf0023bc2011-10-28 10:02:42 -0700360 * dentry_lru_(add|del|prune|move_tail) 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))) {
Nick Piggin23044502011-01-07 17:49:31 +1100365 spin_lock(&dcache_lru_lock);
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700366 dentry->d_flags |= DCACHE_LRU_LIST;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400367 list_add(&dentry->d_lru, &dentry->d_sb->s_dentry_lru);
368 dentry->d_sb->s_nr_dentry_unused++;
Dave Chinner62d36c72013-08-28 10:17:54 +1000369 this_cpu_inc(nr_dentry_unused);
Nick Piggin23044502011-01-07 17:49:31 +1100370 spin_unlock(&dcache_lru_lock);
Christoph Hellwiga4633352010-10-10 05:36:26 -0400371 }
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700372}
373
Nick Piggin23044502011-01-07 17:49:31 +1100374static void __dentry_lru_del(struct dentry *dentry)
375{
376 list_del_init(&dentry->d_lru);
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700377 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
Nick Piggin23044502011-01-07 17:49:31 +1100378 dentry->d_sb->s_nr_dentry_unused--;
Dave Chinner62d36c72013-08-28 10:17:54 +1000379 this_cpu_dec(nr_dentry_unused);
Nick Piggin23044502011-01-07 17:49:31 +1100380}
381
Sage Weilf0023bc2011-10-28 10:02:42 -0700382/*
383 * Remove a dentry with references from the LRU.
384 */
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700385static void dentry_lru_del(struct dentry *dentry)
386{
387 if (!list_empty(&dentry->d_lru)) {
Nick Piggin23044502011-01-07 17:49:31 +1100388 spin_lock(&dcache_lru_lock);
389 __dentry_lru_del(dentry);
390 spin_unlock(&dcache_lru_lock);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700391 }
392}
393
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000394static void dentry_lru_move_list(struct dentry *dentry, struct list_head *list)
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700395{
Nick Piggin23044502011-01-07 17:49:31 +1100396 spin_lock(&dcache_lru_lock);
Christoph Hellwiga4633352010-10-10 05:36:26 -0400397 if (list_empty(&dentry->d_lru)) {
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700398 dentry->d_flags |= DCACHE_LRU_LIST;
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000399 list_add_tail(&dentry->d_lru, list);
Christoph Hellwiga4633352010-10-10 05:36:26 -0400400 dentry->d_sb->s_nr_dentry_unused++;
Dave Chinner62d36c72013-08-28 10:17:54 +1000401 this_cpu_inc(nr_dentry_unused);
Christoph Hellwiga4633352010-10-10 05:36:26 -0400402 } else {
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000403 list_move_tail(&dentry->d_lru, list);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700404 }
Nick Piggin23044502011-01-07 17:49:31 +1100405 spin_unlock(&dcache_lru_lock);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700406}
407
Miklos Szeredid52b9082007-05-08 00:23:46 -0700408/**
409 * d_kill - kill dentry and return parent
410 * @dentry: dentry to kill
Randy Dunlapff5fdb62011-01-22 20:16:06 -0800411 * @parent: parent dentry
Miklos Szeredid52b9082007-05-08 00:23:46 -0700412 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200413 * The dentry must already be unhashed and removed from the LRU.
Miklos Szeredid52b9082007-05-08 00:23:46 -0700414 *
415 * If this is the root of the dentry tree, return NULL.
Nick Piggin23044502011-01-07 17:49:31 +1100416 *
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100417 * dentry->d_lock and parent->d_lock must be held by caller, and are dropped by
418 * d_kill.
Miklos Szeredid52b9082007-05-08 00:23:46 -0700419 */
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100420static struct dentry *d_kill(struct dentry *dentry, struct dentry *parent)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200421 __releases(dentry->d_lock)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100422 __releases(parent->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100423 __releases(dentry->d_inode->i_lock)
Miklos Szeredid52b9082007-05-08 00:23:46 -0700424{
Miklos Szeredid52b9082007-05-08 00:23:46 -0700425 list_del(&dentry->d_u.d_child);
Trond Myklebustc83ce982011-03-15 13:36:43 -0400426 /*
427 * Inform try_to_ascend() that we are no longer attached to the
428 * dentry tree
429 */
Miklos Szeredib161dfa62012-09-17 22:31:38 +0200430 dentry->d_flags |= DCACHE_DENTRY_KILLED;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100431 if (parent)
432 spin_unlock(&parent->d_lock);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700433 dentry_iput(dentry);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100434 /*
435 * dentry_iput drops the locks, at which point nobody (except
436 * transient RCU lookups) can reach this dentry.
437 */
Miklos Szeredid52b9082007-05-08 00:23:46 -0700438 d_free(dentry);
OGAWA Hirofumi871c0062008-10-16 07:50:27 +0900439 return parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700440}
441
David Howellsc6627c62011-06-07 14:09:20 +0100442/*
443 * Unhash a dentry without inserting an RCU walk barrier or checking that
444 * dentry->d_lock is locked. The caller must take care of that, if
445 * appropriate.
446 */
447static void __d_shrink(struct dentry *dentry)
448{
449 if (!d_unhashed(dentry)) {
450 struct hlist_bl_head *b;
451 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
452 b = &dentry->d_sb->s_anon;
453 else
454 b = d_hash(dentry->d_parent, dentry->d_name.hash);
455
456 hlist_bl_lock(b);
457 __hlist_bl_del(&dentry->d_hash);
458 dentry->d_hash.pprev = NULL;
459 hlist_bl_unlock(b);
460 }
461}
462
Nick Piggin789680d2011-01-07 17:49:30 +1100463/**
464 * d_drop - drop a dentry
465 * @dentry: dentry to drop
466 *
467 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
468 * be found through a VFS lookup any more. Note that this is different from
469 * deleting the dentry - d_delete will try to mark the dentry negative if
470 * possible, giving a successful _negative_ lookup, while d_drop will
471 * just make the cache lookup fail.
472 *
473 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
474 * reason (NFS timeouts or autofs deletes).
475 *
476 * __d_drop requires dentry->d_lock.
477 */
478void __d_drop(struct dentry *dentry)
479{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700480 if (!d_unhashed(dentry)) {
David Howellsc6627c62011-06-07 14:09:20 +0100481 __d_shrink(dentry);
Linus Torvaldsdea36672011-04-24 07:58:46 -0700482 dentry_rcuwalk_barrier(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +1100483 }
484}
485EXPORT_SYMBOL(__d_drop);
486
487void d_drop(struct dentry *dentry)
488{
Nick Piggin789680d2011-01-07 17:49:30 +1100489 spin_lock(&dentry->d_lock);
490 __d_drop(dentry);
491 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100492}
493EXPORT_SYMBOL(d_drop);
494
Nick Piggin77812a12011-01-07 17:49:48 +1100495/*
496 * Finish off a dentry we've decided to kill.
497 * dentry->d_lock must be held, returns with it unlocked.
498 * If ref is non-zero, then decrement the refcount too.
499 * Returns dentry requiring refcount drop, or NULL if we're done.
500 */
Linus Torvalds0d984392013-09-08 13:46:52 -0700501static inline struct dentry *dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100502 __releases(dentry->d_lock)
503{
Nick Piggin873feea2011-01-07 17:50:06 +1100504 struct inode *inode;
Nick Piggin77812a12011-01-07 17:49:48 +1100505 struct dentry *parent;
506
Nick Piggin873feea2011-01-07 17:50:06 +1100507 inode = dentry->d_inode;
508 if (inode && !spin_trylock(&inode->i_lock)) {
Nick Piggin77812a12011-01-07 17:49:48 +1100509relock:
510 spin_unlock(&dentry->d_lock);
511 cpu_relax();
512 return dentry; /* try again with same dentry */
513 }
514 if (IS_ROOT(dentry))
515 parent = NULL;
516 else
517 parent = dentry->d_parent;
518 if (parent && !spin_trylock(&parent->d_lock)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100519 if (inode)
520 spin_unlock(&inode->i_lock);
Nick Piggin77812a12011-01-07 17:49:48 +1100521 goto relock;
522 }
Nick Piggin31e6b012011-01-07 17:49:52 +1100523
Linus Torvalds0d984392013-09-08 13:46:52 -0700524 /*
525 * The dentry is now unrecoverably dead to the world.
526 */
527 lockref_mark_dead(&dentry->d_lockref);
528
Sage Weilf0023bc2011-10-28 10:02:42 -0700529 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700530 * inform the fs via d_prune that this dentry is about to be
531 * unhashed and destroyed.
532 */
Yan, Zheng590fb512013-08-13 15:42:02 +0800533 if ((dentry->d_flags & DCACHE_OP_PRUNE) && !d_unhashed(dentry))
Yan, Zheng61572bb2013-04-15 14:13:21 +0800534 dentry->d_op->d_prune(dentry);
535
536 dentry_lru_del(dentry);
Nick Piggin77812a12011-01-07 17:49:48 +1100537 /* if it was on the hash then remove it */
538 __d_drop(dentry);
539 return d_kill(dentry, parent);
540}
541
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542/*
543 * This is dput
544 *
545 * This is complicated by the fact that we do not want to put
546 * dentries that are no longer on any hash chain on the unused
547 * list: we'd much rather just get rid of them immediately.
548 *
549 * However, that implies that we have to traverse the dentry
550 * tree upwards to the parents which might _also_ now be
551 * scheduled for deletion (it may have been only waiting for
552 * its last child to go away).
553 *
554 * This tail recursion is done by hand as we don't want to depend
555 * on the compiler to always get this right (gcc generally doesn't).
556 * Real recursion would eat up our stack space.
557 */
558
559/*
560 * dput - release a dentry
561 * @dentry: dentry to release
562 *
563 * Release a dentry. This will drop the usage count and if appropriate
564 * call the dentry unlink method as well as removing it from the queues and
565 * releasing its resources. If the parent dentries were scheduled for release
566 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568void dput(struct dentry *dentry)
569{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700570 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 return;
572
573repeat:
Waiman Long98474232013-08-28 18:24:59 -0700574 if (lockref_put_or_lock(&dentry->d_lockref))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700577 /* Unreachable? Get rid of it */
578 if (unlikely(d_unhashed(dentry)))
579 goto kill_it;
580
581 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100583 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 }
Nick Piggin265ac902010-10-10 05:36:24 -0400585
Jeff Layton39e3c952012-11-28 11:30:53 -0500586 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400587 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400588
Waiman Long98474232013-08-28 18:24:59 -0700589 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100590 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 return;
592
Miklos Szeredid52b9082007-05-08 00:23:46 -0700593kill_it:
Linus Torvalds0d984392013-09-08 13:46:52 -0700594 dentry = dentry_kill(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700595 if (dentry)
596 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700598EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
600/**
601 * d_invalidate - invalidate a dentry
602 * @dentry: dentry to invalidate
603 *
604 * Try to invalidate the dentry if it turns out to be
605 * possible. If there are other dentries that can be
606 * reached through this one we can't delete it and we
607 * return -EBUSY. On success we return 0.
608 *
609 * no dcache lock.
610 */
611
612int d_invalidate(struct dentry * dentry)
613{
614 /*
615 * If it's already been dropped, return OK.
616 */
Nick Pigginda502952011-01-07 17:49:33 +1100617 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 if (d_unhashed(dentry)) {
Nick Pigginda502952011-01-07 17:49:33 +1100619 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 return 0;
621 }
622 /*
623 * Check whether to do a partial shrink_dcache
624 * to get rid of unused child entries.
625 */
626 if (!list_empty(&dentry->d_subdirs)) {
Nick Pigginda502952011-01-07 17:49:33 +1100627 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 shrink_dcache_parent(dentry);
Nick Pigginda502952011-01-07 17:49:33 +1100629 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 }
631
632 /*
633 * Somebody else still using it?
634 *
635 * If it's a directory, we can't drop it
636 * for fear of somebody re-populating it
637 * with children (even though dropping it
638 * would make it unreachable from the root,
639 * we might still populate it if it was a
640 * working directory or similar).
Al Viro50e69632011-11-07 16:39:57 +0000641 * We also need to leave mountpoints alone,
642 * directory or not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 */
Waiman Long98474232013-08-28 18:24:59 -0700644 if (dentry->d_lockref.count > 1 && dentry->d_inode) {
Al Viro50e69632011-11-07 16:39:57 +0000645 if (S_ISDIR(dentry->d_inode->i_mode) || d_mountpoint(dentry)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 return -EBUSY;
648 }
649 }
650
651 __d_drop(dentry);
652 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 return 0;
654}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700655EXPORT_SYMBOL(d_invalidate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100657/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100658static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659{
Waiman Long98474232013-08-28 18:24:59 -0700660 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661}
662
Nick Piggindc0474b2011-01-07 17:49:43 +1100663static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100664{
Waiman Long98474232013-08-28 18:24:59 -0700665 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100666}
667
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100668struct dentry *dget_parent(struct dentry *dentry)
669{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700670 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100671 struct dentry *ret;
672
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700673 /*
674 * Do optimistic parent lookup without any
675 * locking.
676 */
677 rcu_read_lock();
678 ret = ACCESS_ONCE(dentry->d_parent);
679 gotref = lockref_get_not_zero(&ret->d_lockref);
680 rcu_read_unlock();
681 if (likely(gotref)) {
682 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
683 return ret;
684 dput(ret);
685 }
686
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100687repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100688 /*
689 * Don't need rcu_dereference because we re-check it was correct under
690 * the lock.
691 */
692 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100693 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100694 spin_lock(&ret->d_lock);
695 if (unlikely(ret != dentry->d_parent)) {
696 spin_unlock(&ret->d_lock);
697 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100698 goto repeat;
699 }
Nick Piggina734eb42011-01-07 17:49:44 +1100700 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700701 BUG_ON(!ret->d_lockref.count);
702 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100703 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100704 return ret;
705}
706EXPORT_SYMBOL(dget_parent);
707
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708/**
709 * d_find_alias - grab a hashed alias of inode
710 * @inode: inode in question
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700711 * @want_discon: flag, used by d_splice_alias, to request
712 * that only a DISCONNECTED alias be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 *
714 * If inode has a hashed alias, or is a directory and has any alias,
715 * acquire the reference to alias and return it. Otherwise return NULL.
716 * Notice that if inode is a directory there can be only one alias and
717 * it can be unhashed only if it has no children, or if it is the root
718 * of a filesystem.
719 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700720 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700721 * any other hashed alias over that one unless @want_discon is set,
722 * in which case only return an IS_ROOT, DCACHE_DISCONNECTED alias.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 */
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700724static struct dentry *__d_find_alias(struct inode *inode, int want_discon)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725{
Nick Pigginda502952011-01-07 17:49:33 +1100726 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727
Nick Pigginda502952011-01-07 17:49:33 +1100728again:
729 discon_alias = NULL;
Sasha Levinb67bfe02013-02-27 17:06:00 -0800730 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100731 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700733 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100734 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 discon_alias = alias;
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700736 } else if (!want_discon) {
Nick Piggindc0474b2011-01-07 17:49:43 +1100737 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100738 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 return alias;
740 }
741 }
Nick Pigginda502952011-01-07 17:49:33 +1100742 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 }
Nick Pigginda502952011-01-07 17:49:33 +1100744 if (discon_alias) {
745 alias = discon_alias;
746 spin_lock(&alias->d_lock);
747 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
748 if (IS_ROOT(alias) &&
749 (alias->d_flags & DCACHE_DISCONNECTED)) {
Nick Piggindc0474b2011-01-07 17:49:43 +1100750 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100751 spin_unlock(&alias->d_lock);
752 return alias;
753 }
754 }
755 spin_unlock(&alias->d_lock);
756 goto again;
757 }
758 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759}
760
Nick Pigginda502952011-01-07 17:49:33 +1100761struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762{
David Howells214fda12006-03-25 03:06:36 -0800763 struct dentry *de = NULL;
764
Al Virob3d9b7a2012-06-09 13:51:19 -0400765 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100766 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700767 de = __d_find_alias(inode, 0);
Nick Piggin873feea2011-01-07 17:50:06 +1100768 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800769 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 return de;
771}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700772EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773
774/*
775 * Try to kill dentries associated with this inode.
776 * WARNING: you must own a reference to inode.
777 */
778void d_prune_aliases(struct inode *inode)
779{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700780 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100782 spin_lock(&inode->i_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -0800783 hlist_for_each_entry(dentry, &inode->i_dentry, d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700785 if (!dentry->d_lockref.count) {
Yan, Zheng590fb512013-08-13 15:42:02 +0800786 /*
787 * inform the fs via d_prune that this dentry
788 * is about to be unhashed and destroyed.
789 */
790 if ((dentry->d_flags & DCACHE_OP_PRUNE) &&
791 !d_unhashed(dentry))
792 dentry->d_op->d_prune(dentry);
793
Nick Piggindc0474b2011-01-07 17:49:43 +1100794 __dget_dlock(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 __d_drop(dentry);
796 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100797 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 dput(dentry);
799 goto restart;
800 }
801 spin_unlock(&dentry->d_lock);
802 }
Nick Piggin873feea2011-01-07 17:50:06 +1100803 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700805EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806
807/*
Nick Piggin77812a12011-01-07 17:49:48 +1100808 * Try to throw away a dentry - free the inode, dput the parent.
809 * Requires dentry->d_lock is held, and dentry->d_count == 0.
810 * Releases dentry->d_lock.
Andrew Mortond702ccb2006-06-22 14:47:31 -0700811 *
Nick Piggin77812a12011-01-07 17:49:48 +1100812 * This may fail if locks cannot be acquired no problem, just try again.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 */
Nick Piggin77812a12011-01-07 17:49:48 +1100814static void try_prune_one_dentry(struct dentry *dentry)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200815 __releases(dentry->d_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816{
Nick Piggin77812a12011-01-07 17:49:48 +1100817 struct dentry *parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700818
Linus Torvalds0d984392013-09-08 13:46:52 -0700819 parent = dentry_kill(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700820 /*
Nick Piggin77812a12011-01-07 17:49:48 +1100821 * If dentry_kill returns NULL, we have nothing more to do.
822 * if it returns the same dentry, trylocks failed. In either
823 * case, just loop again.
824 *
825 * Otherwise, we need to prune ancestors too. This is necessary
826 * to prevent quadratic behavior of shrink_dcache_parent(), but
827 * is also expected to be beneficial in reducing dentry cache
828 * fragmentation.
Miklos Szeredid52b9082007-05-08 00:23:46 -0700829 */
Nick Piggin77812a12011-01-07 17:49:48 +1100830 if (!parent)
831 return;
832 if (parent == dentry)
833 return;
834
835 /* Prune ancestors. */
836 dentry = parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700837 while (dentry) {
Waiman Long98474232013-08-28 18:24:59 -0700838 if (lockref_put_or_lock(&dentry->d_lockref))
Nick Piggin89e60542011-01-07 17:49:45 +1100839 return;
Linus Torvalds0d984392013-09-08 13:46:52 -0700840 dentry = dentry_kill(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700841 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842}
843
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400844static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845{
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700846 struct dentry *dentry;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700847
Nick Pigginec336792011-01-07 17:49:47 +1100848 rcu_read_lock();
849 for (;;) {
Nick Pigginec336792011-01-07 17:49:47 +1100850 dentry = list_entry_rcu(list->prev, struct dentry, d_lru);
851 if (&dentry->d_lru == list)
852 break; /* empty */
853 spin_lock(&dentry->d_lock);
854 if (dentry != list_entry(list->prev, struct dentry, d_lru)) {
855 spin_unlock(&dentry->d_lock);
Nick Piggin23044502011-01-07 17:49:31 +1100856 continue;
857 }
858
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 /*
860 * We found an inuse dentry which was not removed from
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700861 * the LRU because of laziness during lookup. Do not free
862 * it - just keep it off the LRU list.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 */
Waiman Long98474232013-08-28 18:24:59 -0700864 if (dentry->d_lockref.count) {
Nick Pigginec336792011-01-07 17:49:47 +1100865 dentry_lru_del(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700866 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 continue;
868 }
Nick Pigginec336792011-01-07 17:49:47 +1100869
Nick Pigginec336792011-01-07 17:49:47 +1100870 rcu_read_unlock();
Nick Piggin77812a12011-01-07 17:49:48 +1100871
872 try_prune_one_dentry(dentry);
873
Nick Pigginec336792011-01-07 17:49:47 +1100874 rcu_read_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875 }
Nick Pigginec336792011-01-07 17:49:47 +1100876 rcu_read_unlock();
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400877}
878
879/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000880 * prune_dcache_sb - shrink the dcache
881 * @sb: superblock
882 * @count: number of entries to try to free
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400883 *
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000884 * Attempt to shrink the superblock dcache LRU by @count entries. This is
885 * done when we need more memory an called from the superblock shrinker
886 * function.
887 *
888 * This function may fail to free any resources if all the dentries are in
889 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400890 */
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000891void prune_dcache_sb(struct super_block *sb, int count)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400892{
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400893 struct dentry *dentry;
894 LIST_HEAD(referenced);
895 LIST_HEAD(tmp);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400896
Nick Piggin23044502011-01-07 17:49:31 +1100897relock:
898 spin_lock(&dcache_lru_lock);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400899 while (!list_empty(&sb->s_dentry_lru)) {
900 dentry = list_entry(sb->s_dentry_lru.prev,
901 struct dentry, d_lru);
902 BUG_ON(dentry->d_sb != sb);
903
Nick Piggin23044502011-01-07 17:49:31 +1100904 if (!spin_trylock(&dentry->d_lock)) {
905 spin_unlock(&dcache_lru_lock);
906 cpu_relax();
907 goto relock;
908 }
909
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000910 if (dentry->d_flags & DCACHE_REFERENCED) {
Nick Piggin23044502011-01-07 17:49:31 +1100911 dentry->d_flags &= ~DCACHE_REFERENCED;
912 list_move(&dentry->d_lru, &referenced);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400913 spin_unlock(&dentry->d_lock);
Nick Piggin23044502011-01-07 17:49:31 +1100914 } else {
915 list_move_tail(&dentry->d_lru, &tmp);
Miklos Szeredieaf5f902012-01-10 18:22:25 +0100916 dentry->d_flags |= DCACHE_SHRINK_LIST;
Nick Piggin23044502011-01-07 17:49:31 +1100917 spin_unlock(&dentry->d_lock);
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000918 if (!--count)
Nick Piggin23044502011-01-07 17:49:31 +1100919 break;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400920 }
Nick Pigginec336792011-01-07 17:49:47 +1100921 cond_resched_lock(&dcache_lru_lock);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400922 }
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700923 if (!list_empty(&referenced))
924 list_splice(&referenced, &sb->s_dentry_lru);
Nick Piggin23044502011-01-07 17:49:31 +1100925 spin_unlock(&dcache_lru_lock);
Nick Pigginec336792011-01-07 17:49:47 +1100926
927 shrink_dentry_list(&tmp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928}
929
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700930/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 * shrink_dcache_sb - shrink dcache for a superblock
932 * @sb: superblock
933 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400934 * Shrink the dcache for the specified super block. This is used to free
935 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400937void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938{
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400939 LIST_HEAD(tmp);
940
Nick Piggin23044502011-01-07 17:49:31 +1100941 spin_lock(&dcache_lru_lock);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400942 while (!list_empty(&sb->s_dentry_lru)) {
943 list_splice_init(&sb->s_dentry_lru, &tmp);
Nick Pigginec336792011-01-07 17:49:47 +1100944 spin_unlock(&dcache_lru_lock);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400945 shrink_dentry_list(&tmp);
Nick Pigginec336792011-01-07 17:49:47 +1100946 spin_lock(&dcache_lru_lock);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400947 }
Nick Piggin23044502011-01-07 17:49:31 +1100948 spin_unlock(&dcache_lru_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700950EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951
952/*
David Howellsc636ebd2006-10-11 01:22:19 -0700953 * destroy a single subtree of dentries for unmount
954 * - see the comments on shrink_dcache_for_umount() for a description of the
955 * locking
956 */
957static void shrink_dcache_for_umount_subtree(struct dentry *dentry)
958{
959 struct dentry *parent;
960
961 BUG_ON(!IS_ROOT(dentry));
962
David Howellsc636ebd2006-10-11 01:22:19 -0700963 for (;;) {
964 /* descend to the first leaf in the current subtree */
David Howells43c1c9c2011-06-07 14:09:30 +0100965 while (!list_empty(&dentry->d_subdirs))
David Howellsc636ebd2006-10-11 01:22:19 -0700966 dentry = list_entry(dentry->d_subdirs.next,
967 struct dentry, d_u.d_child);
David Howellsc636ebd2006-10-11 01:22:19 -0700968
969 /* consume the dentries from this leaf up through its parents
970 * until we find one with children or run out altogether */
971 do {
972 struct inode *inode;
973
Sage Weilf0023bc2011-10-28 10:02:42 -0700974 /*
Yan, Zheng61572bb2013-04-15 14:13:21 +0800975 * inform the fs that this dentry is about to be
Sage Weilf0023bc2011-10-28 10:02:42 -0700976 * unhashed and destroyed.
977 */
Yan, Zheng590fb512013-08-13 15:42:02 +0800978 if ((dentry->d_flags & DCACHE_OP_PRUNE) &&
979 !d_unhashed(dentry))
Yan, Zheng61572bb2013-04-15 14:13:21 +0800980 dentry->d_op->d_prune(dentry);
981
982 dentry_lru_del(dentry);
David Howells43c1c9c2011-06-07 14:09:30 +0100983 __d_shrink(dentry);
984
Waiman Long98474232013-08-28 18:24:59 -0700985 if (dentry->d_lockref.count != 0) {
David Howellsc636ebd2006-10-11 01:22:19 -0700986 printk(KERN_ERR
987 "BUG: Dentry %p{i=%lx,n=%s}"
988 " still in use (%d)"
989 " [unmount of %s %s]\n",
990 dentry,
991 dentry->d_inode ?
992 dentry->d_inode->i_ino : 0UL,
993 dentry->d_name.name,
Waiman Long98474232013-08-28 18:24:59 -0700994 dentry->d_lockref.count,
David Howellsc636ebd2006-10-11 01:22:19 -0700995 dentry->d_sb->s_type->name,
996 dentry->d_sb->s_id);
997 BUG();
998 }
999
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001000 if (IS_ROOT(dentry)) {
David Howellsc636ebd2006-10-11 01:22:19 -07001001 parent = NULL;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001002 list_del(&dentry->d_u.d_child);
1003 } else {
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09001004 parent = dentry->d_parent;
Waiman Long98474232013-08-28 18:24:59 -07001005 parent->d_lockref.count--;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001006 list_del(&dentry->d_u.d_child);
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09001007 }
David Howellsc636ebd2006-10-11 01:22:19 -07001008
David Howellsc636ebd2006-10-11 01:22:19 -07001009 inode = dentry->d_inode;
1010 if (inode) {
1011 dentry->d_inode = NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001012 hlist_del_init(&dentry->d_alias);
David Howellsc636ebd2006-10-11 01:22:19 -07001013 if (dentry->d_op && dentry->d_op->d_iput)
1014 dentry->d_op->d_iput(dentry, inode);
1015 else
1016 iput(inode);
1017 }
1018
1019 d_free(dentry);
1020
1021 /* finished when we fall off the top of the tree,
1022 * otherwise we ascend to the parent and move to the
1023 * next sibling if there is one */
1024 if (!parent)
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001025 return;
David Howellsc636ebd2006-10-11 01:22:19 -07001026 dentry = parent;
David Howellsc636ebd2006-10-11 01:22:19 -07001027 } while (list_empty(&dentry->d_subdirs));
1028
1029 dentry = list_entry(dentry->d_subdirs.next,
1030 struct dentry, d_u.d_child);
1031 }
1032}
1033
1034/*
1035 * destroy the dentries attached to a superblock on unmounting
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001036 * - we don't need to use dentry->d_lock because:
David Howellsc636ebd2006-10-11 01:22:19 -07001037 * - the superblock is detached from all mountings and open files, so the
1038 * dentry trees will not be rearranged by the VFS
1039 * - s_umount is write-locked, so the memory pressure shrinker will ignore
1040 * any dentries belonging to this superblock that it comes across
1041 * - the filesystem itself is no longer permitted to rearrange the dentries
1042 * in this superblock
1043 */
1044void shrink_dcache_for_umount(struct super_block *sb)
1045{
1046 struct dentry *dentry;
1047
1048 if (down_read_trylock(&sb->s_umount))
1049 BUG();
1050
1051 dentry = sb->s_root;
1052 sb->s_root = NULL;
Waiman Long98474232013-08-28 18:24:59 -07001053 dentry->d_lockref.count--;
David Howellsc636ebd2006-10-11 01:22:19 -07001054 shrink_dcache_for_umount_subtree(dentry);
1055
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001056 while (!hlist_bl_empty(&sb->s_anon)) {
1057 dentry = hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash);
David Howellsc636ebd2006-10-11 01:22:19 -07001058 shrink_dcache_for_umount_subtree(dentry);
1059 }
1060}
1061
1062/*
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001063 * This tries to ascend one level of parenthood, but
1064 * we can race with renaming, so we need to re-check
1065 * the parenthood after dropping the lock and check
1066 * that the sequence number still matches.
1067 */
Al Viro48f5ec22013-09-09 15:22:25 -04001068static struct dentry *try_to_ascend(struct dentry *old, unsigned seq)
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001069{
1070 struct dentry *new = old->d_parent;
1071
1072 rcu_read_lock();
1073 spin_unlock(&old->d_lock);
1074 spin_lock(&new->d_lock);
1075
1076 /*
1077 * might go back up the wrong parent if we have had a rename
1078 * or deletion
1079 */
1080 if (new != old->d_parent ||
Miklos Szeredib161dfa62012-09-17 22:31:38 +02001081 (old->d_flags & DCACHE_DENTRY_KILLED) ||
Al Viro48f5ec22013-09-09 15:22:25 -04001082 need_seqretry(&rename_lock, seq)) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001083 spin_unlock(&new->d_lock);
1084 new = NULL;
1085 }
1086 rcu_read_unlock();
1087 return new;
1088}
1089
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001091 * enum d_walk_ret - action to talke during tree walk
1092 * @D_WALK_CONTINUE: contrinue walk
1093 * @D_WALK_QUIT: quit walk
1094 * @D_WALK_NORETRY: quit when retry is needed
1095 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001097enum d_walk_ret {
1098 D_WALK_CONTINUE,
1099 D_WALK_QUIT,
1100 D_WALK_NORETRY,
1101 D_WALK_SKIP,
1102};
1103
1104/**
1105 * d_walk - walk the dentry tree
1106 * @parent: start of walk
1107 * @data: data passed to @enter() and @finish()
1108 * @enter: callback when first entering the dentry
1109 * @finish: callback when successfully finished the walk
1110 *
1111 * The @enter() and @finish() callbacks are called with d_lock held.
1112 */
1113static void d_walk(struct dentry *parent, void *data,
1114 enum d_walk_ret (*enter)(void *, struct dentry *),
1115 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116{
Nick Piggin949854d2011-01-07 17:49:37 +11001117 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001119 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001120 enum d_walk_ret ret;
1121 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001122
Nick Piggin58db63d2011-01-07 17:49:39 +11001123again:
Al Viro48f5ec22013-09-09 15:22:25 -04001124 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001125 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001126 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001127
1128 ret = enter(data, this_parent);
1129 switch (ret) {
1130 case D_WALK_CONTINUE:
1131 break;
1132 case D_WALK_QUIT:
1133 case D_WALK_SKIP:
1134 goto out_unlock;
1135 case D_WALK_NORETRY:
1136 retry = false;
1137 break;
1138 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139repeat:
1140 next = this_parent->d_subdirs.next;
1141resume:
1142 while (next != &this_parent->d_subdirs) {
1143 struct list_head *tmp = next;
Eric Dumazet5160ee62006-01-08 01:03:32 -08001144 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001146
1147 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001148
1149 ret = enter(data, dentry);
1150 switch (ret) {
1151 case D_WALK_CONTINUE:
1152 break;
1153 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001154 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001155 goto out_unlock;
1156 case D_WALK_NORETRY:
1157 retry = false;
1158 break;
1159 case D_WALK_SKIP:
1160 spin_unlock(&dentry->d_lock);
1161 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001162 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001163
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001165 spin_unlock(&this_parent->d_lock);
1166 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001168 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169 goto repeat;
1170 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001171 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 }
1173 /*
1174 * All done at this level ... ascend and resume the search.
1175 */
1176 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001177 struct dentry *child = this_parent;
Al Viro48f5ec22013-09-09 15:22:25 -04001178 this_parent = try_to_ascend(this_parent, seq);
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001179 if (!this_parent)
Nick Piggin949854d2011-01-07 17:49:37 +11001180 goto rename_retry;
Nick Piggin949854d2011-01-07 17:49:37 +11001181 next = child->d_u.d_child.next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 goto resume;
1183 }
Al Viro48f5ec22013-09-09 15:22:25 -04001184 if (need_seqretry(&rename_lock, seq)) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001185 spin_unlock(&this_parent->d_lock);
1186 goto rename_retry;
1187 }
1188 if (finish)
1189 finish(data);
1190
1191out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001192 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001193 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001194 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001195
1196rename_retry:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001197 if (!retry)
1198 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001199 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001200 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001202
1203/*
1204 * Search for at least 1 mount point in the dentry's subdirs.
1205 * We descend to the next level whenever the d_subdirs
1206 * list is non-empty and continue searching.
1207 */
1208
1209/**
1210 * have_submounts - check for mounts over a dentry
1211 * @parent: dentry to check.
1212 *
1213 * Return true if the parent or its subdirectories contain
1214 * a mount point
1215 */
1216
1217static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1218{
1219 int *ret = data;
1220 if (d_mountpoint(dentry)) {
1221 *ret = 1;
1222 return D_WALK_QUIT;
1223 }
1224 return D_WALK_CONTINUE;
1225}
1226
1227int have_submounts(struct dentry *parent)
1228{
1229 int ret = 0;
1230
1231 d_walk(parent, &ret, check_mount, NULL);
1232
1233 return ret;
1234}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001235EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236
1237/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001238 * Called by mount code to set a mountpoint and check if the mountpoint is
1239 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1240 * subtree can become unreachable).
1241 *
1242 * Only one of check_submounts_and_drop() and d_set_mounted() must succeed. For
1243 * this reason take rename_lock and d_lock on dentry and ancestors.
1244 */
1245int d_set_mounted(struct dentry *dentry)
1246{
1247 struct dentry *p;
1248 int ret = -ENOENT;
1249 write_seqlock(&rename_lock);
1250 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
1251 /* Need exclusion wrt. check_submounts_and_drop() */
1252 spin_lock(&p->d_lock);
1253 if (unlikely(d_unhashed(p))) {
1254 spin_unlock(&p->d_lock);
1255 goto out;
1256 }
1257 spin_unlock(&p->d_lock);
1258 }
1259 spin_lock(&dentry->d_lock);
1260 if (!d_unlinked(dentry)) {
1261 dentry->d_flags |= DCACHE_MOUNTED;
1262 ret = 0;
1263 }
1264 spin_unlock(&dentry->d_lock);
1265out:
1266 write_sequnlock(&rename_lock);
1267 return ret;
1268}
1269
1270/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001271 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 * and move any unused dentries to the end of the unused
1273 * list for prune_dcache(). We descend to the next level
1274 * whenever the d_subdirs list is non-empty and continue
1275 * searching.
1276 *
1277 * It returns zero iff there are no unused children,
1278 * otherwise it returns the number of children moved to
1279 * the end of the unused list. This may not be the total
1280 * number of unused children, because select_parent can
1281 * drop the lock and return early due to latency
1282 * constraints.
1283 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001284
1285struct select_data {
1286 struct dentry *start;
1287 struct list_head dispose;
1288 int found;
1289};
1290
1291static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001293 struct select_data *data = _data;
1294 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001296 if (data->start == dentry)
1297 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001299 /*
1300 * move only zero ref count dentries to the dispose list.
1301 *
1302 * Those which are presently on the shrink list, being processed
1303 * by shrink_dentry_list(), shouldn't be moved. Otherwise the
1304 * loop in shrink_dcache_parent() might not make any progress
1305 * and loop forever.
1306 */
1307 if (dentry->d_lockref.count) {
1308 dentry_lru_del(dentry);
1309 } else if (!(dentry->d_flags & DCACHE_SHRINK_LIST)) {
1310 dentry_lru_move_list(dentry, &data->dispose);
1311 dentry->d_flags |= DCACHE_SHRINK_LIST;
1312 data->found++;
1313 ret = D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 }
1315 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001316 * We can return to the caller if we have found some (this
1317 * ensures forward progress). We'll be coming back to find
1318 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001320 if (data->found && need_resched())
1321 ret = D_WALK_QUIT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001323 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324}
1325
1326/**
1327 * shrink_dcache_parent - prune dcache
1328 * @parent: parent of entries to prune
1329 *
1330 * Prune the dcache to remove unused children of the parent dentry.
1331 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001332void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001334 for (;;) {
1335 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001337 INIT_LIST_HEAD(&data.dispose);
1338 data.start = parent;
1339 data.found = 0;
1340
1341 d_walk(parent, &data, select_collect, NULL);
1342 if (!data.found)
1343 break;
1344
1345 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001346 cond_resched();
1347 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001349EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001351static enum d_walk_ret check_and_collect(void *_data, struct dentry *dentry)
1352{
1353 struct select_data *data = _data;
1354
1355 if (d_mountpoint(dentry)) {
1356 data->found = -EBUSY;
1357 return D_WALK_QUIT;
1358 }
1359
1360 return select_collect(_data, dentry);
1361}
1362
1363static void check_and_drop(void *_data)
1364{
1365 struct select_data *data = _data;
1366
1367 if (d_mountpoint(data->start))
1368 data->found = -EBUSY;
1369 if (!data->found)
1370 __d_drop(data->start);
1371}
1372
1373/**
1374 * check_submounts_and_drop - prune dcache, check for submounts and drop
1375 *
1376 * All done as a single atomic operation relative to has_unlinked_ancestor().
1377 * Returns 0 if successfully unhashed @parent. If there were submounts then
1378 * return -EBUSY.
1379 *
1380 * @dentry: dentry to prune and drop
1381 */
1382int check_submounts_and_drop(struct dentry *dentry)
1383{
1384 int ret = 0;
1385
1386 /* Negative dentries can be dropped without further checks */
1387 if (!dentry->d_inode) {
1388 d_drop(dentry);
1389 goto out;
1390 }
1391
1392 for (;;) {
1393 struct select_data data;
1394
1395 INIT_LIST_HEAD(&data.dispose);
1396 data.start = dentry;
1397 data.found = 0;
1398
1399 d_walk(dentry, &data, check_and_collect, check_and_drop);
1400 ret = data.found;
1401
1402 if (!list_empty(&data.dispose))
1403 shrink_dentry_list(&data.dispose);
1404
1405 if (ret <= 0)
1406 break;
1407
1408 cond_resched();
1409 }
1410
1411out:
1412 return ret;
1413}
1414EXPORT_SYMBOL(check_submounts_and_drop);
1415
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416/**
Al Viroa4464db2011-07-07 15:03:58 -04001417 * __d_alloc - allocate a dcache entry
1418 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 * @name: qstr of the name
1420 *
1421 * Allocates a dentry. It returns %NULL if there is insufficient memory
1422 * available. On a success the dentry is returned. The name passed in is
1423 * copied and the copy passed in may be reused after this call.
1424 */
1425
Al Viroa4464db2011-07-07 15:03:58 -04001426struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427{
1428 struct dentry *dentry;
1429 char *dname;
1430
Mel Gormane12ba742007-10-16 01:25:52 -07001431 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 if (!dentry)
1433 return NULL;
1434
Linus Torvalds6326c712012-05-21 16:14:04 -07001435 /*
1436 * We guarantee that the inline name is always NUL-terminated.
1437 * This way the memcpy() done by the name switching in rename
1438 * will still always have a NUL at the end, even if we might
1439 * be overwriting an internal NUL character
1440 */
1441 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 if (name->len > DNAME_INLINE_LEN-1) {
1443 dname = kmalloc(name->len + 1, GFP_KERNEL);
1444 if (!dname) {
1445 kmem_cache_free(dentry_cache, dentry);
1446 return NULL;
1447 }
1448 } else {
1449 dname = dentry->d_iname;
1450 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451
1452 dentry->d_name.len = name->len;
1453 dentry->d_name.hash = name->hash;
1454 memcpy(dname, name->name, name->len);
1455 dname[name->len] = 0;
1456
Linus Torvalds6326c712012-05-21 16:14:04 -07001457 /* Make sure we always see the terminating NUL character */
1458 smp_wmb();
1459 dentry->d_name.name = dname;
1460
Waiman Long98474232013-08-28 18:24:59 -07001461 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001462 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001464 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001466 dentry->d_parent = dentry;
1467 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 dentry->d_op = NULL;
1469 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001470 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 INIT_LIST_HEAD(&dentry->d_lru);
1472 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Virob3d9b7a2012-06-09 13:51:19 -04001473 INIT_HLIST_NODE(&dentry->d_alias);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001474 INIT_LIST_HEAD(&dentry->d_u.d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001475 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476
Nick Piggin3e880fb2011-01-07 17:49:19 +11001477 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001478
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479 return dentry;
1480}
Al Viroa4464db2011-07-07 15:03:58 -04001481
1482/**
1483 * d_alloc - allocate a dcache entry
1484 * @parent: parent of entry to allocate
1485 * @name: qstr of the name
1486 *
1487 * Allocates a dentry. It returns %NULL if there is insufficient memory
1488 * available. On a success the dentry is returned. The name passed in is
1489 * copied and the copy passed in may be reused after this call.
1490 */
1491struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1492{
1493 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1494 if (!dentry)
1495 return NULL;
1496
1497 spin_lock(&parent->d_lock);
1498 /*
1499 * don't need child lock because it is not subject
1500 * to concurrency here
1501 */
1502 __dget_dlock(parent);
1503 dentry->d_parent = parent;
1504 list_add(&dentry->d_u.d_child, &parent->d_subdirs);
1505 spin_unlock(&parent->d_lock);
1506
1507 return dentry;
1508}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001509EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510
Nick Piggin4b936882011-01-07 17:50:07 +11001511struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1512{
Al Viroa4464db2011-07-07 15:03:58 -04001513 struct dentry *dentry = __d_alloc(sb, name);
1514 if (dentry)
Nick Piggin4b936882011-01-07 17:50:07 +11001515 dentry->d_flags |= DCACHE_DISCONNECTED;
Nick Piggin4b936882011-01-07 17:50:07 +11001516 return dentry;
1517}
1518EXPORT_SYMBOL(d_alloc_pseudo);
1519
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1521{
1522 struct qstr q;
1523
1524 q.name = name;
1525 q.len = strlen(name);
1526 q.hash = full_name_hash(q.name, q.len);
1527 return d_alloc(parent, &q);
1528}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001529EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530
Nick Pigginfb045ad2011-01-07 17:49:55 +11001531void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1532{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001533 WARN_ON_ONCE(dentry->d_op);
1534 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001535 DCACHE_OP_COMPARE |
1536 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001537 DCACHE_OP_WEAK_REVALIDATE |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001538 DCACHE_OP_DELETE ));
1539 dentry->d_op = op;
1540 if (!op)
1541 return;
1542 if (op->d_hash)
1543 dentry->d_flags |= DCACHE_OP_HASH;
1544 if (op->d_compare)
1545 dentry->d_flags |= DCACHE_OP_COMPARE;
1546 if (op->d_revalidate)
1547 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001548 if (op->d_weak_revalidate)
1549 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001550 if (op->d_delete)
1551 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001552 if (op->d_prune)
1553 dentry->d_flags |= DCACHE_OP_PRUNE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001554
1555}
1556EXPORT_SYMBOL(d_set_d_op);
1557
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001558static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1559{
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001560 spin_lock(&dentry->d_lock);
David Howells9875cf82011-01-14 18:45:21 +00001561 if (inode) {
1562 if (unlikely(IS_AUTOMOUNT(inode)))
1563 dentry->d_flags |= DCACHE_NEED_AUTOMOUNT;
Al Virob3d9b7a2012-06-09 13:51:19 -04001564 hlist_add_head(&dentry->d_alias, &inode->i_dentry);
David Howells9875cf82011-01-14 18:45:21 +00001565 }
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001566 dentry->d_inode = inode;
Nick Piggin31e6b012011-01-07 17:49:52 +11001567 dentry_rcuwalk_barrier(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001568 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001569 fsnotify_d_instantiate(dentry, inode);
1570}
1571
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572/**
1573 * d_instantiate - fill in inode information for a dentry
1574 * @entry: dentry to complete
1575 * @inode: inode to attach to this dentry
1576 *
1577 * Fill in inode information in the entry.
1578 *
1579 * This turns negative dentries into productive full members
1580 * of society.
1581 *
1582 * NOTE! This assumes that the inode count has been incremented
1583 * (or otherwise set) by the caller to indicate that it is now
1584 * in use by the dcache.
1585 */
1586
1587void d_instantiate(struct dentry *entry, struct inode * inode)
1588{
Al Virob3d9b7a2012-06-09 13:51:19 -04001589 BUG_ON(!hlist_unhashed(&entry->d_alias));
Nick Piggin873feea2011-01-07 17:50:06 +11001590 if (inode)
1591 spin_lock(&inode->i_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001592 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001593 if (inode)
1594 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 security_d_instantiate(entry, inode);
1596}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001597EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598
1599/**
1600 * d_instantiate_unique - instantiate a non-aliased dentry
1601 * @entry: dentry to instantiate
1602 * @inode: inode to attach to this dentry
1603 *
1604 * Fill in inode information in the entry. On success, it returns NULL.
1605 * If an unhashed alias of "entry" already exists, then we return the
Oleg Drokine866cfa2006-01-09 20:52:51 -08001606 * aliased dentry instead and drop one reference to inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 *
1608 * Note that in order to avoid conflicts with rename() etc, the caller
1609 * had better be holding the parent directory semaphore.
Oleg Drokine866cfa2006-01-09 20:52:51 -08001610 *
1611 * This also assumes that the inode count has been incremented
1612 * (or otherwise set) by the caller to indicate that it is now
1613 * in use by the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 */
David Howells770bfad2006-08-22 20:06:07 -04001615static struct dentry *__d_instantiate_unique(struct dentry *entry,
1616 struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617{
1618 struct dentry *alias;
1619 int len = entry->d_name.len;
1620 const char *name = entry->d_name.name;
1621 unsigned int hash = entry->d_name.hash;
1622
David Howells770bfad2006-08-22 20:06:07 -04001623 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001624 __d_instantiate(entry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001625 return NULL;
1626 }
1627
Sasha Levinb67bfe02013-02-27 17:06:00 -08001628 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Piggin9abca362011-01-07 17:49:36 +11001629 /*
1630 * Don't need alias->d_lock here, because aliases with
1631 * d_parent == entry->d_parent are not subject to name or
1632 * parent changes, because the parent inode i_mutex is held.
1633 */
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001634 if (alias->d_name.hash != hash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 continue;
1636 if (alias->d_parent != entry->d_parent)
1637 continue;
Linus Torvaldsee983e82012-05-10 12:37:10 -07001638 if (alias->d_name.len != len)
1639 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001640 if (dentry_cmp(alias, name, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 continue;
Nick Piggindc0474b2011-01-07 17:49:43 +11001642 __dget(alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 return alias;
1644 }
David Howells770bfad2006-08-22 20:06:07 -04001645
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001646 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 return NULL;
1648}
David Howells770bfad2006-08-22 20:06:07 -04001649
1650struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1651{
1652 struct dentry *result;
1653
Al Virob3d9b7a2012-06-09 13:51:19 -04001654 BUG_ON(!hlist_unhashed(&entry->d_alias));
David Howells770bfad2006-08-22 20:06:07 -04001655
Nick Piggin873feea2011-01-07 17:50:06 +11001656 if (inode)
1657 spin_lock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001658 result = __d_instantiate_unique(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001659 if (inode)
1660 spin_unlock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001661
1662 if (!result) {
1663 security_d_instantiate(entry, inode);
1664 return NULL;
1665 }
1666
1667 BUG_ON(!d_unhashed(result));
1668 iput(inode);
1669 return result;
1670}
1671
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672EXPORT_SYMBOL(d_instantiate_unique);
1673
Al Viroadc0e912012-01-08 16:49:21 -05001674struct dentry *d_make_root(struct inode *root_inode)
1675{
1676 struct dentry *res = NULL;
1677
1678 if (root_inode) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07001679 static const struct qstr name = QSTR_INIT("/", 1);
Al Viroadc0e912012-01-08 16:49:21 -05001680
1681 res = __d_alloc(root_inode->i_sb, &name);
1682 if (res)
1683 d_instantiate(res, root_inode);
1684 else
1685 iput(root_inode);
1686 }
1687 return res;
1688}
1689EXPORT_SYMBOL(d_make_root);
1690
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001691static struct dentry * __d_find_any_alias(struct inode *inode)
1692{
1693 struct dentry *alias;
1694
Al Virob3d9b7a2012-06-09 13:51:19 -04001695 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001696 return NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001697 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001698 __dget(alias);
1699 return alias;
1700}
1701
Sage Weil46f72b32012-01-10 09:04:37 -08001702/**
1703 * d_find_any_alias - find any alias for a given inode
1704 * @inode: inode to find an alias for
1705 *
1706 * If any aliases exist for the given inode, take and return a
1707 * reference for one of them. If no aliases exist, return %NULL.
1708 */
1709struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001710{
1711 struct dentry *de;
1712
1713 spin_lock(&inode->i_lock);
1714 de = __d_find_any_alias(inode);
1715 spin_unlock(&inode->i_lock);
1716 return de;
1717}
Sage Weil46f72b32012-01-10 09:04:37 -08001718EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001719
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720/**
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001721 * d_obtain_alias - find or allocate a dentry for a given inode
1722 * @inode: inode to allocate the dentry for
1723 *
1724 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1725 * similar open by handle operations. The returned dentry may be anonymous,
1726 * or may have a full name (if the inode was already in the cache).
1727 *
1728 * When called on a directory inode, we must ensure that the inode only ever
1729 * has one dentry. If a dentry is found, that is returned instead of
1730 * allocating a new one.
1731 *
1732 * On successful return, the reference to the inode has been transferred
Christoph Hellwig44003722008-08-11 15:49:04 +02001733 * to the dentry. In case of an error the reference on the inode is released.
1734 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1735 * be passed in and will be the error will be propagate to the return value,
1736 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001737 */
1738struct dentry *d_obtain_alias(struct inode *inode)
1739{
NeilBrownb911a6b2012-11-08 16:09:37 -08001740 static const struct qstr anonstring = QSTR_INIT("/", 1);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001741 struct dentry *tmp;
1742 struct dentry *res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001743
1744 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001745 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001746 if (IS_ERR(inode))
1747 return ERR_CAST(inode);
1748
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001749 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001750 if (res)
1751 goto out_iput;
1752
Al Viroa4464db2011-07-07 15:03:58 -04001753 tmp = __d_alloc(inode->i_sb, &anonstring);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001754 if (!tmp) {
1755 res = ERR_PTR(-ENOMEM);
1756 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001757 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001758
Nick Piggin873feea2011-01-07 17:50:06 +11001759 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001760 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001761 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001762 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001763 dput(tmp);
1764 goto out_iput;
1765 }
1766
1767 /* attach a disconnected dentry */
1768 spin_lock(&tmp->d_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001769 tmp->d_inode = inode;
1770 tmp->d_flags |= DCACHE_DISCONNECTED;
Al Virob3d9b7a2012-06-09 13:51:19 -04001771 hlist_add_head(&tmp->d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001772 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001773 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001774 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001775 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001776 spin_unlock(&inode->i_lock);
Josef Bacik24ff6662010-11-18 20:52:55 -05001777 security_d_instantiate(tmp, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001778
Christoph Hellwig9308a612008-08-11 15:49:12 +02001779 return tmp;
1780
1781 out_iput:
Josef Bacik24ff6662010-11-18 20:52:55 -05001782 if (res && !IS_ERR(res))
1783 security_d_instantiate(res, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001784 iput(inode);
1785 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001786}
Benny Halevyadc48722009-02-27 14:02:59 -08001787EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788
1789/**
1790 * d_splice_alias - splice a disconnected dentry into the tree if one exists
1791 * @inode: the inode which may have a disconnected dentry
1792 * @dentry: a negative dentry which we want to point to the inode.
1793 *
1794 * If inode is a directory and has a 'disconnected' dentry (i.e. IS_ROOT and
1795 * DCACHE_DISCONNECTED), then d_move that in place of the given dentry
1796 * and return it, else simply d_add the inode to the dentry and return NULL.
1797 *
1798 * This is needed in the lookup routine of any filesystem that is exportable
1799 * (via knfsd) so that we can build dcache paths to directories effectively.
1800 *
1801 * If a dentry was found and moved, then it is returned. Otherwise NULL
1802 * is returned. This matches the expected return value of ->lookup.
1803 *
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001804 * Cluster filesystems may call this function with a negative, hashed dentry.
1805 * In that case, we know that the inode will be a regular file, and also this
1806 * will only occur during atomic_open. So we need to check for the dentry
1807 * being already hashed only in the final case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 */
1809struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
1810{
1811 struct dentry *new = NULL;
1812
Al Viroa9049372011-07-08 21:20:11 -04001813 if (IS_ERR(inode))
1814 return ERR_CAST(inode);
1815
NeilBrown21c0d8f2006-10-04 02:16:16 -07001816 if (inode && S_ISDIR(inode->i_mode)) {
Nick Piggin873feea2011-01-07 17:50:06 +11001817 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001818 new = __d_find_alias(inode, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 if (new) {
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001820 BUG_ON(!(new->d_flags & DCACHE_DISCONNECTED));
Nick Piggin873feea2011-01-07 17:50:06 +11001821 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 security_d_instantiate(new, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 d_move(new, dentry);
1824 iput(inode);
1825 } else {
Nick Piggin873feea2011-01-07 17:50:06 +11001826 /* already taking inode->i_lock, so d_add() by hand */
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001827 __d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001828 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 security_d_instantiate(dentry, inode);
1830 d_rehash(dentry);
1831 }
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001832 } else {
1833 d_instantiate(dentry, inode);
1834 if (d_unhashed(dentry))
1835 d_rehash(dentry);
1836 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 return new;
1838}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001839EXPORT_SYMBOL(d_splice_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840
Barry Naujok94035402008-05-21 16:50:46 +10001841/**
1842 * d_add_ci - lookup or allocate new dentry with case-exact name
1843 * @inode: the inode case-insensitive lookup has found
1844 * @dentry: the negative dentry that was passed to the parent's lookup func
1845 * @name: the case-exact name to be associated with the returned dentry
1846 *
1847 * This is to avoid filling the dcache with case-insensitive names to the
1848 * same inode, only the actual correct case is stored in the dcache for
1849 * case-insensitive filesystems.
1850 *
1851 * For a case-insensitive lookup match and if the the case-exact dentry
1852 * already exists in in the dcache, use it and return it.
1853 *
1854 * If no entry exists with the exact case name, allocate new dentry with
1855 * the exact case, and return the spliced entry.
1856 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001857struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001858 struct qstr *name)
1859{
Barry Naujok94035402008-05-21 16:50:46 +10001860 struct dentry *found;
1861 struct dentry *new;
1862
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001863 /*
1864 * First check if a dentry matching the name already exists,
1865 * if not go ahead and create it now.
1866 */
Barry Naujok94035402008-05-21 16:50:46 +10001867 found = d_hash_and_lookup(dentry->d_parent, name);
Al Viro4f522a22013-02-11 23:20:37 -05001868 if (unlikely(IS_ERR(found)))
1869 goto err_out;
Barry Naujok94035402008-05-21 16:50:46 +10001870 if (!found) {
1871 new = d_alloc(dentry->d_parent, name);
1872 if (!new) {
Al Viro4f522a22013-02-11 23:20:37 -05001873 found = ERR_PTR(-ENOMEM);
Barry Naujok94035402008-05-21 16:50:46 +10001874 goto err_out;
1875 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001876
Barry Naujok94035402008-05-21 16:50:46 +10001877 found = d_splice_alias(inode, new);
1878 if (found) {
1879 dput(new);
1880 return found;
1881 }
1882 return new;
1883 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001884
1885 /*
1886 * If a matching dentry exists, and it's not negative use it.
1887 *
1888 * Decrement the reference count to balance the iget() done
1889 * earlier on.
1890 */
Barry Naujok94035402008-05-21 16:50:46 +10001891 if (found->d_inode) {
1892 if (unlikely(found->d_inode != inode)) {
1893 /* This can't happen because bad inodes are unhashed. */
1894 BUG_ON(!is_bad_inode(inode));
1895 BUG_ON(!is_bad_inode(found->d_inode));
1896 }
Barry Naujok94035402008-05-21 16:50:46 +10001897 iput(inode);
1898 return found;
1899 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001900
Barry Naujok94035402008-05-21 16:50:46 +10001901 /*
1902 * Negative dentry: instantiate it unless the inode is a directory and
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001903 * already has a dentry.
Barry Naujok94035402008-05-21 16:50:46 +10001904 */
Al Viro4513d892011-07-17 10:52:14 -04001905 new = d_splice_alias(inode, found);
1906 if (new) {
1907 dput(found);
1908 found = new;
Barry Naujok94035402008-05-21 16:50:46 +10001909 }
Al Viro4513d892011-07-17 10:52:14 -04001910 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001911
1912err_out:
1913 iput(inode);
Al Viro4f522a22013-02-11 23:20:37 -05001914 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001915}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001916EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001918/*
1919 * Do the slow-case of the dentry name compare.
1920 *
1921 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07001922 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001923 * filesystem can rely on them, and can use the 'name' and
1924 * 'len' information without worrying about walking off the
1925 * end of memory etc.
1926 *
1927 * Thus the read_seqcount_retry() and the "duplicate" info
1928 * in arguments (the low-level filesystem should not look
1929 * at the dentry inode or name contents directly, since
1930 * rename can change them while we're in RCU mode).
1931 */
1932enum slow_d_compare {
1933 D_COMP_OK,
1934 D_COMP_NOMATCH,
1935 D_COMP_SEQRETRY,
1936};
1937
1938static noinline enum slow_d_compare slow_dentry_cmp(
1939 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001940 struct dentry *dentry,
1941 unsigned int seq,
1942 const struct qstr *name)
1943{
1944 int tlen = dentry->d_name.len;
1945 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001946
1947 if (read_seqcount_retry(&dentry->d_seq, seq)) {
1948 cpu_relax();
1949 return D_COMP_SEQRETRY;
1950 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07001951 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001952 return D_COMP_NOMATCH;
1953 return D_COMP_OK;
1954}
1955
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956/**
Nick Piggin31e6b012011-01-07 17:49:52 +11001957 * __d_lookup_rcu - search for a dentry (racy, store-free)
1958 * @parent: parent dentry
1959 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07001960 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11001961 * Returns: dentry, or NULL
1962 *
1963 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
1964 * resolution (store-free path walking) design described in
1965 * Documentation/filesystems/path-lookup.txt.
1966 *
1967 * This is not to be used outside core vfs.
1968 *
1969 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
1970 * held, and rcu_read_lock held. The returned dentry must not be stored into
1971 * without taking d_lock and checking d_seq sequence count against @seq
1972 * returned here.
1973 *
Linus Torvalds15570082013-09-02 11:38:06 -07001974 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11001975 * function.
1976 *
1977 * Alternatively, __d_lookup_rcu may be called again to look up the child of
1978 * the returned dentry, so long as its parent's seqlock is checked after the
1979 * child is looked up. Thus, an interlocking stepping of sequence lock checks
1980 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001981 *
1982 * NOTE! The caller *has* to check the resulting dentry against the sequence
1983 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11001984 */
Linus Torvalds8966be92012-03-02 14:23:30 -08001985struct dentry *__d_lookup_rcu(const struct dentry *parent,
1986 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07001987 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11001988{
Linus Torvalds26fe5752012-05-10 13:14:12 -07001989 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11001990 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07001991 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001992 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11001993 struct dentry *dentry;
1994
1995 /*
1996 * Note: There is significant duplication with __d_lookup_rcu which is
1997 * required to prevent single threaded performance regressions
1998 * especially on architectures where smp_rmb (in seqcounts) are costly.
1999 * Keep the two functions in sync.
2000 */
2001
2002 /*
2003 * The hash list is protected using RCU.
2004 *
2005 * Carefully use d_seq when comparing a candidate dentry, to avoid
2006 * races with d_move().
2007 *
2008 * It is possible that concurrent renames can mess up our list
2009 * walk here and result in missing our dentry, resulting in the
2010 * false-negative result. d_lookup() protects against concurrent
2011 * renames using rename_lock seqlock.
2012 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002013 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002014 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002015 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002016 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002017
Nick Piggin31e6b012011-01-07 17:49:52 +11002018seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002019 /*
2020 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002021 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002022 *
2023 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002024 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002025 *
2026 * NOTE! We do a "raw" seqcount_begin here. That means that
2027 * we don't wait for the sequence count to stabilize if it
2028 * is in the middle of a sequence change. If we do the slow
2029 * dentry compare, we will do seqretries until it is stable,
2030 * and if we end up with a successful lookup, we actually
2031 * want to exit RCU lookup anyway.
2032 */
2033 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002034 if (dentry->d_parent != parent)
2035 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002036 if (d_unhashed(dentry))
2037 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002038
2039 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002040 if (dentry->d_name.hash != hashlen_hash(hashlen))
2041 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002042 *seqp = seq;
2043 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002044 case D_COMP_OK:
2045 return dentry;
2046 case D_COMP_NOMATCH:
2047 continue;
2048 default:
2049 goto seqretry;
2050 }
2051 }
2052
Linus Torvalds26fe5752012-05-10 13:14:12 -07002053 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002054 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002055 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002056 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002057 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002058 }
2059 return NULL;
2060}
2061
2062/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063 * d_lookup - search for a dentry
2064 * @parent: parent dentry
2065 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002066 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002068 * d_lookup searches the children of the parent dentry for the name in
2069 * question. If the dentry is found its reference count is incremented and the
2070 * dentry is returned. The caller must use dput to free the entry when it has
2071 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072 */
Al Viroda2d8452013-01-24 18:29:34 -05002073struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074{
Nick Piggin31e6b012011-01-07 17:49:52 +11002075 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002076 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077
2078 do {
2079 seq = read_seqbegin(&rename_lock);
2080 dentry = __d_lookup(parent, name);
2081 if (dentry)
2082 break;
2083 } while (read_seqretry(&rename_lock, seq));
2084 return dentry;
2085}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002086EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087
Nick Piggin31e6b012011-01-07 17:49:52 +11002088/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002089 * __d_lookup - search for a dentry (racy)
2090 * @parent: parent dentry
2091 * @name: qstr of name we wish to find
2092 * Returns: dentry, or NULL
2093 *
2094 * __d_lookup is like d_lookup, however it may (rarely) return a
2095 * false-negative result due to unrelated rename activity.
2096 *
2097 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2098 * however it must be used carefully, eg. with a following d_lookup in
2099 * the case of failure.
2100 *
2101 * __d_lookup callers must be commented.
2102 */
Al Viroa713ca22013-01-24 18:27:00 -05002103struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104{
2105 unsigned int len = name->len;
2106 unsigned int hash = name->hash;
2107 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002108 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002109 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002110 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002111 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112
Nick Pigginb04f7842010-08-18 04:37:34 +10002113 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002114 * Note: There is significant duplication with __d_lookup_rcu which is
2115 * required to prevent single threaded performance regressions
2116 * especially on architectures where smp_rmb (in seqcounts) are costly.
2117 * Keep the two functions in sync.
2118 */
2119
2120 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002121 * The hash list is protected using RCU.
2122 *
2123 * Take d_lock when comparing a candidate dentry, to avoid races
2124 * with d_move().
2125 *
2126 * It is possible that concurrent renames can mess up our list
2127 * walk here and result in missing our dentry, resulting in the
2128 * false-negative result. d_lookup() protects against concurrent
2129 * renames using rename_lock seqlock.
2130 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002131 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002132 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 rcu_read_lock();
2134
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002135 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 if (dentry->d_name.hash != hash)
2138 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139
2140 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 if (dentry->d_parent != parent)
2142 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002143 if (d_unhashed(dentry))
2144 goto next;
2145
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 /*
2147 * It is safe to compare names since d_move() cannot
2148 * change the qstr (protected by d_lock).
2149 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002150 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002151 int tlen = dentry->d_name.len;
2152 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002153 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 goto next;
2155 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002156 if (dentry->d_name.len != len)
2157 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002158 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159 goto next;
2160 }
2161
Waiman Long98474232013-08-28 18:24:59 -07002162 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002163 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 spin_unlock(&dentry->d_lock);
2165 break;
2166next:
2167 spin_unlock(&dentry->d_lock);
2168 }
2169 rcu_read_unlock();
2170
2171 return found;
2172}
2173
2174/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002175 * d_hash_and_lookup - hash the qstr then search for a dentry
2176 * @dir: Directory to search in
2177 * @name: qstr of name we wish to find
2178 *
Al Viro4f522a22013-02-11 23:20:37 -05002179 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002180 */
2181struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2182{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002183 /*
2184 * Check for a fs-specific hash function. Note that we must
2185 * calculate the standard hash first, as the d_op->d_hash()
2186 * routine may choose to leave the hash value unchanged.
2187 */
2188 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002189 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002190 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002191 if (unlikely(err < 0))
2192 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002193 }
Al Viro4f522a22013-02-11 23:20:37 -05002194 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002195}
Al Viro4f522a22013-02-11 23:20:37 -05002196EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002197
2198/**
Nick Piggin786a5e12011-01-07 17:49:16 +11002199 * d_validate - verify dentry provided from insecure source (deprecated)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 * @dentry: The dentry alleged to be valid child of @dparent
Randy Dunlapff5fdb62011-01-22 20:16:06 -08002201 * @dparent: The parent dentry (known to be valid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202 *
2203 * An insecure source has sent us a dentry, here we verify it and dget() it.
2204 * This is used by ncpfs in its readdir implementation.
2205 * Zero is returned in the dentry is invalid.
Nick Piggin786a5e12011-01-07 17:49:16 +11002206 *
2207 * This function is slow for big directories, and deprecated, do not use it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 */
Nick Piggind3a23e12011-01-05 20:01:21 +11002209int d_validate(struct dentry *dentry, struct dentry *dparent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210{
Nick Piggin786a5e12011-01-07 17:49:16 +11002211 struct dentry *child;
Nick Piggind3a23e12011-01-05 20:01:21 +11002212
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002213 spin_lock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002214 list_for_each_entry(child, &dparent->d_subdirs, d_u.d_child) {
2215 if (dentry == child) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002216 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Nick Piggindc0474b2011-01-07 17:49:43 +11002217 __dget_dlock(dentry);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002218 spin_unlock(&dentry->d_lock);
2219 spin_unlock(&dparent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 return 1;
2221 }
2222 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002223 spin_unlock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002224
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225 return 0;
2226}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002227EXPORT_SYMBOL(d_validate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228
2229/*
2230 * When a file is deleted, we have two options:
2231 * - turn this dentry into a negative dentry
2232 * - unhash this dentry and free it.
2233 *
2234 * Usually, we want to just turn this into
2235 * a negative dentry, but if anybody else is
2236 * currently using the dentry or the inode
2237 * we can't do that and we fall back on removing
2238 * it from the hash queues and waiting for
2239 * it to be deleted later when it has no users
2240 */
2241
2242/**
2243 * d_delete - delete a dentry
2244 * @dentry: The dentry to delete
2245 *
2246 * Turn the dentry into a negative dentry if possible, otherwise
2247 * remove it from the hash queues so it can be deleted later
2248 */
2249
2250void d_delete(struct dentry * dentry)
2251{
Nick Piggin873feea2011-01-07 17:50:06 +11002252 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002253 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 /*
2255 * Are we the only user?
2256 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002257again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002259 inode = dentry->d_inode;
2260 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002261 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002262 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002263 spin_unlock(&dentry->d_lock);
2264 cpu_relax();
2265 goto again;
2266 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002267 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002268 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002269 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270 return;
2271 }
2272
2273 if (!d_unhashed(dentry))
2274 __d_drop(dentry);
2275
2276 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002277
2278 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002280EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002282static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002284 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002285 hlist_bl_lock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -07002286 entry->d_flags |= DCACHE_RCUACCESS;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002287 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002288 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289}
2290
David Howells770bfad2006-08-22 20:06:07 -04002291static void _d_rehash(struct dentry * entry)
2292{
2293 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2294}
2295
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296/**
2297 * d_rehash - add an entry back to the hash
2298 * @entry: dentry to add to the hash
2299 *
2300 * Adds a dentry to the hash according to its name.
2301 */
2302
2303void d_rehash(struct dentry * entry)
2304{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002306 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002309EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002311/**
2312 * dentry_update_name_case - update case insensitive dentry with a new name
2313 * @dentry: dentry to be updated
2314 * @name: new name
2315 *
2316 * Update a case insensitive dentry with new case of name.
2317 *
2318 * dentry must have been returned by d_lookup with name @name. Old and new
2319 * name lengths must match (ie. no d_compare which allows mismatched name
2320 * lengths).
2321 *
2322 * Parent inode i_mutex must be held over d_lookup and into this call (to
2323 * keep renames and concurrent inserts, and readdir(2) away).
2324 */
2325void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2326{
Linus Torvalds7ebfa572011-04-15 07:34:26 -07002327 BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002328 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2329
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002330 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002331 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002332 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002333 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002334 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002335}
2336EXPORT_SYMBOL(dentry_update_name_case);
2337
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338static void switch_names(struct dentry *dentry, struct dentry *target)
2339{
2340 if (dname_external(target)) {
2341 if (dname_external(dentry)) {
2342 /*
2343 * Both external: swap the pointers
2344 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002345 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346 } else {
2347 /*
2348 * dentry:internal, target:external. Steal target's
2349 * storage and make target internal.
2350 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002351 memcpy(target->d_iname, dentry->d_name.name,
2352 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353 dentry->d_name.name = target->d_name.name;
2354 target->d_name.name = target->d_iname;
2355 }
2356 } else {
2357 if (dname_external(dentry)) {
2358 /*
2359 * dentry:external, target:internal. Give dentry's
2360 * storage to target and make dentry internal
2361 */
2362 memcpy(dentry->d_iname, target->d_name.name,
2363 target->d_name.len + 1);
2364 target->d_name.name = dentry->d_name.name;
2365 dentry->d_name.name = dentry->d_iname;
2366 } else {
2367 /*
2368 * Both are internal. Just copy target to dentry
2369 */
2370 memcpy(dentry->d_iname, target->d_name.name,
2371 target->d_name.len + 1);
Al Virodc711ca2008-11-03 15:03:50 -05002372 dentry->d_name.len = target->d_name.len;
2373 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 }
2375 }
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002376 swap(dentry->d_name.len, target->d_name.len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377}
2378
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002379static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2380{
2381 /*
2382 * XXXX: do we really need to take target->d_lock?
2383 */
2384 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2385 spin_lock(&target->d_parent->d_lock);
2386 else {
2387 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2388 spin_lock(&dentry->d_parent->d_lock);
2389 spin_lock_nested(&target->d_parent->d_lock,
2390 DENTRY_D_LOCK_NESTED);
2391 } else {
2392 spin_lock(&target->d_parent->d_lock);
2393 spin_lock_nested(&dentry->d_parent->d_lock,
2394 DENTRY_D_LOCK_NESTED);
2395 }
2396 }
2397 if (target < dentry) {
2398 spin_lock_nested(&target->d_lock, 2);
2399 spin_lock_nested(&dentry->d_lock, 3);
2400 } else {
2401 spin_lock_nested(&dentry->d_lock, 2);
2402 spin_lock_nested(&target->d_lock, 3);
2403 }
2404}
2405
2406static void dentry_unlock_parents_for_move(struct dentry *dentry,
2407 struct dentry *target)
2408{
2409 if (target->d_parent != dentry->d_parent)
2410 spin_unlock(&dentry->d_parent->d_lock);
2411 if (target->d_parent != target)
2412 spin_unlock(&target->d_parent->d_lock);
2413}
2414
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002416 * When switching names, the actual string doesn't strictly have to
2417 * be preserved in the target - because we're dropping the target
2418 * anyway. As such, we can just do a simple memcpy() to copy over
2419 * the new name before we switch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002420 *
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002421 * Note that we have to be a lot more careful about getting the hash
2422 * switched - we have to switch the hash value properly even if it
2423 * then no longer matches the actual (corrupted) string of the target.
2424 * The hash value has to match the hash queue that the dentry is on..
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002426/*
Al Viro18367502011-07-12 21:42:24 -04002427 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428 * @dentry: entry to move
2429 * @target: new dentry
2430 *
2431 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002432 * dcache entries should not be moved in this way. Caller must hold
2433 * rename_lock, the i_mutex of the source and target directories,
2434 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002435 */
Al Viro18367502011-07-12 21:42:24 -04002436static void __d_move(struct dentry * dentry, struct dentry * target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002437{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 if (!dentry->d_inode)
2439 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2440
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002441 BUG_ON(d_ancestor(dentry, target));
2442 BUG_ON(d_ancestor(target, dentry));
2443
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002444 dentry_lock_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445
Nick Piggin31e6b012011-01-07 17:49:52 +11002446 write_seqcount_begin(&dentry->d_seq);
2447 write_seqcount_begin(&target->d_seq);
2448
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002449 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2450
2451 /*
2452 * Move the dentry to the target hash queue. Don't bother checking
2453 * for the same hash queue because of how unlikely it is.
2454 */
2455 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002456 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457
2458 /* Unhash the target: dput() will then get rid of it */
2459 __d_drop(target);
2460
Eric Dumazet5160ee62006-01-08 01:03:32 -08002461 list_del(&dentry->d_u.d_child);
2462 list_del(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463
2464 /* Switch the names.. */
2465 switch_names(dentry, target);
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002466 swap(dentry->d_name.hash, target->d_name.hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467
2468 /* ... and switch the parents */
2469 if (IS_ROOT(dentry)) {
2470 dentry->d_parent = target->d_parent;
2471 target->d_parent = target;
Eric Dumazet5160ee62006-01-08 01:03:32 -08002472 INIT_LIST_HEAD(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002473 } else {
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002474 swap(dentry->d_parent, target->d_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475
2476 /* And add them back to the (new) parent lists */
Eric Dumazet5160ee62006-01-08 01:03:32 -08002477 list_add(&target->d_u.d_child, &target->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478 }
2479
Eric Dumazet5160ee62006-01-08 01:03:32 -08002480 list_add(&dentry->d_u.d_child, &dentry->d_parent->d_subdirs);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002481
Nick Piggin31e6b012011-01-07 17:49:52 +11002482 write_seqcount_end(&target->d_seq);
2483 write_seqcount_end(&dentry->d_seq);
2484
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002485 dentry_unlock_parents_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486 spin_unlock(&target->d_lock);
Nick Pigginc32ccd82006-03-25 03:07:09 -08002487 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002489}
2490
2491/*
2492 * d_move - move a dentry
2493 * @dentry: entry to move
2494 * @target: new dentry
2495 *
2496 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002497 * dcache entries should not be moved in this way. See the locking
2498 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002499 */
2500void d_move(struct dentry *dentry, struct dentry *target)
2501{
2502 write_seqlock(&rename_lock);
2503 __d_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002505}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002506EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002508/**
2509 * d_ancestor - search for an ancestor
2510 * @p1: ancestor dentry
2511 * @p2: child dentry
2512 *
2513 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2514 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002515 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002516struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002517{
2518 struct dentry *p;
2519
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002520 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002521 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002522 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002523 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002524 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002525}
2526
2527/*
2528 * This helper attempts to cope with remotely renamed directories
2529 *
2530 * It assumes that the caller is already holding
Al Viro18367502011-07-12 21:42:24 -04002531 * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002532 *
2533 * Note: If ever the locking in lock_rename() changes, then please
2534 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002535 */
Nick Piggin873feea2011-01-07 17:50:06 +11002536static struct dentry *__d_unalias(struct inode *inode,
2537 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002538{
2539 struct mutex *m1 = NULL, *m2 = NULL;
Al Viroee3efa92012-06-08 15:59:33 -04002540 struct dentry *ret = ERR_PTR(-EBUSY);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002541
2542 /* If alias and dentry share a parent, then no extra locks required */
2543 if (alias->d_parent == dentry->d_parent)
2544 goto out_unalias;
2545
Trond Myklebust9eaef272006-10-21 10:24:20 -07002546 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002547 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2548 goto out_err;
2549 m1 = &dentry->d_sb->s_vfs_rename_mutex;
2550 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
2551 goto out_err;
2552 m2 = &alias->d_parent->d_inode->i_mutex;
2553out_unalias:
Al Viroee3efa92012-06-08 15:59:33 -04002554 if (likely(!d_mountpoint(alias))) {
2555 __d_move(alias, dentry);
2556 ret = alias;
2557 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002558out_err:
Nick Piggin873feea2011-01-07 17:50:06 +11002559 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002560 if (m2)
2561 mutex_unlock(m2);
2562 if (m1)
2563 mutex_unlock(m1);
2564 return ret;
2565}
2566
2567/*
David Howells770bfad2006-08-22 20:06:07 -04002568 * Prepare an anonymous dentry for life in the superblock's dentry tree as a
2569 * named dentry in place of the dentry to be replaced.
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002570 * returns with anon->d_lock held!
David Howells770bfad2006-08-22 20:06:07 -04002571 */
2572static void __d_materialise_dentry(struct dentry *dentry, struct dentry *anon)
2573{
Al Viro740da422013-01-30 10:13:38 -05002574 struct dentry *dparent;
David Howells770bfad2006-08-22 20:06:07 -04002575
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002576 dentry_lock_for_move(anon, dentry);
David Howells770bfad2006-08-22 20:06:07 -04002577
Nick Piggin31e6b012011-01-07 17:49:52 +11002578 write_seqcount_begin(&dentry->d_seq);
2579 write_seqcount_begin(&anon->d_seq);
2580
David Howells770bfad2006-08-22 20:06:07 -04002581 dparent = dentry->d_parent;
David Howells770bfad2006-08-22 20:06:07 -04002582
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002583 switch_names(dentry, anon);
2584 swap(dentry->d_name.hash, anon->d_name.hash);
2585
Al Viro740da422013-01-30 10:13:38 -05002586 dentry->d_parent = dentry;
2587 list_del_init(&dentry->d_u.d_child);
2588 anon->d_parent = dparent;
Wei Yongjun9ed53b12013-03-12 00:10:50 +08002589 list_move(&anon->d_u.d_child, &dparent->d_subdirs);
David Howells770bfad2006-08-22 20:06:07 -04002590
Nick Piggin31e6b012011-01-07 17:49:52 +11002591 write_seqcount_end(&dentry->d_seq);
2592 write_seqcount_end(&anon->d_seq);
2593
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002594 dentry_unlock_parents_for_move(anon, dentry);
2595 spin_unlock(&dentry->d_lock);
2596
2597 /* anon->d_lock still locked, returns locked */
David Howells770bfad2006-08-22 20:06:07 -04002598 anon->d_flags &= ~DCACHE_DISCONNECTED;
2599}
2600
2601/**
2602 * d_materialise_unique - introduce an inode into the tree
2603 * @dentry: candidate dentry
2604 * @inode: inode to bind to the dentry, to which aliases may be attached
2605 *
2606 * Introduces an dentry into the tree, substituting an extant disconnected
Jeff Laytonc46c8872011-07-26 13:33:16 -04002607 * root directory alias in its place if there is one. Caller must hold the
2608 * i_mutex of the parent directory.
David Howells770bfad2006-08-22 20:06:07 -04002609 */
2610struct dentry *d_materialise_unique(struct dentry *dentry, struct inode *inode)
2611{
Trond Myklebust9eaef272006-10-21 10:24:20 -07002612 struct dentry *actual;
David Howells770bfad2006-08-22 20:06:07 -04002613
2614 BUG_ON(!d_unhashed(dentry));
2615
David Howells770bfad2006-08-22 20:06:07 -04002616 if (!inode) {
2617 actual = dentry;
OGAWA Hirofumi360da902008-10-16 07:50:28 +09002618 __d_instantiate(dentry, NULL);
Nick Piggin357f8e62011-01-07 17:49:42 +11002619 d_rehash(actual);
2620 goto out_nolock;
David Howells770bfad2006-08-22 20:06:07 -04002621 }
2622
Nick Piggin873feea2011-01-07 17:50:06 +11002623 spin_lock(&inode->i_lock);
Nick Piggin357f8e62011-01-07 17:49:42 +11002624
Trond Myklebust9eaef272006-10-21 10:24:20 -07002625 if (S_ISDIR(inode->i_mode)) {
2626 struct dentry *alias;
David Howells770bfad2006-08-22 20:06:07 -04002627
Trond Myklebust9eaef272006-10-21 10:24:20 -07002628 /* Does an aliased dentry already exist? */
Linus Torvalds32ba9c32012-06-08 10:34:03 -07002629 alias = __d_find_alias(inode, 0);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002630 if (alias) {
2631 actual = alias;
Al Viro18367502011-07-12 21:42:24 -04002632 write_seqlock(&rename_lock);
2633
2634 if (d_ancestor(alias, dentry)) {
2635 /* Check for loops */
2636 actual = ERR_PTR(-ELOOP);
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002637 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002638 } else if (IS_ROOT(alias)) {
2639 /* Is this an anonymous mountpoint that we
2640 * could splice into our tree? */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002641 __d_materialise_dentry(dentry, alias);
Al Viro18367502011-07-12 21:42:24 -04002642 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002643 __d_drop(alias);
2644 goto found;
Al Viro18367502011-07-12 21:42:24 -04002645 } else {
2646 /* Nope, but we must(!) avoid directory
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002647 * aliasing. This drops inode->i_lock */
Al Viro18367502011-07-12 21:42:24 -04002648 actual = __d_unalias(inode, dentry, alias);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002649 }
Al Viro18367502011-07-12 21:42:24 -04002650 write_sequnlock(&rename_lock);
David Howellsdd179942011-08-16 15:31:30 +01002651 if (IS_ERR(actual)) {
2652 if (PTR_ERR(actual) == -ELOOP)
2653 pr_warn_ratelimited(
2654 "VFS: Lookup of '%s' in %s %s"
2655 " would have caused loop\n",
2656 dentry->d_name.name,
2657 inode->i_sb->s_type->name,
2658 inode->i_sb->s_id);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002659 dput(alias);
David Howellsdd179942011-08-16 15:31:30 +01002660 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002661 goto out_nolock;
2662 }
David Howells770bfad2006-08-22 20:06:07 -04002663 }
2664
2665 /* Add a unique reference */
2666 actual = __d_instantiate_unique(dentry, inode);
2667 if (!actual)
2668 actual = dentry;
Nick Piggin357f8e62011-01-07 17:49:42 +11002669 else
2670 BUG_ON(!d_unhashed(actual));
David Howells770bfad2006-08-22 20:06:07 -04002671
David Howells770bfad2006-08-22 20:06:07 -04002672 spin_lock(&actual->d_lock);
2673found:
2674 _d_rehash(actual);
2675 spin_unlock(&actual->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002676 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002677out_nolock:
David Howells770bfad2006-08-22 20:06:07 -04002678 if (actual == dentry) {
2679 security_d_instantiate(dentry, inode);
2680 return NULL;
2681 }
2682
2683 iput(inode);
2684 return actual;
David Howells770bfad2006-08-22 20:06:07 -04002685}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002686EXPORT_SYMBOL_GPL(d_materialise_unique);
David Howells770bfad2006-08-22 20:06:07 -04002687
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002688static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002689{
2690 *buflen -= namelen;
2691 if (*buflen < 0)
2692 return -ENAMETOOLONG;
2693 *buffer -= namelen;
2694 memcpy(*buffer, str, namelen);
2695 return 0;
2696}
2697
Waiman Long232d2d62013-09-09 12:18:13 -04002698/**
2699 * prepend_name - prepend a pathname in front of current buffer pointer
2700 * buffer: buffer pointer
2701 * buflen: allocated length of the buffer
2702 * name: name string and length qstr structure
2703 *
2704 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
2705 * make sure that either the old or the new name pointer and length are
2706 * fetched. However, there may be mismatch between length and pointer.
2707 * The length cannot be trusted, we need to copy it byte-by-byte until
2708 * the length is reached or a null byte is found. It also prepends "/" at
2709 * the beginning of the name. The sequence number check at the caller will
2710 * retry it again when a d_move() does happen. So any garbage in the buffer
2711 * due to mismatched pointer and length will be discarded.
2712 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002713static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2714{
Waiman Long232d2d62013-09-09 12:18:13 -04002715 const char *dname = ACCESS_ONCE(name->name);
2716 u32 dlen = ACCESS_ONCE(name->len);
2717 char *p;
2718
2719 if (*buflen < dlen + 1)
2720 return -ENAMETOOLONG;
2721 *buflen -= dlen + 1;
2722 p = *buffer -= dlen + 1;
2723 *p++ = '/';
2724 while (dlen--) {
2725 char c = *dname++;
2726 if (!c)
2727 break;
2728 *p++ = c;
2729 }
2730 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002731}
2732
Linus Torvalds1da177e2005-04-16 15:20:36 -07002733/**
Randy Dunlap208898c2010-11-18 15:02:49 -08002734 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002735 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002736 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002737 * @buffer: pointer to the end of the buffer
2738 * @buflen: pointer to buffer length
2739 *
Waiman Long232d2d62013-09-09 12:18:13 -04002740 * The function tries to write out the pathname without taking any lock other
2741 * than the RCU read lock to make sure that dentries won't go away. It only
2742 * checks the sequence number of the global rename_lock as any change in the
2743 * dentry's d_seq will be preceded by changes in the rename_lock sequence
2744 * number. If the sequence number had been change, it will restart the whole
2745 * pathname back-tracing sequence again. It performs a total of 3 trials of
2746 * lockless back-tracing sequences before falling back to take the
2747 * rename_lock.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002748 */
Al Viro02125a82011-12-05 08:43:34 -05002749static int prepend_path(const struct path *path,
2750 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002751 char **buffer, int *buflen)
2752{
2753 struct dentry *dentry = path->dentry;
2754 struct vfsmount *vfsmnt = path->mnt;
Al Viro0714a532011-11-24 22:19:58 -05002755 struct mount *mnt = real_mount(vfsmnt);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002756 int error = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04002757 unsigned seq = 0;
2758 char *bptr;
2759 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002760
Al Viro48f5ec22013-09-09 15:22:25 -04002761 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002762restart:
2763 bptr = *buffer;
2764 blen = *buflen;
2765 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002766 while (dentry != root->dentry || vfsmnt != root->mnt) {
2767 struct dentry * parent;
2768
2769 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
2770 /* Global root? */
Waiman Long232d2d62013-09-09 12:18:13 -04002771 if (mnt_has_parent(mnt)) {
2772 dentry = mnt->mnt_mountpoint;
2773 mnt = mnt->mnt_parent;
2774 vfsmnt = &mnt->mnt;
2775 continue;
2776 }
2777 /*
2778 * Filesystems needing to implement special "root names"
2779 * should do so with ->d_dname()
2780 */
2781 if (IS_ROOT(dentry) &&
2782 (dentry->d_name.len != 1 ||
2783 dentry->d_name.name[0] != '/')) {
2784 WARN(1, "Root dentry has weird name <%.*s>\n",
2785 (int) dentry->d_name.len,
2786 dentry->d_name.name);
2787 }
2788 if (!error)
2789 error = is_mounted(vfsmnt) ? 1 : 2;
2790 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002791 }
2792 parent = dentry->d_parent;
2793 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002794 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002795 if (error)
2796 break;
2797
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002798 dentry = parent;
2799 }
Al Viro48f5ec22013-09-09 15:22:25 -04002800 if (!(seq & 1))
2801 rcu_read_unlock();
2802 if (need_seqretry(&rename_lock, seq)) {
2803 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04002804 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002805 }
Al Viro48f5ec22013-09-09 15:22:25 -04002806 done_seqretry(&rename_lock, seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002807
Waiman Long232d2d62013-09-09 12:18:13 -04002808 if (error >= 0 && bptr == *buffer) {
2809 if (--blen < 0)
2810 error = -ENAMETOOLONG;
2811 else
2812 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002813 }
Waiman Long232d2d62013-09-09 12:18:13 -04002814 *buffer = bptr;
2815 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04002816 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002817}
2818
2819/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002820 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002821 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002822 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07002823 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07002824 * @buflen: buffer length
2825 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002826 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002827 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002828 * Returns a pointer into the buffer or an error code if the
2829 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08002830 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04002831 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002832 *
Al Viro02125a82011-12-05 08:43:34 -05002833 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002834 */
Al Viro02125a82011-12-05 08:43:34 -05002835char *__d_path(const struct path *path,
2836 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002837 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002838{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002839 char *res = buf + buflen;
2840 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002841
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002842 prepend(&res, &buflen, "\0", 1);
Al Viro7ea600b2013-03-26 18:25:57 -04002843 br_read_lock(&vfsmount_lock);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002844 error = prepend_path(path, root, &res, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04002845 br_read_unlock(&vfsmount_lock);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002846
Al Viro02125a82011-12-05 08:43:34 -05002847 if (error < 0)
2848 return ERR_PTR(error);
2849 if (error > 0)
2850 return NULL;
2851 return res;
2852}
2853
2854char *d_absolute_path(const struct path *path,
2855 char *buf, int buflen)
2856{
2857 struct path root = {};
2858 char *res = buf + buflen;
2859 int error;
2860
2861 prepend(&res, &buflen, "\0", 1);
Al Viro7ea600b2013-03-26 18:25:57 -04002862 br_read_lock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002863 error = prepend_path(path, &root, &res, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04002864 br_read_unlock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002865
2866 if (error > 1)
2867 error = -EINVAL;
2868 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002869 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002870 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002871}
2872
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002873/*
2874 * same as __d_path but appends "(deleted)" for unlinked files.
2875 */
Al Viro02125a82011-12-05 08:43:34 -05002876static int path_with_deleted(const struct path *path,
2877 const struct path *root,
2878 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002879{
2880 prepend(buf, buflen, "\0", 1);
2881 if (d_unlinked(path->dentry)) {
2882 int error = prepend(buf, buflen, " (deleted)", 10);
2883 if (error)
2884 return error;
2885 }
2886
2887 return prepend_path(path, root, buf, buflen);
2888}
2889
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002890static int prepend_unreachable(char **buffer, int *buflen)
2891{
2892 return prepend(buffer, buflen, "(unreachable)", 13);
2893}
2894
Jan Bluncka03a8a702008-02-14 19:38:32 -08002895/**
2896 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08002897 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08002898 * @buf: buffer to return value in
2899 * @buflen: buffer length
2900 *
2901 * Convert a dentry into an ASCII path name. If the entry has been deleted
2902 * the string " (deleted)" is appended. Note that this is ambiguous.
2903 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002904 * Returns a pointer into the buffer or an error code if the path was
2905 * too long. Note: Callers should use the returned pointer, not the passed
2906 * in buffer, to use the name! The implementation often starts at an offset
2907 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002908 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002909 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002910 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07002911char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002912{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002913 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08002914 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002915 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002916
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002917 /*
2918 * We have various synthetic filesystems that never get mounted. On
2919 * these filesystems dentries are never used for lookup purposes, and
2920 * thus don't need to be hashed. They also don't need a name until a
2921 * user wants to identify the object in /proc/pid/fd/. The little hack
2922 * below allows us to generate a name for these objects on demand:
2923 */
Jan Blunckcf28b482008-02-14 19:38:44 -08002924 if (path->dentry->d_op && path->dentry->d_op->d_dname)
2925 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002926
Miklos Szeredif7ad3c62010-08-10 11:41:36 +02002927 get_fs_root(current->fs, &root);
Al Viro7ea600b2013-03-26 18:25:57 -04002928 br_read_lock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002929 error = path_with_deleted(path, &root, &res, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04002930 br_read_unlock(&vfsmount_lock);
Al Viro02125a82011-12-05 08:43:34 -05002931 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002932 res = ERR_PTR(error);
Jan Blunck6ac08c32008-02-14 19:34:38 -08002933 path_put(&root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002934 return res;
2935}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002936EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002937
2938/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002939 * Helper function for dentry_operations.d_dname() members
2940 */
2941char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
2942 const char *fmt, ...)
2943{
2944 va_list args;
2945 char temp[64];
2946 int sz;
2947
2948 va_start(args, fmt);
2949 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
2950 va_end(args);
2951
2952 if (sz > sizeof(temp) || sz > buflen)
2953 return ERR_PTR(-ENAMETOOLONG);
2954
2955 buffer += buflen - sz;
2956 return memcpy(buffer, temp, sz);
2957}
2958
Al Viro118b2302013-08-24 12:08:17 -04002959char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
2960{
2961 char *end = buffer + buflen;
2962 /* these dentries are never renamed, so d_lock is not needed */
2963 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04002964 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04002965 prepend(&end, &buflen, "/", 1))
2966 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04002967 return end;
Al Viro118b2302013-08-24 12:08:17 -04002968}
2969
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002970/*
Ram Pai6092d042008-03-27 13:06:20 +01002971 * Write full pathname from the root of the filesystem into the buffer.
2972 */
Nick Pigginec2447c2011-01-07 17:49:29 +11002973static char *__dentry_path(struct dentry *dentry, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01002974{
Waiman Long232d2d62013-09-09 12:18:13 -04002975 char *end, *retval;
2976 int len, seq = 0;
2977 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01002978
Al Viro48f5ec22013-09-09 15:22:25 -04002979 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002980restart:
2981 end = buf + buflen;
2982 len = buflen;
2983 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01002984 if (buflen < 1)
2985 goto Elong;
2986 /* Get '/' right */
2987 retval = end-1;
2988 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04002989 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002990 while (!IS_ROOT(dentry)) {
2991 struct dentry *parent = dentry->d_parent;
Nick Piggin9abca362011-01-07 17:49:36 +11002992 int error;
Ram Pai6092d042008-03-27 13:06:20 +01002993
Ram Pai6092d042008-03-27 13:06:20 +01002994 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002995 error = prepend_name(&end, &len, &dentry->d_name);
2996 if (error)
2997 break;
Ram Pai6092d042008-03-27 13:06:20 +01002998
2999 retval = end;
3000 dentry = parent;
3001 }
Al Viro48f5ec22013-09-09 15:22:25 -04003002 if (!(seq & 1))
3003 rcu_read_unlock();
3004 if (need_seqretry(&rename_lock, seq)) {
3005 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003006 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003007 }
3008 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003009 if (error)
3010 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003011 return retval;
3012Elong:
3013 return ERR_PTR(-ENAMETOOLONG);
3014}
Nick Pigginec2447c2011-01-07 17:49:29 +11003015
3016char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3017{
Waiman Long232d2d62013-09-09 12:18:13 -04003018 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003019}
3020EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003021
3022char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3023{
3024 char *p = NULL;
3025 char *retval;
3026
Al Viroc1031352010-06-06 22:31:14 -04003027 if (d_unlinked(dentry)) {
3028 p = buf + buflen;
3029 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3030 goto Elong;
3031 buflen++;
3032 }
3033 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003034 if (!IS_ERR(retval) && p)
3035 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003036 return retval;
3037Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003038 return ERR_PTR(-ENAMETOOLONG);
3039}
3040
3041/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003042 * NOTE! The user-level library version returns a
3043 * character pointer. The kernel system call just
3044 * returns the length of the buffer filled (which
3045 * includes the ending '\0' character), or a negative
3046 * error value. So libc would do something like
3047 *
3048 * char *getcwd(char * buf, size_t size)
3049 * {
3050 * int retval;
3051 *
3052 * retval = sys_getcwd(buf, size);
3053 * if (retval >= 0)
3054 * return buf;
3055 * errno = -retval;
3056 * return NULL;
3057 * }
3058 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003059SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003060{
Linus Torvalds552ce542007-02-13 12:08:18 -08003061 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003062 struct path pwd, root;
Linus Torvalds552ce542007-02-13 12:08:18 -08003063 char *page = (char *) __get_free_page(GFP_USER);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003064
3065 if (!page)
3066 return -ENOMEM;
3067
Miklos Szeredif7ad3c62010-08-10 11:41:36 +02003068 get_fs_root_and_pwd(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003069
Linus Torvalds552ce542007-02-13 12:08:18 -08003070 error = -ENOENT;
Al Viro7ea600b2013-03-26 18:25:57 -04003071 br_read_lock(&vfsmount_lock);
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003072 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003073 unsigned long len;
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003074 char *cwd = page + PAGE_SIZE;
3075 int buflen = PAGE_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003076
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003077 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003078 error = prepend_path(&pwd, &root, &cwd, &buflen);
Al Viro7ea600b2013-03-26 18:25:57 -04003079 br_read_unlock(&vfsmount_lock);
Linus Torvalds552ce542007-02-13 12:08:18 -08003080
Al Viro02125a82011-12-05 08:43:34 -05003081 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003082 goto out;
3083
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003084 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003085 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003086 error = prepend_unreachable(&cwd, &buflen);
3087 if (error)
3088 goto out;
3089 }
3090
Linus Torvalds552ce542007-02-13 12:08:18 -08003091 error = -ERANGE;
3092 len = PAGE_SIZE + page - cwd;
3093 if (len <= size) {
3094 error = len;
3095 if (copy_to_user(buf, cwd, len))
3096 error = -EFAULT;
3097 }
Nick Piggin949854d2011-01-07 17:49:37 +11003098 } else {
Al Viro7ea600b2013-03-26 18:25:57 -04003099 br_read_unlock(&vfsmount_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003100 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003101
3102out:
Jan Blunck6ac08c32008-02-14 19:34:38 -08003103 path_put(&pwd);
3104 path_put(&root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003105 free_page((unsigned long) page);
3106 return error;
3107}
3108
3109/*
3110 * Test whether new_dentry is a subdirectory of old_dentry.
3111 *
3112 * Trivially implemented using the dcache structure
3113 */
3114
3115/**
3116 * is_subdir - is new dentry a subdirectory of old_dentry
3117 * @new_dentry: new dentry
3118 * @old_dentry: old dentry
3119 *
3120 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
3121 * Returns 0 otherwise.
3122 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3123 */
3124
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003125int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003126{
3127 int result;
Nick Piggin949854d2011-01-07 17:49:37 +11003128 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003129
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003130 if (new_dentry == old_dentry)
3131 return 1;
3132
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003133 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003134 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003135 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003136 /*
3137 * Need rcu_readlock to protect against the d_parent trashing
3138 * due to d_move
3139 */
3140 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003141 if (d_ancestor(old_dentry, new_dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003142 result = 1;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003143 else
3144 result = 0;
Nick Piggin949854d2011-01-07 17:49:37 +11003145 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003146 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003147
3148 return result;
3149}
3150
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003151static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003152{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003153 struct dentry *root = data;
3154 if (dentry != root) {
3155 if (d_unhashed(dentry) || !dentry->d_inode)
3156 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003157
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003158 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3159 dentry->d_flags |= DCACHE_GENOCIDE;
3160 dentry->d_lockref.count--;
3161 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003162 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003163 return D_WALK_CONTINUE;
3164}
Nick Piggin58db63d2011-01-07 17:49:39 +11003165
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003166void d_genocide(struct dentry *parent)
3167{
3168 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003169}
3170
Al Viro60545d02013-06-07 01:20:27 -04003171void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003172{
Al Viro60545d02013-06-07 01:20:27 -04003173 inode_dec_link_count(inode);
3174 BUG_ON(dentry->d_name.name != dentry->d_iname ||
3175 !hlist_unhashed(&dentry->d_alias) ||
3176 !d_unlinked(dentry));
3177 spin_lock(&dentry->d_parent->d_lock);
3178 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3179 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3180 (unsigned long long)inode->i_ino);
3181 spin_unlock(&dentry->d_lock);
3182 spin_unlock(&dentry->d_parent->d_lock);
3183 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003184}
Al Viro60545d02013-06-07 01:20:27 -04003185EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003186
3187static __initdata unsigned long dhash_entries;
3188static int __init set_dhash_entries(char *str)
3189{
3190 if (!str)
3191 return 0;
3192 dhash_entries = simple_strtoul(str, &str, 0);
3193 return 1;
3194}
3195__setup("dhash_entries=", set_dhash_entries);
3196
3197static void __init dcache_init_early(void)
3198{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003199 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003200
3201 /* If hashes are distributed across NUMA nodes, defer
3202 * hash allocation until vmalloc space is available.
3203 */
3204 if (hashdist)
3205 return;
3206
3207 dentry_hashtable =
3208 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003209 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003210 dhash_entries,
3211 13,
3212 HASH_EARLY,
3213 &d_hash_shift,
3214 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003215 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003216 0);
3217
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003218 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003219 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003220}
3221
Denis Cheng74bf17c2007-10-16 23:26:30 -07003222static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003223{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003224 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003225
3226 /*
3227 * A constructor could be added for stable state like the lists,
3228 * but it is probably not worth it because of the cache nature
3229 * of the dcache.
3230 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003231 dentry_cache = KMEM_CACHE(dentry,
3232 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003233
3234 /* Hash may have been set up in dcache_init_early */
3235 if (!hashdist)
3236 return;
3237
3238 dentry_hashtable =
3239 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003240 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003241 dhash_entries,
3242 13,
3243 0,
3244 &d_hash_shift,
3245 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003246 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003247 0);
3248
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003249 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003250 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003251}
3252
3253/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003254struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003255EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003256
Linus Torvalds1da177e2005-04-16 15:20:36 -07003257EXPORT_SYMBOL(d_genocide);
3258
Linus Torvalds1da177e2005-04-16 15:20:36 -07003259void __init vfs_caches_init_early(void)
3260{
3261 dcache_init_early();
3262 inode_init_early();
3263}
3264
3265void __init vfs_caches_init(unsigned long mempages)
3266{
3267 unsigned long reserve;
3268
3269 /* Base hash sizes on available memory, with a reserve equal to
3270 150% of current kernel size */
3271
3272 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
3273 mempages -= reserve;
3274
3275 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003276 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003277
Denis Cheng74bf17c2007-10-16 23:26:30 -07003278 dcache_init();
3279 inode_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003280 files_init(mempages);
Denis Cheng74bf17c2007-10-16 23:26:30 -07003281 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003282 bdev_cache_init();
3283 chrdev_init();
3284}