blob: eb0978da1bd44fc8e41abf292e2a6cc0bec9ed9c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/dcache.c
3 *
4 * Complete reimplementation
5 * (C) 1997 Thomas Schoebel-Theuer,
6 * with heavy changes by Linus Torvalds
7 */
8
9/*
10 * Notes on the allocation strategy:
11 *
12 * The dcache is a master of the icache - whenever a dcache entry
13 * exists, the inode will always exist. "iput()" is done either when
14 * the dcache entry is deleted or garbage collected.
15 */
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/syscalls.h>
18#include <linux/string.h>
19#include <linux/mm.h>
20#include <linux/fs.h>
John McCutchan7a91bf72005-08-08 13:52:16 -040021#include <linux/fsnotify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/slab.h>
23#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/hash.h>
25#include <linux/cache.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/mount.h>
28#include <linux/file.h>
29#include <asm/uaccess.h>
30#include <linux/security.h>
31#include <linux/seqlock.h>
32#include <linux/swap.h>
33#include <linux/bootmem.h>
Al Viro5ad4e532009-03-29 19:50:06 -040034#include <linux/fs_struct.h>
Frederic Weisbecker613afbf2009-07-16 15:44:29 +020035#include <linux/hardirq.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110036#include <linux/bit_spinlock.h>
37#include <linux/rculist_bl.h>
Linus Torvalds268bb0c2011-05-20 12:50:29 -070038#include <linux/prefetch.h>
David Howellsdd179942011-08-16 15:31:30 +010039#include <linux/ratelimit.h>
Dave Chinnerf6041562013-08-28 10:18:00 +100040#include <linux/list_lru.h>
David Howells07f3f052006-09-30 20:52:18 +020041#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050042#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Nick Piggin789680d2011-01-07 17:49:30 +110044/*
45 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110046 * dcache->d_inode->i_lock protects:
47 * - i_dentry, d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110048 * dcache_hash_bucket lock protects:
49 * - the dcache hash table
50 * s_anon bl list spinlock protects:
51 * - the s_anon list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100052 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110053 * - the dcache lru lists and counters
54 * d_lock protects:
55 * - d_flags
56 * - d_name
57 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110058 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110059 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110060 * - d_parent and d_subdirs
61 * - childrens' d_child and d_parent
Nick Pigginb23fb0a2011-01-07 17:49:35 +110062 * - d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110063 *
64 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110065 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110066 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100067 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110068 * dcache_hash_bucket lock
69 * s_anon lock
Nick Piggin789680d2011-01-07 17:49:30 +110070 *
Nick Pigginda502952011-01-07 17:49:33 +110071 * If there is an ancestor relationship:
72 * dentry->d_parent->...->d_parent->d_lock
73 * ...
74 * dentry->d_parent->d_lock
75 * dentry->d_lock
76 *
77 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110078 * if (dentry1 < dentry2)
79 * dentry1->d_lock
80 * dentry2->d_lock
81 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080082int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070083EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
84
Al Viro74c3cbe2007-07-22 08:04:18 -040085__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Nick Piggin949854d2011-01-07 17:49:37 +110087EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Christoph Lametere18b8902006-12-06 20:33:20 -080089static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Waiman Long232d2d62013-09-09 12:18:13 -040091/**
92 * read_seqbegin_or_lock - begin a sequence number check or locking block
Waiman Long18129972013-09-12 10:55:35 -040093 * @lock: sequence lock
94 * @seq : sequence number to be checked
Waiman Long232d2d62013-09-09 12:18:13 -040095 *
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 Long18129972013-09-12 10:55:35 -0400106 read_seqlock_excl(lock);
Waiman Long232d2d62013-09-09 12:18:13 -0400107}
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 Long18129972013-09-12 10:55:35 -0400117 read_sequnlock_excl(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/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400360 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
361 * is in use - which includes both the "real" per-superblock
362 * LRU list _and_ the DCACHE_SHRINK_LIST use.
363 *
364 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
365 * on the shrink list (ie not on the superblock LRU list).
366 *
367 * The per-cpu "nr_dentry_unused" counters are updated with
368 * the DCACHE_LRU_LIST bit.
369 *
370 * These helper functions make sure we always follow the
371 * rules. d_lock must be held by the caller.
372 */
373#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
374static void d_lru_add(struct dentry *dentry)
375{
376 D_FLAG_VERIFY(dentry, 0);
377 dentry->d_flags |= DCACHE_LRU_LIST;
378 this_cpu_inc(nr_dentry_unused);
379 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
380}
381
382static void d_lru_del(struct dentry *dentry)
383{
384 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
385 dentry->d_flags &= ~DCACHE_LRU_LIST;
386 this_cpu_dec(nr_dentry_unused);
387 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
388}
389
390static void d_shrink_del(struct dentry *dentry)
391{
392 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
393 list_del_init(&dentry->d_lru);
394 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
395 this_cpu_dec(nr_dentry_unused);
396}
397
398static void d_shrink_add(struct dentry *dentry, struct list_head *list)
399{
400 D_FLAG_VERIFY(dentry, 0);
401 list_add(&dentry->d_lru, list);
402 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
403 this_cpu_inc(nr_dentry_unused);
404}
405
406/*
407 * These can only be called under the global LRU lock, ie during the
408 * callback for freeing the LRU list. "isolate" removes it from the
409 * LRU lists entirely, while shrink_move moves it to the indicated
410 * private list.
411 */
412static void d_lru_isolate(struct dentry *dentry)
413{
414 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
415 dentry->d_flags &= ~DCACHE_LRU_LIST;
416 this_cpu_dec(nr_dentry_unused);
417 list_del_init(&dentry->d_lru);
418}
419
420static void d_lru_shrink_move(struct dentry *dentry, struct list_head *list)
421{
422 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
423 dentry->d_flags |= DCACHE_SHRINK_LIST;
424 list_move_tail(&dentry->d_lru, list);
425}
426
427/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000428 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700429 */
430static void dentry_lru_add(struct dentry *dentry)
431{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400432 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
433 d_lru_add(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700434}
435
Sage Weilf0023bc2011-10-28 10:02:42 -0700436/*
437 * Remove a dentry with references from the LRU.
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000438 *
439 * If we are on the shrink list, then we can get to try_prune_one_dentry() and
440 * lose our last reference through the parent walk. In this case, we need to
441 * remove ourselves from the shrink list, not the LRU.
Sage Weilf0023bc2011-10-28 10:02:42 -0700442 */
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700443static void dentry_lru_del(struct dentry *dentry)
444{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400445 if (dentry->d_flags & DCACHE_LRU_LIST) {
446 if (dentry->d_flags & DCACHE_SHRINK_LIST)
447 return d_shrink_del(dentry);
448 d_lru_del(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700449 }
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700450}
451
Miklos Szeredid52b9082007-05-08 00:23:46 -0700452/**
453 * d_kill - kill dentry and return parent
454 * @dentry: dentry to kill
Randy Dunlapff5fdb62011-01-22 20:16:06 -0800455 * @parent: parent dentry
Miklos Szeredid52b9082007-05-08 00:23:46 -0700456 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200457 * The dentry must already be unhashed and removed from the LRU.
Miklos Szeredid52b9082007-05-08 00:23:46 -0700458 *
459 * If this is the root of the dentry tree, return NULL.
Nick Piggin23044502011-01-07 17:49:31 +1100460 *
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100461 * dentry->d_lock and parent->d_lock must be held by caller, and are dropped by
462 * d_kill.
Miklos Szeredid52b9082007-05-08 00:23:46 -0700463 */
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100464static struct dentry *d_kill(struct dentry *dentry, struct dentry *parent)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200465 __releases(dentry->d_lock)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100466 __releases(parent->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100467 __releases(dentry->d_inode->i_lock)
Miklos Szeredid52b9082007-05-08 00:23:46 -0700468{
Miklos Szeredid52b9082007-05-08 00:23:46 -0700469 list_del(&dentry->d_u.d_child);
Trond Myklebustc83ce982011-03-15 13:36:43 -0400470 /*
471 * Inform try_to_ascend() that we are no longer attached to the
472 * dentry tree
473 */
Miklos Szeredib161dfa2012-09-17 22:31:38 +0200474 dentry->d_flags |= DCACHE_DENTRY_KILLED;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +1100475 if (parent)
476 spin_unlock(&parent->d_lock);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700477 dentry_iput(dentry);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100478 /*
479 * dentry_iput drops the locks, at which point nobody (except
480 * transient RCU lookups) can reach this dentry.
481 */
Miklos Szeredid52b9082007-05-08 00:23:46 -0700482 d_free(dentry);
OGAWA Hirofumi871c0062008-10-16 07:50:27 +0900483 return parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700484}
485
David Howellsc6627c62011-06-07 14:09:20 +0100486/*
487 * Unhash a dentry without inserting an RCU walk barrier or checking that
488 * dentry->d_lock is locked. The caller must take care of that, if
489 * appropriate.
490 */
491static void __d_shrink(struct dentry *dentry)
492{
493 if (!d_unhashed(dentry)) {
494 struct hlist_bl_head *b;
495 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
496 b = &dentry->d_sb->s_anon;
497 else
498 b = d_hash(dentry->d_parent, dentry->d_name.hash);
499
500 hlist_bl_lock(b);
501 __hlist_bl_del(&dentry->d_hash);
502 dentry->d_hash.pprev = NULL;
503 hlist_bl_unlock(b);
504 }
505}
506
Nick Piggin789680d2011-01-07 17:49:30 +1100507/**
508 * d_drop - drop a dentry
509 * @dentry: dentry to drop
510 *
511 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
512 * be found through a VFS lookup any more. Note that this is different from
513 * deleting the dentry - d_delete will try to mark the dentry negative if
514 * possible, giving a successful _negative_ lookup, while d_drop will
515 * just make the cache lookup fail.
516 *
517 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
518 * reason (NFS timeouts or autofs deletes).
519 *
520 * __d_drop requires dentry->d_lock.
521 */
522void __d_drop(struct dentry *dentry)
523{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700524 if (!d_unhashed(dentry)) {
David Howellsc6627c62011-06-07 14:09:20 +0100525 __d_shrink(dentry);
Linus Torvaldsdea36672011-04-24 07:58:46 -0700526 dentry_rcuwalk_barrier(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +1100527 }
528}
529EXPORT_SYMBOL(__d_drop);
530
531void d_drop(struct dentry *dentry)
532{
Nick Piggin789680d2011-01-07 17:49:30 +1100533 spin_lock(&dentry->d_lock);
534 __d_drop(dentry);
535 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100536}
537EXPORT_SYMBOL(d_drop);
538
Nick Piggin77812a12011-01-07 17:49:48 +1100539/*
540 * Finish off a dentry we've decided to kill.
541 * dentry->d_lock must be held, returns with it unlocked.
542 * If ref is non-zero, then decrement the refcount too.
543 * Returns dentry requiring refcount drop, or NULL if we're done.
544 */
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000545static inline struct dentry *
546dentry_kill(struct dentry *dentry, int unlock_on_failure)
Nick Piggin77812a12011-01-07 17:49:48 +1100547 __releases(dentry->d_lock)
548{
Nick Piggin873feea2011-01-07 17:50:06 +1100549 struct inode *inode;
Nick Piggin77812a12011-01-07 17:49:48 +1100550 struct dentry *parent;
551
Nick Piggin873feea2011-01-07 17:50:06 +1100552 inode = dentry->d_inode;
553 if (inode && !spin_trylock(&inode->i_lock)) {
Nick Piggin77812a12011-01-07 17:49:48 +1100554relock:
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000555 if (unlock_on_failure) {
556 spin_unlock(&dentry->d_lock);
557 cpu_relax();
558 }
Nick Piggin77812a12011-01-07 17:49:48 +1100559 return dentry; /* try again with same dentry */
560 }
561 if (IS_ROOT(dentry))
562 parent = NULL;
563 else
564 parent = dentry->d_parent;
565 if (parent && !spin_trylock(&parent->d_lock)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100566 if (inode)
567 spin_unlock(&inode->i_lock);
Nick Piggin77812a12011-01-07 17:49:48 +1100568 goto relock;
569 }
Nick Piggin31e6b012011-01-07 17:49:52 +1100570
Linus Torvalds0d984392013-09-08 13:46:52 -0700571 /*
572 * The dentry is now unrecoverably dead to the world.
573 */
574 lockref_mark_dead(&dentry->d_lockref);
575
Sage Weilf0023bc2011-10-28 10:02:42 -0700576 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700577 * inform the fs via d_prune that this dentry is about to be
578 * unhashed and destroyed.
579 */
Yan, Zheng590fb512013-08-13 15:42:02 +0800580 if ((dentry->d_flags & DCACHE_OP_PRUNE) && !d_unhashed(dentry))
Yan, Zheng61572bb2013-04-15 14:13:21 +0800581 dentry->d_op->d_prune(dentry);
582
583 dentry_lru_del(dentry);
Nick Piggin77812a12011-01-07 17:49:48 +1100584 /* if it was on the hash then remove it */
585 __d_drop(dentry);
586 return d_kill(dentry, parent);
587}
588
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589/*
590 * This is dput
591 *
592 * This is complicated by the fact that we do not want to put
593 * dentries that are no longer on any hash chain on the unused
594 * list: we'd much rather just get rid of them immediately.
595 *
596 * However, that implies that we have to traverse the dentry
597 * tree upwards to the parents which might _also_ now be
598 * scheduled for deletion (it may have been only waiting for
599 * its last child to go away).
600 *
601 * This tail recursion is done by hand as we don't want to depend
602 * on the compiler to always get this right (gcc generally doesn't).
603 * Real recursion would eat up our stack space.
604 */
605
606/*
607 * dput - release a dentry
608 * @dentry: dentry to release
609 *
610 * Release a dentry. This will drop the usage count and if appropriate
611 * call the dentry unlink method as well as removing it from the queues and
612 * releasing its resources. If the parent dentries were scheduled for release
613 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615void dput(struct dentry *dentry)
616{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700617 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 return;
619
620repeat:
Waiman Long98474232013-08-28 18:24:59 -0700621 if (lockref_put_or_lock(&dentry->d_lockref))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700624 /* Unreachable? Get rid of it */
625 if (unlikely(d_unhashed(dentry)))
626 goto kill_it;
627
628 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100630 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 }
Nick Piggin265ac902010-10-10 05:36:24 -0400632
Jeff Layton39e3c952012-11-28 11:30:53 -0500633 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400634 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400635
Waiman Long98474232013-08-28 18:24:59 -0700636 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100637 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 return;
639
Miklos Szeredid52b9082007-05-08 00:23:46 -0700640kill_it:
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000641 dentry = dentry_kill(dentry, 1);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700642 if (dentry)
643 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700645EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646
647/**
648 * d_invalidate - invalidate a dentry
649 * @dentry: dentry to invalidate
650 *
651 * Try to invalidate the dentry if it turns out to be
652 * possible. If there are other dentries that can be
653 * reached through this one we can't delete it and we
654 * return -EBUSY. On success we return 0.
655 *
656 * no dcache lock.
657 */
658
659int d_invalidate(struct dentry * dentry)
660{
661 /*
662 * If it's already been dropped, return OK.
663 */
Nick Pigginda502952011-01-07 17:49:33 +1100664 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 if (d_unhashed(dentry)) {
Nick Pigginda502952011-01-07 17:49:33 +1100666 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 return 0;
668 }
669 /*
670 * Check whether to do a partial shrink_dcache
671 * to get rid of unused child entries.
672 */
673 if (!list_empty(&dentry->d_subdirs)) {
Nick Pigginda502952011-01-07 17:49:33 +1100674 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 shrink_dcache_parent(dentry);
Nick Pigginda502952011-01-07 17:49:33 +1100676 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 }
678
679 /*
680 * Somebody else still using it?
681 *
682 * If it's a directory, we can't drop it
683 * for fear of somebody re-populating it
684 * with children (even though dropping it
685 * would make it unreachable from the root,
686 * we might still populate it if it was a
687 * working directory or similar).
Al Viro50e69632011-11-07 16:39:57 +0000688 * We also need to leave mountpoints alone,
689 * directory or not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 */
Waiman Long98474232013-08-28 18:24:59 -0700691 if (dentry->d_lockref.count > 1 && dentry->d_inode) {
Al Viro50e69632011-11-07 16:39:57 +0000692 if (S_ISDIR(dentry->d_inode->i_mode) || d_mountpoint(dentry)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 return -EBUSY;
695 }
696 }
697
698 __d_drop(dentry);
699 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 return 0;
701}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700702EXPORT_SYMBOL(d_invalidate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100704/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100705static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706{
Waiman Long98474232013-08-28 18:24:59 -0700707 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708}
709
Nick Piggindc0474b2011-01-07 17:49:43 +1100710static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100711{
Waiman Long98474232013-08-28 18:24:59 -0700712 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100713}
714
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100715struct dentry *dget_parent(struct dentry *dentry)
716{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700717 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100718 struct dentry *ret;
719
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700720 /*
721 * Do optimistic parent lookup without any
722 * locking.
723 */
724 rcu_read_lock();
725 ret = ACCESS_ONCE(dentry->d_parent);
726 gotref = lockref_get_not_zero(&ret->d_lockref);
727 rcu_read_unlock();
728 if (likely(gotref)) {
729 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
730 return ret;
731 dput(ret);
732 }
733
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100734repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100735 /*
736 * Don't need rcu_dereference because we re-check it was correct under
737 * the lock.
738 */
739 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100740 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100741 spin_lock(&ret->d_lock);
742 if (unlikely(ret != dentry->d_parent)) {
743 spin_unlock(&ret->d_lock);
744 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100745 goto repeat;
746 }
Nick Piggina734eb42011-01-07 17:49:44 +1100747 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700748 BUG_ON(!ret->d_lockref.count);
749 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100750 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100751 return ret;
752}
753EXPORT_SYMBOL(dget_parent);
754
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755/**
756 * d_find_alias - grab a hashed alias of inode
757 * @inode: inode in question
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700758 * @want_discon: flag, used by d_splice_alias, to request
759 * that only a DISCONNECTED alias be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 *
761 * If inode has a hashed alias, or is a directory and has any alias,
762 * acquire the reference to alias and return it. Otherwise return NULL.
763 * Notice that if inode is a directory there can be only one alias and
764 * it can be unhashed only if it has no children, or if it is the root
765 * of a filesystem.
766 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700767 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700768 * any other hashed alias over that one unless @want_discon is set,
769 * in which case only return an IS_ROOT, DCACHE_DISCONNECTED alias.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 */
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700771static struct dentry *__d_find_alias(struct inode *inode, int want_discon)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772{
Nick Pigginda502952011-01-07 17:49:33 +1100773 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774
Nick Pigginda502952011-01-07 17:49:33 +1100775again:
776 discon_alias = NULL;
Sasha Levinb67bfe02013-02-27 17:06:00 -0800777 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100778 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700780 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100781 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 discon_alias = alias;
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700783 } else if (!want_discon) {
Nick Piggindc0474b2011-01-07 17:49:43 +1100784 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100785 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 return alias;
787 }
788 }
Nick Pigginda502952011-01-07 17:49:33 +1100789 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 }
Nick Pigginda502952011-01-07 17:49:33 +1100791 if (discon_alias) {
792 alias = discon_alias;
793 spin_lock(&alias->d_lock);
794 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
795 if (IS_ROOT(alias) &&
796 (alias->d_flags & DCACHE_DISCONNECTED)) {
Nick Piggindc0474b2011-01-07 17:49:43 +1100797 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100798 spin_unlock(&alias->d_lock);
799 return alias;
800 }
801 }
802 spin_unlock(&alias->d_lock);
803 goto again;
804 }
805 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806}
807
Nick Pigginda502952011-01-07 17:49:33 +1100808struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809{
David Howells214fda12006-03-25 03:06:36 -0800810 struct dentry *de = NULL;
811
Al Virob3d9b7a2012-06-09 13:51:19 -0400812 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100813 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700814 de = __d_find_alias(inode, 0);
Nick Piggin873feea2011-01-07 17:50:06 +1100815 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800816 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 return de;
818}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700819EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
821/*
822 * Try to kill dentries associated with this inode.
823 * WARNING: you must own a reference to inode.
824 */
825void d_prune_aliases(struct inode *inode)
826{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700827 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100829 spin_lock(&inode->i_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -0800830 hlist_for_each_entry(dentry, &inode->i_dentry, d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700832 if (!dentry->d_lockref.count) {
Yan, Zheng590fb512013-08-13 15:42:02 +0800833 /*
834 * inform the fs via d_prune that this dentry
835 * is about to be unhashed and destroyed.
836 */
837 if ((dentry->d_flags & DCACHE_OP_PRUNE) &&
838 !d_unhashed(dentry))
839 dentry->d_op->d_prune(dentry);
840
Nick Piggindc0474b2011-01-07 17:49:43 +1100841 __dget_dlock(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 __d_drop(dentry);
843 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100844 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 dput(dentry);
846 goto restart;
847 }
848 spin_unlock(&dentry->d_lock);
849 }
Nick Piggin873feea2011-01-07 17:50:06 +1100850 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700852EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853
854/*
Nick Piggin77812a12011-01-07 17:49:48 +1100855 * Try to throw away a dentry - free the inode, dput the parent.
856 * Requires dentry->d_lock is held, and dentry->d_count == 0.
857 * Releases dentry->d_lock.
Andrew Mortond702ccb2006-06-22 14:47:31 -0700858 *
Nick Piggin77812a12011-01-07 17:49:48 +1100859 * This may fail if locks cannot be acquired no problem, just try again.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 */
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000861static struct dentry * try_prune_one_dentry(struct dentry *dentry)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200862 __releases(dentry->d_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863{
Nick Piggin77812a12011-01-07 17:49:48 +1100864 struct dentry *parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700865
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000866 parent = dentry_kill(dentry, 0);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700867 /*
Nick Piggin77812a12011-01-07 17:49:48 +1100868 * If dentry_kill returns NULL, we have nothing more to do.
869 * if it returns the same dentry, trylocks failed. In either
870 * case, just loop again.
871 *
872 * Otherwise, we need to prune ancestors too. This is necessary
873 * to prevent quadratic behavior of shrink_dcache_parent(), but
874 * is also expected to be beneficial in reducing dentry cache
875 * fragmentation.
Miklos Szeredid52b9082007-05-08 00:23:46 -0700876 */
Nick Piggin77812a12011-01-07 17:49:48 +1100877 if (!parent)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000878 return NULL;
Nick Piggin77812a12011-01-07 17:49:48 +1100879 if (parent == dentry)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000880 return dentry;
Nick Piggin77812a12011-01-07 17:49:48 +1100881
882 /* Prune ancestors. */
883 dentry = parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700884 while (dentry) {
Waiman Long98474232013-08-28 18:24:59 -0700885 if (lockref_put_or_lock(&dentry->d_lockref))
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000886 return NULL;
887 dentry = dentry_kill(dentry, 1);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700888 }
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000889 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890}
891
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400892static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893{
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700894 struct dentry *dentry;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700895
Nick Pigginec336792011-01-07 17:49:47 +1100896 rcu_read_lock();
897 for (;;) {
Nick Pigginec336792011-01-07 17:49:47 +1100898 dentry = list_entry_rcu(list->prev, struct dentry, d_lru);
899 if (&dentry->d_lru == list)
900 break; /* empty */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400901
902 /*
903 * Get the dentry lock, and re-verify that the dentry is
904 * this on the shrinking list. If it is, we know that
905 * DCACHE_SHRINK_LIST and DCACHE_LRU_LIST are set.
906 */
Nick Pigginec336792011-01-07 17:49:47 +1100907 spin_lock(&dentry->d_lock);
908 if (dentry != list_entry(list->prev, struct dentry, d_lru)) {
909 spin_unlock(&dentry->d_lock);
Nick Piggin23044502011-01-07 17:49:31 +1100910 continue;
911 }
912
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000914 * The dispose list is isolated and dentries are not accounted
915 * to the LRU here, so we can simply remove it from the list
916 * here regardless of whether it is referenced or not.
917 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400918 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000919
920 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000922 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 */
Waiman Long98474232013-08-28 18:24:59 -0700924 if (dentry->d_lockref.count) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700925 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 continue;
927 }
Nick Pigginec336792011-01-07 17:49:47 +1100928 rcu_read_unlock();
Nick Piggin77812a12011-01-07 17:49:48 +1100929
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400930 /*
931 * If 'try_to_prune()' returns a dentry, it will
932 * be the same one we passed in, and d_lock will
933 * have been held the whole time, so it will not
934 * have been added to any other lists. We failed
935 * to get the inode lock.
936 *
937 * We just add it back to the shrink list.
938 */
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000939 dentry = try_prune_one_dentry(dentry);
Nick Piggin77812a12011-01-07 17:49:48 +1100940
Nick Pigginec336792011-01-07 17:49:47 +1100941 rcu_read_lock();
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000942 if (dentry) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400943 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000944 spin_unlock(&dentry->d_lock);
945 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 }
Nick Pigginec336792011-01-07 17:49:47 +1100947 rcu_read_unlock();
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400948}
949
Dave Chinnerf6041562013-08-28 10:18:00 +1000950static enum lru_status
951dentry_lru_isolate(struct list_head *item, spinlock_t *lru_lock, void *arg)
952{
953 struct list_head *freeable = arg;
954 struct dentry *dentry = container_of(item, struct dentry, d_lru);
955
956
957 /*
958 * we are inverting the lru lock/dentry->d_lock here,
959 * so use a trylock. If we fail to get the lock, just skip
960 * it
961 */
962 if (!spin_trylock(&dentry->d_lock))
963 return LRU_SKIP;
964
965 /*
966 * Referenced dentries are still in use. If they have active
967 * counts, just remove them from the LRU. Otherwise give them
968 * another pass through the LRU.
969 */
970 if (dentry->d_lockref.count) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400971 d_lru_isolate(dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +1000972 spin_unlock(&dentry->d_lock);
973 return LRU_REMOVED;
974 }
975
976 if (dentry->d_flags & DCACHE_REFERENCED) {
977 dentry->d_flags &= ~DCACHE_REFERENCED;
978 spin_unlock(&dentry->d_lock);
979
980 /*
981 * The list move itself will be made by the common LRU code. At
982 * this point, we've dropped the dentry->d_lock but keep the
983 * lru lock. This is safe to do, since every list movement is
984 * protected by the lru lock even if both locks are held.
985 *
986 * This is guaranteed by the fact that all LRU management
987 * functions are intermediated by the LRU API calls like
988 * list_lru_add and list_lru_del. List movement in this file
989 * only ever occur through this functions or through callbacks
990 * like this one, that are called from the LRU API.
991 *
992 * The only exceptions to this are functions like
993 * shrink_dentry_list, and code that first checks for the
994 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
995 * operating only with stack provided lists after they are
996 * properly isolated from the main list. It is thus, always a
997 * local access.
998 */
999 return LRU_ROTATE;
1000 }
1001
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001002 d_lru_shrink_move(dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001003 spin_unlock(&dentry->d_lock);
1004
1005 return LRU_REMOVED;
1006}
1007
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001008/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001009 * prune_dcache_sb - shrink the dcache
1010 * @sb: superblock
Dave Chinnerf6041562013-08-28 10:18:00 +10001011 * @nr_to_scan : number of entries to try to free
Dave Chinner9b17c622013-08-28 10:18:05 +10001012 * @nid: which node to scan for freeable entities
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001013 *
Dave Chinnerf6041562013-08-28 10:18:00 +10001014 * Attempt to shrink the superblock dcache LRU by @nr_to_scan entries. This is
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001015 * done when we need more memory an called from the superblock shrinker
1016 * function.
1017 *
1018 * This function may fail to free any resources if all the dentries are in
1019 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001020 */
Dave Chinner9b17c622013-08-28 10:18:05 +10001021long prune_dcache_sb(struct super_block *sb, unsigned long nr_to_scan,
1022 int nid)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001023{
Dave Chinnerf6041562013-08-28 10:18:00 +10001024 LIST_HEAD(dispose);
1025 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001026
Dave Chinner9b17c622013-08-28 10:18:05 +10001027 freed = list_lru_walk_node(&sb->s_dentry_lru, nid, dentry_lru_isolate,
1028 &dispose, &nr_to_scan);
Dave Chinnerf6041562013-08-28 10:18:00 +10001029 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001030 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031}
1032
Glauber Costa4e717f52013-08-28 10:18:03 +10001033static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
1034 spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001035{
Glauber Costa4e717f52013-08-28 10:18:03 +10001036 struct list_head *freeable = arg;
1037 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001038
Glauber Costa4e717f52013-08-28 10:18:03 +10001039 /*
1040 * we are inverting the lru lock/dentry->d_lock here,
1041 * so use a trylock. If we fail to get the lock, just skip
1042 * it
1043 */
1044 if (!spin_trylock(&dentry->d_lock))
1045 return LRU_SKIP;
1046
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001047 d_lru_shrink_move(dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001048 spin_unlock(&dentry->d_lock);
1049
1050 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001051}
1052
Glauber Costa4e717f52013-08-28 10:18:03 +10001053
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001054/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 * shrink_dcache_sb - shrink dcache for a superblock
1056 * @sb: superblock
1057 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001058 * Shrink the dcache for the specified super block. This is used to free
1059 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001061void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062{
Glauber Costa4e717f52013-08-28 10:18:03 +10001063 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001064
Glauber Costa4e717f52013-08-28 10:18:03 +10001065 do {
1066 LIST_HEAD(dispose);
1067
1068 freed = list_lru_walk(&sb->s_dentry_lru,
1069 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
1070
1071 this_cpu_sub(nr_dentry_unused, freed);
1072 shrink_dentry_list(&dispose);
1073 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001075EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076
1077/*
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001078 * This tries to ascend one level of parenthood, but
1079 * we can race with renaming, so we need to re-check
1080 * the parenthood after dropping the lock and check
1081 * that the sequence number still matches.
1082 */
Al Viro48f5ec22013-09-09 15:22:25 -04001083static struct dentry *try_to_ascend(struct dentry *old, unsigned seq)
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001084{
1085 struct dentry *new = old->d_parent;
1086
1087 rcu_read_lock();
1088 spin_unlock(&old->d_lock);
1089 spin_lock(&new->d_lock);
1090
1091 /*
1092 * might go back up the wrong parent if we have had a rename
1093 * or deletion
1094 */
1095 if (new != old->d_parent ||
Miklos Szeredib161dfa2012-09-17 22:31:38 +02001096 (old->d_flags & DCACHE_DENTRY_KILLED) ||
Al Viro48f5ec22013-09-09 15:22:25 -04001097 need_seqretry(&rename_lock, seq)) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001098 spin_unlock(&new->d_lock);
1099 new = NULL;
1100 }
1101 rcu_read_unlock();
1102 return new;
1103}
1104
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001106 * enum d_walk_ret - action to talke during tree walk
1107 * @D_WALK_CONTINUE: contrinue walk
1108 * @D_WALK_QUIT: quit walk
1109 * @D_WALK_NORETRY: quit when retry is needed
1110 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001112enum d_walk_ret {
1113 D_WALK_CONTINUE,
1114 D_WALK_QUIT,
1115 D_WALK_NORETRY,
1116 D_WALK_SKIP,
1117};
1118
1119/**
1120 * d_walk - walk the dentry tree
1121 * @parent: start of walk
1122 * @data: data passed to @enter() and @finish()
1123 * @enter: callback when first entering the dentry
1124 * @finish: callback when successfully finished the walk
1125 *
1126 * The @enter() and @finish() callbacks are called with d_lock held.
1127 */
1128static void d_walk(struct dentry *parent, void *data,
1129 enum d_walk_ret (*enter)(void *, struct dentry *),
1130 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131{
Nick Piggin949854d2011-01-07 17:49:37 +11001132 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001134 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001135 enum d_walk_ret ret;
1136 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001137
Nick Piggin58db63d2011-01-07 17:49:39 +11001138again:
Al Viro48f5ec22013-09-09 15:22:25 -04001139 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001140 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001141 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001142
1143 ret = enter(data, this_parent);
1144 switch (ret) {
1145 case D_WALK_CONTINUE:
1146 break;
1147 case D_WALK_QUIT:
1148 case D_WALK_SKIP:
1149 goto out_unlock;
1150 case D_WALK_NORETRY:
1151 retry = false;
1152 break;
1153 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154repeat:
1155 next = this_parent->d_subdirs.next;
1156resume:
1157 while (next != &this_parent->d_subdirs) {
1158 struct list_head *tmp = next;
Eric Dumazet5160ee62006-01-08 01:03:32 -08001159 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001161
1162 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001163
1164 ret = enter(data, dentry);
1165 switch (ret) {
1166 case D_WALK_CONTINUE:
1167 break;
1168 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001169 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001170 goto out_unlock;
1171 case D_WALK_NORETRY:
1172 retry = false;
1173 break;
1174 case D_WALK_SKIP:
1175 spin_unlock(&dentry->d_lock);
1176 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001177 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001178
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001180 spin_unlock(&this_parent->d_lock);
1181 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001183 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 goto repeat;
1185 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001186 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 }
1188 /*
1189 * All done at this level ... ascend and resume the search.
1190 */
1191 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001192 struct dentry *child = this_parent;
Al Viro48f5ec22013-09-09 15:22:25 -04001193 this_parent = try_to_ascend(this_parent, seq);
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001194 if (!this_parent)
Nick Piggin949854d2011-01-07 17:49:37 +11001195 goto rename_retry;
Nick Piggin949854d2011-01-07 17:49:37 +11001196 next = child->d_u.d_child.next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 goto resume;
1198 }
Al Viro48f5ec22013-09-09 15:22:25 -04001199 if (need_seqretry(&rename_lock, seq)) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001200 spin_unlock(&this_parent->d_lock);
1201 goto rename_retry;
1202 }
1203 if (finish)
1204 finish(data);
1205
1206out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001207 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001208 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001209 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001210
1211rename_retry:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001212 if (!retry)
1213 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001214 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001215 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001217
1218/*
1219 * Search for at least 1 mount point in the dentry's subdirs.
1220 * We descend to the next level whenever the d_subdirs
1221 * list is non-empty and continue searching.
1222 */
1223
1224/**
1225 * have_submounts - check for mounts over a dentry
1226 * @parent: dentry to check.
1227 *
1228 * Return true if the parent or its subdirectories contain
1229 * a mount point
1230 */
1231
1232static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1233{
1234 int *ret = data;
1235 if (d_mountpoint(dentry)) {
1236 *ret = 1;
1237 return D_WALK_QUIT;
1238 }
1239 return D_WALK_CONTINUE;
1240}
1241
1242int have_submounts(struct dentry *parent)
1243{
1244 int ret = 0;
1245
1246 d_walk(parent, &ret, check_mount, NULL);
1247
1248 return ret;
1249}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001250EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251
1252/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001253 * Called by mount code to set a mountpoint and check if the mountpoint is
1254 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1255 * subtree can become unreachable).
1256 *
1257 * Only one of check_submounts_and_drop() and d_set_mounted() must succeed. For
1258 * this reason take rename_lock and d_lock on dentry and ancestors.
1259 */
1260int d_set_mounted(struct dentry *dentry)
1261{
1262 struct dentry *p;
1263 int ret = -ENOENT;
1264 write_seqlock(&rename_lock);
1265 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
1266 /* Need exclusion wrt. check_submounts_and_drop() */
1267 spin_lock(&p->d_lock);
1268 if (unlikely(d_unhashed(p))) {
1269 spin_unlock(&p->d_lock);
1270 goto out;
1271 }
1272 spin_unlock(&p->d_lock);
1273 }
1274 spin_lock(&dentry->d_lock);
1275 if (!d_unlinked(dentry)) {
1276 dentry->d_flags |= DCACHE_MOUNTED;
1277 ret = 0;
1278 }
1279 spin_unlock(&dentry->d_lock);
1280out:
1281 write_sequnlock(&rename_lock);
1282 return ret;
1283}
1284
1285/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001286 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287 * and move any unused dentries to the end of the unused
1288 * list for prune_dcache(). We descend to the next level
1289 * whenever the d_subdirs list is non-empty and continue
1290 * searching.
1291 *
1292 * It returns zero iff there are no unused children,
1293 * otherwise it returns the number of children moved to
1294 * the end of the unused list. This may not be the total
1295 * number of unused children, because select_parent can
1296 * drop the lock and return early due to latency
1297 * constraints.
1298 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001299
1300struct select_data {
1301 struct dentry *start;
1302 struct list_head dispose;
1303 int found;
1304};
1305
1306static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001308 struct select_data *data = _data;
1309 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001311 if (data->start == dentry)
1312 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001314 /*
1315 * move only zero ref count dentries to the dispose list.
1316 *
1317 * Those which are presently on the shrink list, being processed
1318 * by shrink_dentry_list(), shouldn't be moved. Otherwise the
1319 * loop in shrink_dcache_parent() might not make any progress
1320 * and loop forever.
1321 */
1322 if (dentry->d_lockref.count) {
1323 dentry_lru_del(dentry);
1324 } else if (!(dentry->d_flags & DCACHE_SHRINK_LIST)) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001325 /*
1326 * We can't use d_lru_shrink_move() because we
1327 * need to get the global LRU lock and do the
Linus Torvalds05a82522013-09-15 07:11:01 -04001328 * LRU accounting.
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001329 */
1330 d_lru_del(dentry);
1331 d_shrink_add(dentry, &data->dispose);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001332 data->found++;
1333 ret = D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334 }
1335 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001336 * We can return to the caller if we have found some (this
1337 * ensures forward progress). We'll be coming back to find
1338 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001340 if (data->found && need_resched())
1341 ret = D_WALK_QUIT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001343 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344}
1345
1346/**
1347 * shrink_dcache_parent - prune dcache
1348 * @parent: parent of entries to prune
1349 *
1350 * Prune the dcache to remove unused children of the parent dentry.
1351 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001352void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001354 for (;;) {
1355 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001357 INIT_LIST_HEAD(&data.dispose);
1358 data.start = parent;
1359 data.found = 0;
1360
1361 d_walk(parent, &data, select_collect, NULL);
1362 if (!data.found)
1363 break;
1364
1365 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001366 cond_resched();
1367 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001369EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370
Al Viro42c32602013-11-08 12:31:16 -05001371static enum d_walk_ret umount_collect(void *_data, struct dentry *dentry)
1372{
1373 struct select_data *data = _data;
1374 enum d_walk_ret ret = D_WALK_CONTINUE;
1375
1376 if (dentry->d_lockref.count) {
1377 dentry_lru_del(dentry);
1378 if (likely(!list_empty(&dentry->d_subdirs)))
1379 goto out;
1380 if (dentry == data->start && dentry->d_lockref.count == 1)
1381 goto out;
1382 printk(KERN_ERR
1383 "BUG: Dentry %p{i=%lx,n=%s}"
1384 " still in use (%d)"
1385 " [unmount of %s %s]\n",
1386 dentry,
1387 dentry->d_inode ?
1388 dentry->d_inode->i_ino : 0UL,
1389 dentry->d_name.name,
1390 dentry->d_lockref.count,
1391 dentry->d_sb->s_type->name,
1392 dentry->d_sb->s_id);
1393 BUG();
1394 } else if (!(dentry->d_flags & DCACHE_SHRINK_LIST)) {
1395 /*
1396 * We can't use d_lru_shrink_move() because we
1397 * need to get the global LRU lock and do the
1398 * LRU accounting.
1399 */
1400 if (dentry->d_flags & DCACHE_LRU_LIST)
1401 d_lru_del(dentry);
1402 d_shrink_add(dentry, &data->dispose);
1403 data->found++;
1404 ret = D_WALK_NORETRY;
1405 }
1406out:
1407 if (data->found && need_resched())
1408 ret = D_WALK_QUIT;
1409 return ret;
1410}
1411
1412/*
1413 * destroy the dentries attached to a superblock on unmounting
1414 */
1415void shrink_dcache_for_umount(struct super_block *sb)
1416{
1417 struct dentry *dentry;
1418
1419 if (down_read_trylock(&sb->s_umount))
1420 BUG();
1421
1422 dentry = sb->s_root;
1423 sb->s_root = NULL;
1424 for (;;) {
1425 struct select_data data;
1426
1427 INIT_LIST_HEAD(&data.dispose);
1428 data.start = dentry;
1429 data.found = 0;
1430
1431 d_walk(dentry, &data, umount_collect, NULL);
1432 if (!data.found)
1433 break;
1434
1435 shrink_dentry_list(&data.dispose);
1436 cond_resched();
1437 }
1438 d_drop(dentry);
1439 dput(dentry);
1440
1441 while (!hlist_bl_empty(&sb->s_anon)) {
1442 struct select_data data;
1443 dentry = hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash);
1444
1445 INIT_LIST_HEAD(&data.dispose);
1446 data.start = NULL;
1447 data.found = 0;
1448
1449 d_walk(dentry, &data, umount_collect, NULL);
1450 if (data.found)
1451 shrink_dentry_list(&data.dispose);
1452 cond_resched();
1453 }
1454}
1455
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001456static enum d_walk_ret check_and_collect(void *_data, struct dentry *dentry)
1457{
1458 struct select_data *data = _data;
1459
1460 if (d_mountpoint(dentry)) {
1461 data->found = -EBUSY;
1462 return D_WALK_QUIT;
1463 }
1464
1465 return select_collect(_data, dentry);
1466}
1467
1468static void check_and_drop(void *_data)
1469{
1470 struct select_data *data = _data;
1471
1472 if (d_mountpoint(data->start))
1473 data->found = -EBUSY;
1474 if (!data->found)
1475 __d_drop(data->start);
1476}
1477
1478/**
1479 * check_submounts_and_drop - prune dcache, check for submounts and drop
1480 *
1481 * All done as a single atomic operation relative to has_unlinked_ancestor().
1482 * Returns 0 if successfully unhashed @parent. If there were submounts then
1483 * return -EBUSY.
1484 *
1485 * @dentry: dentry to prune and drop
1486 */
1487int check_submounts_and_drop(struct dentry *dentry)
1488{
1489 int ret = 0;
1490
1491 /* Negative dentries can be dropped without further checks */
1492 if (!dentry->d_inode) {
1493 d_drop(dentry);
1494 goto out;
1495 }
1496
1497 for (;;) {
1498 struct select_data data;
1499
1500 INIT_LIST_HEAD(&data.dispose);
1501 data.start = dentry;
1502 data.found = 0;
1503
1504 d_walk(dentry, &data, check_and_collect, check_and_drop);
1505 ret = data.found;
1506
1507 if (!list_empty(&data.dispose))
1508 shrink_dentry_list(&data.dispose);
1509
1510 if (ret <= 0)
1511 break;
1512
1513 cond_resched();
1514 }
1515
1516out:
1517 return ret;
1518}
1519EXPORT_SYMBOL(check_submounts_and_drop);
1520
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521/**
Al Viroa4464db2011-07-07 15:03:58 -04001522 * __d_alloc - allocate a dcache entry
1523 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 * @name: qstr of the name
1525 *
1526 * Allocates a dentry. It returns %NULL if there is insufficient memory
1527 * available. On a success the dentry is returned. The name passed in is
1528 * copied and the copy passed in may be reused after this call.
1529 */
1530
Al Viroa4464db2011-07-07 15:03:58 -04001531struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532{
1533 struct dentry *dentry;
1534 char *dname;
1535
Mel Gormane12ba742007-10-16 01:25:52 -07001536 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537 if (!dentry)
1538 return NULL;
1539
Linus Torvalds6326c712012-05-21 16:14:04 -07001540 /*
1541 * We guarantee that the inline name is always NUL-terminated.
1542 * This way the memcpy() done by the name switching in rename
1543 * will still always have a NUL at the end, even if we might
1544 * be overwriting an internal NUL character
1545 */
1546 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 if (name->len > DNAME_INLINE_LEN-1) {
1548 dname = kmalloc(name->len + 1, GFP_KERNEL);
1549 if (!dname) {
1550 kmem_cache_free(dentry_cache, dentry);
1551 return NULL;
1552 }
1553 } else {
1554 dname = dentry->d_iname;
1555 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556
1557 dentry->d_name.len = name->len;
1558 dentry->d_name.hash = name->hash;
1559 memcpy(dname, name->name, name->len);
1560 dname[name->len] = 0;
1561
Linus Torvalds6326c712012-05-21 16:14:04 -07001562 /* Make sure we always see the terminating NUL character */
1563 smp_wmb();
1564 dentry->d_name.name = dname;
1565
Waiman Long98474232013-08-28 18:24:59 -07001566 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001567 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001569 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001571 dentry->d_parent = dentry;
1572 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 dentry->d_op = NULL;
1574 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001575 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 INIT_LIST_HEAD(&dentry->d_lru);
1577 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Virob3d9b7a2012-06-09 13:51:19 -04001578 INIT_HLIST_NODE(&dentry->d_alias);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001579 INIT_LIST_HEAD(&dentry->d_u.d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001580 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581
Nick Piggin3e880fb2011-01-07 17:49:19 +11001582 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001583
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 return dentry;
1585}
Al Viroa4464db2011-07-07 15:03:58 -04001586
1587/**
1588 * d_alloc - allocate a dcache entry
1589 * @parent: parent of entry to allocate
1590 * @name: qstr of the name
1591 *
1592 * Allocates a dentry. It returns %NULL if there is insufficient memory
1593 * available. On a success the dentry is returned. The name passed in is
1594 * copied and the copy passed in may be reused after this call.
1595 */
1596struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1597{
1598 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1599 if (!dentry)
1600 return NULL;
1601
1602 spin_lock(&parent->d_lock);
1603 /*
1604 * don't need child lock because it is not subject
1605 * to concurrency here
1606 */
1607 __dget_dlock(parent);
1608 dentry->d_parent = parent;
1609 list_add(&dentry->d_u.d_child, &parent->d_subdirs);
1610 spin_unlock(&parent->d_lock);
1611
1612 return dentry;
1613}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001614EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615
Nick Piggin4b936882011-01-07 17:50:07 +11001616struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1617{
Al Viroa4464db2011-07-07 15:03:58 -04001618 struct dentry *dentry = __d_alloc(sb, name);
1619 if (dentry)
Nick Piggin4b936882011-01-07 17:50:07 +11001620 dentry->d_flags |= DCACHE_DISCONNECTED;
Nick Piggin4b936882011-01-07 17:50:07 +11001621 return dentry;
1622}
1623EXPORT_SYMBOL(d_alloc_pseudo);
1624
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1626{
1627 struct qstr q;
1628
1629 q.name = name;
1630 q.len = strlen(name);
1631 q.hash = full_name_hash(q.name, q.len);
1632 return d_alloc(parent, &q);
1633}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001634EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635
Nick Pigginfb045ad2011-01-07 17:49:55 +11001636void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1637{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001638 WARN_ON_ONCE(dentry->d_op);
1639 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001640 DCACHE_OP_COMPARE |
1641 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001642 DCACHE_OP_WEAK_REVALIDATE |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001643 DCACHE_OP_DELETE ));
1644 dentry->d_op = op;
1645 if (!op)
1646 return;
1647 if (op->d_hash)
1648 dentry->d_flags |= DCACHE_OP_HASH;
1649 if (op->d_compare)
1650 dentry->d_flags |= DCACHE_OP_COMPARE;
1651 if (op->d_revalidate)
1652 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001653 if (op->d_weak_revalidate)
1654 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001655 if (op->d_delete)
1656 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001657 if (op->d_prune)
1658 dentry->d_flags |= DCACHE_OP_PRUNE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001659
1660}
1661EXPORT_SYMBOL(d_set_d_op);
1662
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001663static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1664{
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001665 spin_lock(&dentry->d_lock);
David Howells9875cf82011-01-14 18:45:21 +00001666 if (inode) {
1667 if (unlikely(IS_AUTOMOUNT(inode)))
1668 dentry->d_flags |= DCACHE_NEED_AUTOMOUNT;
Al Virob3d9b7a2012-06-09 13:51:19 -04001669 hlist_add_head(&dentry->d_alias, &inode->i_dentry);
David Howells9875cf82011-01-14 18:45:21 +00001670 }
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001671 dentry->d_inode = inode;
Nick Piggin31e6b012011-01-07 17:49:52 +11001672 dentry_rcuwalk_barrier(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001673 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001674 fsnotify_d_instantiate(dentry, inode);
1675}
1676
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677/**
1678 * d_instantiate - fill in inode information for a dentry
1679 * @entry: dentry to complete
1680 * @inode: inode to attach to this dentry
1681 *
1682 * Fill in inode information in the entry.
1683 *
1684 * This turns negative dentries into productive full members
1685 * of society.
1686 *
1687 * NOTE! This assumes that the inode count has been incremented
1688 * (or otherwise set) by the caller to indicate that it is now
1689 * in use by the dcache.
1690 */
1691
1692void d_instantiate(struct dentry *entry, struct inode * inode)
1693{
Al Virob3d9b7a2012-06-09 13:51:19 -04001694 BUG_ON(!hlist_unhashed(&entry->d_alias));
Nick Piggin873feea2011-01-07 17:50:06 +11001695 if (inode)
1696 spin_lock(&inode->i_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001697 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001698 if (inode)
1699 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700 security_d_instantiate(entry, inode);
1701}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001702EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703
1704/**
1705 * d_instantiate_unique - instantiate a non-aliased dentry
1706 * @entry: dentry to instantiate
1707 * @inode: inode to attach to this dentry
1708 *
1709 * Fill in inode information in the entry. On success, it returns NULL.
1710 * If an unhashed alias of "entry" already exists, then we return the
Oleg Drokine866cfa2006-01-09 20:52:51 -08001711 * aliased dentry instead and drop one reference to inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 *
1713 * Note that in order to avoid conflicts with rename() etc, the caller
1714 * had better be holding the parent directory semaphore.
Oleg Drokine866cfa2006-01-09 20:52:51 -08001715 *
1716 * This also assumes that the inode count has been incremented
1717 * (or otherwise set) by the caller to indicate that it is now
1718 * in use by the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 */
David Howells770bfad2006-08-22 20:06:07 -04001720static struct dentry *__d_instantiate_unique(struct dentry *entry,
1721 struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722{
1723 struct dentry *alias;
1724 int len = entry->d_name.len;
1725 const char *name = entry->d_name.name;
1726 unsigned int hash = entry->d_name.hash;
1727
David Howells770bfad2006-08-22 20:06:07 -04001728 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001729 __d_instantiate(entry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001730 return NULL;
1731 }
1732
Sasha Levinb67bfe02013-02-27 17:06:00 -08001733 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Piggin9abca362011-01-07 17:49:36 +11001734 /*
1735 * Don't need alias->d_lock here, because aliases with
1736 * d_parent == entry->d_parent are not subject to name or
1737 * parent changes, because the parent inode i_mutex is held.
1738 */
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001739 if (alias->d_name.hash != hash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 continue;
1741 if (alias->d_parent != entry->d_parent)
1742 continue;
Linus Torvaldsee983e82012-05-10 12:37:10 -07001743 if (alias->d_name.len != len)
1744 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001745 if (dentry_cmp(alias, name, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 continue;
Nick Piggindc0474b2011-01-07 17:49:43 +11001747 __dget(alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 return alias;
1749 }
David Howells770bfad2006-08-22 20:06:07 -04001750
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001751 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752 return NULL;
1753}
David Howells770bfad2006-08-22 20:06:07 -04001754
1755struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1756{
1757 struct dentry *result;
1758
Al Virob3d9b7a2012-06-09 13:51:19 -04001759 BUG_ON(!hlist_unhashed(&entry->d_alias));
David Howells770bfad2006-08-22 20:06:07 -04001760
Nick Piggin873feea2011-01-07 17:50:06 +11001761 if (inode)
1762 spin_lock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001763 result = __d_instantiate_unique(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001764 if (inode)
1765 spin_unlock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001766
1767 if (!result) {
1768 security_d_instantiate(entry, inode);
1769 return NULL;
1770 }
1771
1772 BUG_ON(!d_unhashed(result));
1773 iput(inode);
1774 return result;
1775}
1776
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777EXPORT_SYMBOL(d_instantiate_unique);
1778
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001779/**
1780 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1781 * @entry: dentry to complete
1782 * @inode: inode to attach to this dentry
1783 *
1784 * Fill in inode information in the entry. If a directory alias is found, then
1785 * return an error (and drop inode). Together with d_materialise_unique() this
1786 * guarantees that a directory inode may never have more than one alias.
1787 */
1788int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1789{
1790 BUG_ON(!hlist_unhashed(&entry->d_alias));
1791
1792 spin_lock(&inode->i_lock);
1793 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1794 spin_unlock(&inode->i_lock);
1795 iput(inode);
1796 return -EBUSY;
1797 }
1798 __d_instantiate(entry, inode);
1799 spin_unlock(&inode->i_lock);
1800 security_d_instantiate(entry, inode);
1801
1802 return 0;
1803}
1804EXPORT_SYMBOL(d_instantiate_no_diralias);
1805
Al Viroadc0e912012-01-08 16:49:21 -05001806struct dentry *d_make_root(struct inode *root_inode)
1807{
1808 struct dentry *res = NULL;
1809
1810 if (root_inode) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07001811 static const struct qstr name = QSTR_INIT("/", 1);
Al Viroadc0e912012-01-08 16:49:21 -05001812
1813 res = __d_alloc(root_inode->i_sb, &name);
1814 if (res)
1815 d_instantiate(res, root_inode);
1816 else
1817 iput(root_inode);
1818 }
1819 return res;
1820}
1821EXPORT_SYMBOL(d_make_root);
1822
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001823static struct dentry * __d_find_any_alias(struct inode *inode)
1824{
1825 struct dentry *alias;
1826
Al Virob3d9b7a2012-06-09 13:51:19 -04001827 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001828 return NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001829 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001830 __dget(alias);
1831 return alias;
1832}
1833
Sage Weil46f72b32012-01-10 09:04:37 -08001834/**
1835 * d_find_any_alias - find any alias for a given inode
1836 * @inode: inode to find an alias for
1837 *
1838 * If any aliases exist for the given inode, take and return a
1839 * reference for one of them. If no aliases exist, return %NULL.
1840 */
1841struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001842{
1843 struct dentry *de;
1844
1845 spin_lock(&inode->i_lock);
1846 de = __d_find_any_alias(inode);
1847 spin_unlock(&inode->i_lock);
1848 return de;
1849}
Sage Weil46f72b32012-01-10 09:04:37 -08001850EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001851
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852/**
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001853 * d_obtain_alias - find or allocate a dentry for a given inode
1854 * @inode: inode to allocate the dentry for
1855 *
1856 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1857 * similar open by handle operations. The returned dentry may be anonymous,
1858 * or may have a full name (if the inode was already in the cache).
1859 *
1860 * When called on a directory inode, we must ensure that the inode only ever
1861 * has one dentry. If a dentry is found, that is returned instead of
1862 * allocating a new one.
1863 *
1864 * On successful return, the reference to the inode has been transferred
Christoph Hellwig44003722008-08-11 15:49:04 +02001865 * to the dentry. In case of an error the reference on the inode is released.
1866 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1867 * be passed in and will be the error will be propagate to the return value,
1868 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001869 */
1870struct dentry *d_obtain_alias(struct inode *inode)
1871{
NeilBrownb911a6b2012-11-08 16:09:37 -08001872 static const struct qstr anonstring = QSTR_INIT("/", 1);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001873 struct dentry *tmp;
1874 struct dentry *res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001875
1876 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001877 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001878 if (IS_ERR(inode))
1879 return ERR_CAST(inode);
1880
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001881 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001882 if (res)
1883 goto out_iput;
1884
Al Viroa4464db2011-07-07 15:03:58 -04001885 tmp = __d_alloc(inode->i_sb, &anonstring);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001886 if (!tmp) {
1887 res = ERR_PTR(-ENOMEM);
1888 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001889 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001890
Nick Piggin873feea2011-01-07 17:50:06 +11001891 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001892 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001893 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001894 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001895 dput(tmp);
1896 goto out_iput;
1897 }
1898
1899 /* attach a disconnected dentry */
1900 spin_lock(&tmp->d_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001901 tmp->d_inode = inode;
1902 tmp->d_flags |= DCACHE_DISCONNECTED;
Al Virob3d9b7a2012-06-09 13:51:19 -04001903 hlist_add_head(&tmp->d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001904 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001905 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001906 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001907 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001908 spin_unlock(&inode->i_lock);
Josef Bacik24ff6662010-11-18 20:52:55 -05001909 security_d_instantiate(tmp, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001910
Christoph Hellwig9308a612008-08-11 15:49:12 +02001911 return tmp;
1912
1913 out_iput:
Josef Bacik24ff6662010-11-18 20:52:55 -05001914 if (res && !IS_ERR(res))
1915 security_d_instantiate(res, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001916 iput(inode);
1917 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001918}
Benny Halevyadc48722009-02-27 14:02:59 -08001919EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920
1921/**
1922 * d_splice_alias - splice a disconnected dentry into the tree if one exists
1923 * @inode: the inode which may have a disconnected dentry
1924 * @dentry: a negative dentry which we want to point to the inode.
1925 *
1926 * If inode is a directory and has a 'disconnected' dentry (i.e. IS_ROOT and
1927 * DCACHE_DISCONNECTED), then d_move that in place of the given dentry
1928 * and return it, else simply d_add the inode to the dentry and return NULL.
1929 *
1930 * This is needed in the lookup routine of any filesystem that is exportable
1931 * (via knfsd) so that we can build dcache paths to directories effectively.
1932 *
1933 * If a dentry was found and moved, then it is returned. Otherwise NULL
1934 * is returned. This matches the expected return value of ->lookup.
1935 *
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001936 * Cluster filesystems may call this function with a negative, hashed dentry.
1937 * In that case, we know that the inode will be a regular file, and also this
1938 * will only occur during atomic_open. So we need to check for the dentry
1939 * being already hashed only in the final case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 */
1941struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
1942{
1943 struct dentry *new = NULL;
1944
Al Viroa9049372011-07-08 21:20:11 -04001945 if (IS_ERR(inode))
1946 return ERR_CAST(inode);
1947
NeilBrown21c0d8f2006-10-04 02:16:16 -07001948 if (inode && S_ISDIR(inode->i_mode)) {
Nick Piggin873feea2011-01-07 17:50:06 +11001949 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001950 new = __d_find_alias(inode, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951 if (new) {
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001952 BUG_ON(!(new->d_flags & DCACHE_DISCONNECTED));
Nick Piggin873feea2011-01-07 17:50:06 +11001953 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 security_d_instantiate(new, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955 d_move(new, dentry);
1956 iput(inode);
1957 } else {
Nick Piggin873feea2011-01-07 17:50:06 +11001958 /* already taking inode->i_lock, so d_add() by hand */
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001959 __d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001960 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 security_d_instantiate(dentry, inode);
1962 d_rehash(dentry);
1963 }
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001964 } else {
1965 d_instantiate(dentry, inode);
1966 if (d_unhashed(dentry))
1967 d_rehash(dentry);
1968 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969 return new;
1970}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001971EXPORT_SYMBOL(d_splice_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972
Barry Naujok94035402008-05-21 16:50:46 +10001973/**
1974 * d_add_ci - lookup or allocate new dentry with case-exact name
1975 * @inode: the inode case-insensitive lookup has found
1976 * @dentry: the negative dentry that was passed to the parent's lookup func
1977 * @name: the case-exact name to be associated with the returned dentry
1978 *
1979 * This is to avoid filling the dcache with case-insensitive names to the
1980 * same inode, only the actual correct case is stored in the dcache for
1981 * case-insensitive filesystems.
1982 *
1983 * For a case-insensitive lookup match and if the the case-exact dentry
1984 * already exists in in the dcache, use it and return it.
1985 *
1986 * If no entry exists with the exact case name, allocate new dentry with
1987 * the exact case, and return the spliced entry.
1988 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001989struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001990 struct qstr *name)
1991{
Barry Naujok94035402008-05-21 16:50:46 +10001992 struct dentry *found;
1993 struct dentry *new;
1994
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001995 /*
1996 * First check if a dentry matching the name already exists,
1997 * if not go ahead and create it now.
1998 */
Barry Naujok94035402008-05-21 16:50:46 +10001999 found = d_hash_and_lookup(dentry->d_parent, name);
Al Viro4f522a22013-02-11 23:20:37 -05002000 if (unlikely(IS_ERR(found)))
2001 goto err_out;
Barry Naujok94035402008-05-21 16:50:46 +10002002 if (!found) {
2003 new = d_alloc(dentry->d_parent, name);
2004 if (!new) {
Al Viro4f522a22013-02-11 23:20:37 -05002005 found = ERR_PTR(-ENOMEM);
Barry Naujok94035402008-05-21 16:50:46 +10002006 goto err_out;
2007 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002008
Barry Naujok94035402008-05-21 16:50:46 +10002009 found = d_splice_alias(inode, new);
2010 if (found) {
2011 dput(new);
2012 return found;
2013 }
2014 return new;
2015 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002016
2017 /*
2018 * If a matching dentry exists, and it's not negative use it.
2019 *
2020 * Decrement the reference count to balance the iget() done
2021 * earlier on.
2022 */
Barry Naujok94035402008-05-21 16:50:46 +10002023 if (found->d_inode) {
2024 if (unlikely(found->d_inode != inode)) {
2025 /* This can't happen because bad inodes are unhashed. */
2026 BUG_ON(!is_bad_inode(inode));
2027 BUG_ON(!is_bad_inode(found->d_inode));
2028 }
Barry Naujok94035402008-05-21 16:50:46 +10002029 iput(inode);
2030 return found;
2031 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002032
Barry Naujok94035402008-05-21 16:50:46 +10002033 /*
2034 * Negative dentry: instantiate it unless the inode is a directory and
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002035 * already has a dentry.
Barry Naujok94035402008-05-21 16:50:46 +10002036 */
Al Viro4513d892011-07-17 10:52:14 -04002037 new = d_splice_alias(inode, found);
2038 if (new) {
2039 dput(found);
2040 found = new;
Barry Naujok94035402008-05-21 16:50:46 +10002041 }
Al Viro4513d892011-07-17 10:52:14 -04002042 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002043
2044err_out:
2045 iput(inode);
Al Viro4f522a22013-02-11 23:20:37 -05002046 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002047}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002048EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002050/*
2051 * Do the slow-case of the dentry name compare.
2052 *
2053 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07002054 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002055 * filesystem can rely on them, and can use the 'name' and
2056 * 'len' information without worrying about walking off the
2057 * end of memory etc.
2058 *
2059 * Thus the read_seqcount_retry() and the "duplicate" info
2060 * in arguments (the low-level filesystem should not look
2061 * at the dentry inode or name contents directly, since
2062 * rename can change them while we're in RCU mode).
2063 */
2064enum slow_d_compare {
2065 D_COMP_OK,
2066 D_COMP_NOMATCH,
2067 D_COMP_SEQRETRY,
2068};
2069
2070static noinline enum slow_d_compare slow_dentry_cmp(
2071 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002072 struct dentry *dentry,
2073 unsigned int seq,
2074 const struct qstr *name)
2075{
2076 int tlen = dentry->d_name.len;
2077 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002078
2079 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2080 cpu_relax();
2081 return D_COMP_SEQRETRY;
2082 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002083 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002084 return D_COMP_NOMATCH;
2085 return D_COMP_OK;
2086}
2087
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002089 * __d_lookup_rcu - search for a dentry (racy, store-free)
2090 * @parent: parent dentry
2091 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002092 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002093 * Returns: dentry, or NULL
2094 *
2095 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2096 * resolution (store-free path walking) design described in
2097 * Documentation/filesystems/path-lookup.txt.
2098 *
2099 * This is not to be used outside core vfs.
2100 *
2101 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2102 * held, and rcu_read_lock held. The returned dentry must not be stored into
2103 * without taking d_lock and checking d_seq sequence count against @seq
2104 * returned here.
2105 *
Linus Torvalds15570082013-09-02 11:38:06 -07002106 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002107 * function.
2108 *
2109 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2110 * the returned dentry, so long as its parent's seqlock is checked after the
2111 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2112 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002113 *
2114 * NOTE! The caller *has* to check the resulting dentry against the sequence
2115 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002116 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002117struct dentry *__d_lookup_rcu(const struct dentry *parent,
2118 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002119 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002120{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002121 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002122 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002123 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002124 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002125 struct dentry *dentry;
2126
2127 /*
2128 * Note: There is significant duplication with __d_lookup_rcu which is
2129 * required to prevent single threaded performance regressions
2130 * especially on architectures where smp_rmb (in seqcounts) are costly.
2131 * Keep the two functions in sync.
2132 */
2133
2134 /*
2135 * The hash list is protected using RCU.
2136 *
2137 * Carefully use d_seq when comparing a candidate dentry, to avoid
2138 * races with d_move().
2139 *
2140 * It is possible that concurrent renames can mess up our list
2141 * walk here and result in missing our dentry, resulting in the
2142 * false-negative result. d_lookup() protects against concurrent
2143 * renames using rename_lock seqlock.
2144 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002145 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002146 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002147 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002148 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002149
Nick Piggin31e6b012011-01-07 17:49:52 +11002150seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002151 /*
2152 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002153 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002154 *
2155 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002156 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002157 *
2158 * NOTE! We do a "raw" seqcount_begin here. That means that
2159 * we don't wait for the sequence count to stabilize if it
2160 * is in the middle of a sequence change. If we do the slow
2161 * dentry compare, we will do seqretries until it is stable,
2162 * and if we end up with a successful lookup, we actually
2163 * want to exit RCU lookup anyway.
2164 */
2165 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002166 if (dentry->d_parent != parent)
2167 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002168 if (d_unhashed(dentry))
2169 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002170
2171 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002172 if (dentry->d_name.hash != hashlen_hash(hashlen))
2173 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002174 *seqp = seq;
2175 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002176 case D_COMP_OK:
2177 return dentry;
2178 case D_COMP_NOMATCH:
2179 continue;
2180 default:
2181 goto seqretry;
2182 }
2183 }
2184
Linus Torvalds26fe5752012-05-10 13:14:12 -07002185 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002186 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002187 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002188 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002189 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002190 }
2191 return NULL;
2192}
2193
2194/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 * d_lookup - search for a dentry
2196 * @parent: parent dentry
2197 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002198 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002200 * d_lookup searches the children of the parent dentry for the name in
2201 * question. If the dentry is found its reference count is incremented and the
2202 * dentry is returned. The caller must use dput to free the entry when it has
2203 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 */
Al Viroda2d8452013-01-24 18:29:34 -05002205struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206{
Nick Piggin31e6b012011-01-07 17:49:52 +11002207 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002208 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209
2210 do {
2211 seq = read_seqbegin(&rename_lock);
2212 dentry = __d_lookup(parent, name);
2213 if (dentry)
2214 break;
2215 } while (read_seqretry(&rename_lock, seq));
2216 return dentry;
2217}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002218EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219
Nick Piggin31e6b012011-01-07 17:49:52 +11002220/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002221 * __d_lookup - search for a dentry (racy)
2222 * @parent: parent dentry
2223 * @name: qstr of name we wish to find
2224 * Returns: dentry, or NULL
2225 *
2226 * __d_lookup is like d_lookup, however it may (rarely) return a
2227 * false-negative result due to unrelated rename activity.
2228 *
2229 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2230 * however it must be used carefully, eg. with a following d_lookup in
2231 * the case of failure.
2232 *
2233 * __d_lookup callers must be commented.
2234 */
Al Viroa713ca22013-01-24 18:27:00 -05002235struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236{
2237 unsigned int len = name->len;
2238 unsigned int hash = name->hash;
2239 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002240 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002241 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002242 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002243 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244
Nick Pigginb04f7842010-08-18 04:37:34 +10002245 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002246 * Note: There is significant duplication with __d_lookup_rcu which is
2247 * required to prevent single threaded performance regressions
2248 * especially on architectures where smp_rmb (in seqcounts) are costly.
2249 * Keep the two functions in sync.
2250 */
2251
2252 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002253 * The hash list is protected using RCU.
2254 *
2255 * Take d_lock when comparing a candidate dentry, to avoid races
2256 * with d_move().
2257 *
2258 * It is possible that concurrent renames can mess up our list
2259 * walk here and result in missing our dentry, resulting in the
2260 * false-negative result. d_lookup() protects against concurrent
2261 * renames using rename_lock seqlock.
2262 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002263 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002264 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 rcu_read_lock();
2266
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002267 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269 if (dentry->d_name.hash != hash)
2270 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271
2272 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273 if (dentry->d_parent != parent)
2274 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002275 if (d_unhashed(dentry))
2276 goto next;
2277
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 /*
2279 * It is safe to compare names since d_move() cannot
2280 * change the qstr (protected by d_lock).
2281 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002282 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002283 int tlen = dentry->d_name.len;
2284 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002285 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286 goto next;
2287 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002288 if (dentry->d_name.len != len)
2289 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002290 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 goto next;
2292 }
2293
Waiman Long98474232013-08-28 18:24:59 -07002294 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002295 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296 spin_unlock(&dentry->d_lock);
2297 break;
2298next:
2299 spin_unlock(&dentry->d_lock);
2300 }
2301 rcu_read_unlock();
2302
2303 return found;
2304}
2305
2306/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002307 * d_hash_and_lookup - hash the qstr then search for a dentry
2308 * @dir: Directory to search in
2309 * @name: qstr of name we wish to find
2310 *
Al Viro4f522a22013-02-11 23:20:37 -05002311 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002312 */
2313struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2314{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002315 /*
2316 * Check for a fs-specific hash function. Note that we must
2317 * calculate the standard hash first, as the d_op->d_hash()
2318 * routine may choose to leave the hash value unchanged.
2319 */
2320 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002321 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002322 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002323 if (unlikely(err < 0))
2324 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002325 }
Al Viro4f522a22013-02-11 23:20:37 -05002326 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002327}
Al Viro4f522a22013-02-11 23:20:37 -05002328EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002329
2330/**
Nick Piggin786a5e12011-01-07 17:49:16 +11002331 * d_validate - verify dentry provided from insecure source (deprecated)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 * @dentry: The dentry alleged to be valid child of @dparent
Randy Dunlapff5fdb62011-01-22 20:16:06 -08002333 * @dparent: The parent dentry (known to be valid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 *
2335 * An insecure source has sent us a dentry, here we verify it and dget() it.
2336 * This is used by ncpfs in its readdir implementation.
2337 * Zero is returned in the dentry is invalid.
Nick Piggin786a5e12011-01-07 17:49:16 +11002338 *
2339 * This function is slow for big directories, and deprecated, do not use it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340 */
Nick Piggind3a23e12011-01-05 20:01:21 +11002341int d_validate(struct dentry *dentry, struct dentry *dparent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342{
Nick Piggin786a5e12011-01-07 17:49:16 +11002343 struct dentry *child;
Nick Piggind3a23e12011-01-05 20:01:21 +11002344
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002345 spin_lock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002346 list_for_each_entry(child, &dparent->d_subdirs, d_u.d_child) {
2347 if (dentry == child) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002348 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Nick Piggindc0474b2011-01-07 17:49:43 +11002349 __dget_dlock(dentry);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002350 spin_unlock(&dentry->d_lock);
2351 spin_unlock(&dparent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352 return 1;
2353 }
2354 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002355 spin_unlock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002356
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357 return 0;
2358}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002359EXPORT_SYMBOL(d_validate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360
2361/*
2362 * When a file is deleted, we have two options:
2363 * - turn this dentry into a negative dentry
2364 * - unhash this dentry and free it.
2365 *
2366 * Usually, we want to just turn this into
2367 * a negative dentry, but if anybody else is
2368 * currently using the dentry or the inode
2369 * we can't do that and we fall back on removing
2370 * it from the hash queues and waiting for
2371 * it to be deleted later when it has no users
2372 */
2373
2374/**
2375 * d_delete - delete a dentry
2376 * @dentry: The dentry to delete
2377 *
2378 * Turn the dentry into a negative dentry if possible, otherwise
2379 * remove it from the hash queues so it can be deleted later
2380 */
2381
2382void d_delete(struct dentry * dentry)
2383{
Nick Piggin873feea2011-01-07 17:50:06 +11002384 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002385 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386 /*
2387 * Are we the only user?
2388 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002389again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002391 inode = dentry->d_inode;
2392 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002393 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002394 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002395 spin_unlock(&dentry->d_lock);
2396 cpu_relax();
2397 goto again;
2398 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002399 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002400 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002401 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402 return;
2403 }
2404
2405 if (!d_unhashed(dentry))
2406 __d_drop(dentry);
2407
2408 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002409
2410 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002412EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002414static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002416 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002417 hlist_bl_lock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -07002418 entry->d_flags |= DCACHE_RCUACCESS;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002419 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002420 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421}
2422
David Howells770bfad2006-08-22 20:06:07 -04002423static void _d_rehash(struct dentry * entry)
2424{
2425 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2426}
2427
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428/**
2429 * d_rehash - add an entry back to the hash
2430 * @entry: dentry to add to the hash
2431 *
2432 * Adds a dentry to the hash according to its name.
2433 */
2434
2435void d_rehash(struct dentry * entry)
2436{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002437 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002438 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002441EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002443/**
2444 * dentry_update_name_case - update case insensitive dentry with a new name
2445 * @dentry: dentry to be updated
2446 * @name: new name
2447 *
2448 * Update a case insensitive dentry with new case of name.
2449 *
2450 * dentry must have been returned by d_lookup with name @name. Old and new
2451 * name lengths must match (ie. no d_compare which allows mismatched name
2452 * lengths).
2453 *
2454 * Parent inode i_mutex must be held over d_lookup and into this call (to
2455 * keep renames and concurrent inserts, and readdir(2) away).
2456 */
2457void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2458{
Linus Torvalds7ebfa572011-04-15 07:34:26 -07002459 BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002460 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2461
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002462 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002463 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002464 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002465 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002466 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002467}
2468EXPORT_SYMBOL(dentry_update_name_case);
2469
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470static void switch_names(struct dentry *dentry, struct dentry *target)
2471{
2472 if (dname_external(target)) {
2473 if (dname_external(dentry)) {
2474 /*
2475 * Both external: swap the pointers
2476 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002477 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478 } else {
2479 /*
2480 * dentry:internal, target:external. Steal target's
2481 * storage and make target internal.
2482 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002483 memcpy(target->d_iname, dentry->d_name.name,
2484 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485 dentry->d_name.name = target->d_name.name;
2486 target->d_name.name = target->d_iname;
2487 }
2488 } else {
2489 if (dname_external(dentry)) {
2490 /*
2491 * dentry:external, target:internal. Give dentry's
2492 * storage to target and make dentry internal
2493 */
2494 memcpy(dentry->d_iname, target->d_name.name,
2495 target->d_name.len + 1);
2496 target->d_name.name = dentry->d_name.name;
2497 dentry->d_name.name = dentry->d_iname;
2498 } else {
2499 /*
2500 * Both are internal. Just copy target to dentry
2501 */
2502 memcpy(dentry->d_iname, target->d_name.name,
2503 target->d_name.len + 1);
Al Virodc711ca2008-11-03 15:03:50 -05002504 dentry->d_name.len = target->d_name.len;
2505 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506 }
2507 }
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002508 swap(dentry->d_name.len, target->d_name.len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509}
2510
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002511static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2512{
2513 /*
2514 * XXXX: do we really need to take target->d_lock?
2515 */
2516 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2517 spin_lock(&target->d_parent->d_lock);
2518 else {
2519 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2520 spin_lock(&dentry->d_parent->d_lock);
2521 spin_lock_nested(&target->d_parent->d_lock,
2522 DENTRY_D_LOCK_NESTED);
2523 } else {
2524 spin_lock(&target->d_parent->d_lock);
2525 spin_lock_nested(&dentry->d_parent->d_lock,
2526 DENTRY_D_LOCK_NESTED);
2527 }
2528 }
2529 if (target < dentry) {
2530 spin_lock_nested(&target->d_lock, 2);
2531 spin_lock_nested(&dentry->d_lock, 3);
2532 } else {
2533 spin_lock_nested(&dentry->d_lock, 2);
2534 spin_lock_nested(&target->d_lock, 3);
2535 }
2536}
2537
2538static void dentry_unlock_parents_for_move(struct dentry *dentry,
2539 struct dentry *target)
2540{
2541 if (target->d_parent != dentry->d_parent)
2542 spin_unlock(&dentry->d_parent->d_lock);
2543 if (target->d_parent != target)
2544 spin_unlock(&target->d_parent->d_lock);
2545}
2546
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002548 * When switching names, the actual string doesn't strictly have to
2549 * be preserved in the target - because we're dropping the target
2550 * anyway. As such, we can just do a simple memcpy() to copy over
2551 * the new name before we switch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002552 *
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002553 * Note that we have to be a lot more careful about getting the hash
2554 * switched - we have to switch the hash value properly even if it
2555 * then no longer matches the actual (corrupted) string of the target.
2556 * The hash value has to match the hash queue that the dentry is on..
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002558/*
Al Viro18367502011-07-12 21:42:24 -04002559 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560 * @dentry: entry to move
2561 * @target: new dentry
2562 *
2563 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002564 * dcache entries should not be moved in this way. Caller must hold
2565 * rename_lock, the i_mutex of the source and target directories,
2566 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002567 */
Al Viro18367502011-07-12 21:42:24 -04002568static void __d_move(struct dentry * dentry, struct dentry * target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570 if (!dentry->d_inode)
2571 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2572
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002573 BUG_ON(d_ancestor(dentry, target));
2574 BUG_ON(d_ancestor(target, dentry));
2575
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002576 dentry_lock_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002577
Nick Piggin31e6b012011-01-07 17:49:52 +11002578 write_seqcount_begin(&dentry->d_seq);
2579 write_seqcount_begin(&target->d_seq);
2580
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002581 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2582
2583 /*
2584 * Move the dentry to the target hash queue. Don't bother checking
2585 * for the same hash queue because of how unlikely it is.
2586 */
2587 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002588 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002589
2590 /* Unhash the target: dput() will then get rid of it */
2591 __d_drop(target);
2592
Eric Dumazet5160ee62006-01-08 01:03:32 -08002593 list_del(&dentry->d_u.d_child);
2594 list_del(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595
2596 /* Switch the names.. */
2597 switch_names(dentry, target);
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002598 swap(dentry->d_name.hash, target->d_name.hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002599
2600 /* ... and switch the parents */
2601 if (IS_ROOT(dentry)) {
2602 dentry->d_parent = target->d_parent;
2603 target->d_parent = target;
Eric Dumazet5160ee62006-01-08 01:03:32 -08002604 INIT_LIST_HEAD(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002605 } else {
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002606 swap(dentry->d_parent, target->d_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607
2608 /* And add them back to the (new) parent lists */
Eric Dumazet5160ee62006-01-08 01:03:32 -08002609 list_add(&target->d_u.d_child, &target->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002610 }
2611
Eric Dumazet5160ee62006-01-08 01:03:32 -08002612 list_add(&dentry->d_u.d_child, &dentry->d_parent->d_subdirs);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002613
Nick Piggin31e6b012011-01-07 17:49:52 +11002614 write_seqcount_end(&target->d_seq);
2615 write_seqcount_end(&dentry->d_seq);
2616
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002617 dentry_unlock_parents_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002618 spin_unlock(&target->d_lock);
Nick Pigginc32ccd82006-03-25 03:07:09 -08002619 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002621}
2622
2623/*
2624 * d_move - move a dentry
2625 * @dentry: entry to move
2626 * @target: new dentry
2627 *
2628 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002629 * dcache entries should not be moved in this way. See the locking
2630 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002631 */
2632void d_move(struct dentry *dentry, struct dentry *target)
2633{
2634 write_seqlock(&rename_lock);
2635 __d_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002637}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002638EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002640/**
2641 * d_ancestor - search for an ancestor
2642 * @p1: ancestor dentry
2643 * @p2: child dentry
2644 *
2645 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2646 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002647 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002648struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002649{
2650 struct dentry *p;
2651
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002652 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002653 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002654 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002655 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002656 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002657}
2658
2659/*
2660 * This helper attempts to cope with remotely renamed directories
2661 *
2662 * It assumes that the caller is already holding
Al Viro18367502011-07-12 21:42:24 -04002663 * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002664 *
2665 * Note: If ever the locking in lock_rename() changes, then please
2666 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002667 */
Nick Piggin873feea2011-01-07 17:50:06 +11002668static struct dentry *__d_unalias(struct inode *inode,
2669 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002670{
2671 struct mutex *m1 = NULL, *m2 = NULL;
Al Viroee3efa92012-06-08 15:59:33 -04002672 struct dentry *ret = ERR_PTR(-EBUSY);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002673
2674 /* If alias and dentry share a parent, then no extra locks required */
2675 if (alias->d_parent == dentry->d_parent)
2676 goto out_unalias;
2677
Trond Myklebust9eaef272006-10-21 10:24:20 -07002678 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002679 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2680 goto out_err;
2681 m1 = &dentry->d_sb->s_vfs_rename_mutex;
2682 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
2683 goto out_err;
2684 m2 = &alias->d_parent->d_inode->i_mutex;
2685out_unalias:
Al Viroee3efa92012-06-08 15:59:33 -04002686 if (likely(!d_mountpoint(alias))) {
2687 __d_move(alias, dentry);
2688 ret = alias;
2689 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002690out_err:
Nick Piggin873feea2011-01-07 17:50:06 +11002691 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002692 if (m2)
2693 mutex_unlock(m2);
2694 if (m1)
2695 mutex_unlock(m1);
2696 return ret;
2697}
2698
2699/*
David Howells770bfad2006-08-22 20:06:07 -04002700 * Prepare an anonymous dentry for life in the superblock's dentry tree as a
2701 * named dentry in place of the dentry to be replaced.
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002702 * returns with anon->d_lock held!
David Howells770bfad2006-08-22 20:06:07 -04002703 */
2704static void __d_materialise_dentry(struct dentry *dentry, struct dentry *anon)
2705{
Al Viro740da422013-01-30 10:13:38 -05002706 struct dentry *dparent;
David Howells770bfad2006-08-22 20:06:07 -04002707
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002708 dentry_lock_for_move(anon, dentry);
David Howells770bfad2006-08-22 20:06:07 -04002709
Nick Piggin31e6b012011-01-07 17:49:52 +11002710 write_seqcount_begin(&dentry->d_seq);
2711 write_seqcount_begin(&anon->d_seq);
2712
David Howells770bfad2006-08-22 20:06:07 -04002713 dparent = dentry->d_parent;
David Howells770bfad2006-08-22 20:06:07 -04002714
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002715 switch_names(dentry, anon);
2716 swap(dentry->d_name.hash, anon->d_name.hash);
2717
Al Viro740da422013-01-30 10:13:38 -05002718 dentry->d_parent = dentry;
2719 list_del_init(&dentry->d_u.d_child);
2720 anon->d_parent = dparent;
Wei Yongjun9ed53b12013-03-12 00:10:50 +08002721 list_move(&anon->d_u.d_child, &dparent->d_subdirs);
David Howells770bfad2006-08-22 20:06:07 -04002722
Nick Piggin31e6b012011-01-07 17:49:52 +11002723 write_seqcount_end(&dentry->d_seq);
2724 write_seqcount_end(&anon->d_seq);
2725
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002726 dentry_unlock_parents_for_move(anon, dentry);
2727 spin_unlock(&dentry->d_lock);
2728
2729 /* anon->d_lock still locked, returns locked */
David Howells770bfad2006-08-22 20:06:07 -04002730 anon->d_flags &= ~DCACHE_DISCONNECTED;
2731}
2732
2733/**
2734 * d_materialise_unique - introduce an inode into the tree
2735 * @dentry: candidate dentry
2736 * @inode: inode to bind to the dentry, to which aliases may be attached
2737 *
2738 * Introduces an dentry into the tree, substituting an extant disconnected
Jeff Laytonc46c8872011-07-26 13:33:16 -04002739 * root directory alias in its place if there is one. Caller must hold the
2740 * i_mutex of the parent directory.
David Howells770bfad2006-08-22 20:06:07 -04002741 */
2742struct dentry *d_materialise_unique(struct dentry *dentry, struct inode *inode)
2743{
Trond Myklebust9eaef272006-10-21 10:24:20 -07002744 struct dentry *actual;
David Howells770bfad2006-08-22 20:06:07 -04002745
2746 BUG_ON(!d_unhashed(dentry));
2747
David Howells770bfad2006-08-22 20:06:07 -04002748 if (!inode) {
2749 actual = dentry;
OGAWA Hirofumi360da902008-10-16 07:50:28 +09002750 __d_instantiate(dentry, NULL);
Nick Piggin357f8e62011-01-07 17:49:42 +11002751 d_rehash(actual);
2752 goto out_nolock;
David Howells770bfad2006-08-22 20:06:07 -04002753 }
2754
Nick Piggin873feea2011-01-07 17:50:06 +11002755 spin_lock(&inode->i_lock);
Nick Piggin357f8e62011-01-07 17:49:42 +11002756
Trond Myklebust9eaef272006-10-21 10:24:20 -07002757 if (S_ISDIR(inode->i_mode)) {
2758 struct dentry *alias;
David Howells770bfad2006-08-22 20:06:07 -04002759
Trond Myklebust9eaef272006-10-21 10:24:20 -07002760 /* Does an aliased dentry already exist? */
Linus Torvalds32ba9c32012-06-08 10:34:03 -07002761 alias = __d_find_alias(inode, 0);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002762 if (alias) {
2763 actual = alias;
Al Viro18367502011-07-12 21:42:24 -04002764 write_seqlock(&rename_lock);
2765
2766 if (d_ancestor(alias, dentry)) {
2767 /* Check for loops */
2768 actual = ERR_PTR(-ELOOP);
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002769 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002770 } else if (IS_ROOT(alias)) {
2771 /* Is this an anonymous mountpoint that we
2772 * could splice into our tree? */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002773 __d_materialise_dentry(dentry, alias);
Al Viro18367502011-07-12 21:42:24 -04002774 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002775 __d_drop(alias);
2776 goto found;
Al Viro18367502011-07-12 21:42:24 -04002777 } else {
2778 /* Nope, but we must(!) avoid directory
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002779 * aliasing. This drops inode->i_lock */
Al Viro18367502011-07-12 21:42:24 -04002780 actual = __d_unalias(inode, dentry, alias);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002781 }
Al Viro18367502011-07-12 21:42:24 -04002782 write_sequnlock(&rename_lock);
David Howellsdd179942011-08-16 15:31:30 +01002783 if (IS_ERR(actual)) {
2784 if (PTR_ERR(actual) == -ELOOP)
2785 pr_warn_ratelimited(
2786 "VFS: Lookup of '%s' in %s %s"
2787 " would have caused loop\n",
2788 dentry->d_name.name,
2789 inode->i_sb->s_type->name,
2790 inode->i_sb->s_id);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002791 dput(alias);
David Howellsdd179942011-08-16 15:31:30 +01002792 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002793 goto out_nolock;
2794 }
David Howells770bfad2006-08-22 20:06:07 -04002795 }
2796
2797 /* Add a unique reference */
2798 actual = __d_instantiate_unique(dentry, inode);
2799 if (!actual)
2800 actual = dentry;
Nick Piggin357f8e62011-01-07 17:49:42 +11002801 else
2802 BUG_ON(!d_unhashed(actual));
David Howells770bfad2006-08-22 20:06:07 -04002803
David Howells770bfad2006-08-22 20:06:07 -04002804 spin_lock(&actual->d_lock);
2805found:
2806 _d_rehash(actual);
2807 spin_unlock(&actual->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002808 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002809out_nolock:
David Howells770bfad2006-08-22 20:06:07 -04002810 if (actual == dentry) {
2811 security_d_instantiate(dentry, inode);
2812 return NULL;
2813 }
2814
2815 iput(inode);
2816 return actual;
David Howells770bfad2006-08-22 20:06:07 -04002817}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002818EXPORT_SYMBOL_GPL(d_materialise_unique);
David Howells770bfad2006-08-22 20:06:07 -04002819
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002820static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002821{
2822 *buflen -= namelen;
2823 if (*buflen < 0)
2824 return -ENAMETOOLONG;
2825 *buffer -= namelen;
2826 memcpy(*buffer, str, namelen);
2827 return 0;
2828}
2829
Waiman Long232d2d62013-09-09 12:18:13 -04002830/**
2831 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04002832 * @buffer: buffer pointer
2833 * @buflen: allocated length of the buffer
2834 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04002835 *
2836 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
2837 * make sure that either the old or the new name pointer and length are
2838 * fetched. However, there may be mismatch between length and pointer.
2839 * The length cannot be trusted, we need to copy it byte-by-byte until
2840 * the length is reached or a null byte is found. It also prepends "/" at
2841 * the beginning of the name. The sequence number check at the caller will
2842 * retry it again when a d_move() does happen. So any garbage in the buffer
2843 * due to mismatched pointer and length will be discarded.
2844 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002845static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2846{
Waiman Long232d2d62013-09-09 12:18:13 -04002847 const char *dname = ACCESS_ONCE(name->name);
2848 u32 dlen = ACCESS_ONCE(name->len);
2849 char *p;
2850
2851 if (*buflen < dlen + 1)
2852 return -ENAMETOOLONG;
2853 *buflen -= dlen + 1;
2854 p = *buffer -= dlen + 1;
2855 *p++ = '/';
2856 while (dlen--) {
2857 char c = *dname++;
2858 if (!c)
2859 break;
2860 *p++ = c;
2861 }
2862 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002863}
2864
Linus Torvalds1da177e2005-04-16 15:20:36 -07002865/**
Randy Dunlap208898c2010-11-18 15:02:49 -08002866 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002867 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002868 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002869 * @buffer: pointer to the end of the buffer
2870 * @buflen: pointer to buffer length
2871 *
Waiman Long18129972013-09-12 10:55:35 -04002872 * The function will first try to write out the pathname without taking any
2873 * lock other than the RCU read lock to make sure that dentries won't go away.
2874 * It only checks the sequence number of the global rename_lock as any change
2875 * in the dentry's d_seq will be preceded by changes in the rename_lock
2876 * sequence number. If the sequence number had been changed, it will restart
2877 * the whole pathname back-tracing sequence again by taking the rename_lock.
2878 * In this case, there is no need to take the RCU read lock as the recursive
2879 * parent pointer references will keep the dentry chain alive as long as no
2880 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002881 */
Al Viro02125a82011-12-05 08:43:34 -05002882static int prepend_path(const struct path *path,
2883 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002884 char **buffer, int *buflen)
2885{
2886 struct dentry *dentry = path->dentry;
2887 struct vfsmount *vfsmnt = path->mnt;
Al Viro0714a532011-11-24 22:19:58 -05002888 struct mount *mnt = real_mount(vfsmnt);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002889 int error = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04002890 unsigned seq = 0;
2891 char *bptr;
2892 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002893
Al Viro94e92a62013-10-01 16:18:06 -04002894 br_read_lock(&vfsmount_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04002895 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002896restart:
2897 bptr = *buffer;
2898 blen = *buflen;
2899 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002900 while (dentry != root->dentry || vfsmnt != root->mnt) {
2901 struct dentry * parent;
2902
2903 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
2904 /* Global root? */
Waiman Long232d2d62013-09-09 12:18:13 -04002905 if (mnt_has_parent(mnt)) {
2906 dentry = mnt->mnt_mountpoint;
2907 mnt = mnt->mnt_parent;
2908 vfsmnt = &mnt->mnt;
2909 continue;
2910 }
2911 /*
2912 * Filesystems needing to implement special "root names"
2913 * should do so with ->d_dname()
2914 */
2915 if (IS_ROOT(dentry) &&
2916 (dentry->d_name.len != 1 ||
2917 dentry->d_name.name[0] != '/')) {
2918 WARN(1, "Root dentry has weird name <%.*s>\n",
2919 (int) dentry->d_name.len,
2920 dentry->d_name.name);
2921 }
2922 if (!error)
2923 error = is_mounted(vfsmnt) ? 1 : 2;
2924 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002925 }
2926 parent = dentry->d_parent;
2927 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002928 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002929 if (error)
2930 break;
2931
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002932 dentry = parent;
2933 }
Al Viro48f5ec22013-09-09 15:22:25 -04002934 if (!(seq & 1))
2935 rcu_read_unlock();
2936 if (need_seqretry(&rename_lock, seq)) {
2937 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04002938 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002939 }
Al Viro48f5ec22013-09-09 15:22:25 -04002940 done_seqretry(&rename_lock, seq);
Al Viro94e92a62013-10-01 16:18:06 -04002941 br_read_unlock(&vfsmount_lock);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002942
Waiman Long232d2d62013-09-09 12:18:13 -04002943 if (error >= 0 && bptr == *buffer) {
2944 if (--blen < 0)
2945 error = -ENAMETOOLONG;
2946 else
2947 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002948 }
Waiman Long232d2d62013-09-09 12:18:13 -04002949 *buffer = bptr;
2950 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04002951 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002952}
2953
2954/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002955 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002956 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002957 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07002958 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07002959 * @buflen: buffer length
2960 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002961 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002962 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002963 * Returns a pointer into the buffer or an error code if the
2964 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08002965 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04002966 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002967 *
Al Viro02125a82011-12-05 08:43:34 -05002968 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002969 */
Al Viro02125a82011-12-05 08:43:34 -05002970char *__d_path(const struct path *path,
2971 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002972 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002973{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002974 char *res = buf + buflen;
2975 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002976
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002977 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002978 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002979
Al Viro02125a82011-12-05 08:43:34 -05002980 if (error < 0)
2981 return ERR_PTR(error);
2982 if (error > 0)
2983 return NULL;
2984 return res;
2985}
2986
2987char *d_absolute_path(const struct path *path,
2988 char *buf, int buflen)
2989{
2990 struct path root = {};
2991 char *res = buf + buflen;
2992 int error;
2993
2994 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05002995 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05002996
2997 if (error > 1)
2998 error = -EINVAL;
2999 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003000 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003001 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003002}
3003
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003004/*
3005 * same as __d_path but appends "(deleted)" for unlinked files.
3006 */
Al Viro02125a82011-12-05 08:43:34 -05003007static int path_with_deleted(const struct path *path,
3008 const struct path *root,
3009 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003010{
3011 prepend(buf, buflen, "\0", 1);
3012 if (d_unlinked(path->dentry)) {
3013 int error = prepend(buf, buflen, " (deleted)", 10);
3014 if (error)
3015 return error;
3016 }
3017
3018 return prepend_path(path, root, buf, buflen);
3019}
3020
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003021static int prepend_unreachable(char **buffer, int *buflen)
3022{
3023 return prepend(buffer, buflen, "(unreachable)", 13);
3024}
3025
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003026static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3027{
3028 unsigned seq;
3029
3030 do {
3031 seq = read_seqcount_begin(&fs->seq);
3032 *root = fs->root;
3033 } while (read_seqcount_retry(&fs->seq, seq));
3034}
3035
Jan Bluncka03a8a702008-02-14 19:38:32 -08003036/**
3037 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003038 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003039 * @buf: buffer to return value in
3040 * @buflen: buffer length
3041 *
3042 * Convert a dentry into an ASCII path name. If the entry has been deleted
3043 * the string " (deleted)" is appended. Note that this is ambiguous.
3044 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003045 * Returns a pointer into the buffer or an error code if the path was
3046 * too long. Note: Callers should use the returned pointer, not the passed
3047 * in buffer, to use the name! The implementation often starts at an offset
3048 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003049 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003050 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003051 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003052char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003053{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003054 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003055 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003056 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003057
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003058 /*
3059 * We have various synthetic filesystems that never get mounted. On
3060 * these filesystems dentries are never used for lookup purposes, and
3061 * thus don't need to be hashed. They also don't need a name until a
3062 * user wants to identify the object in /proc/pid/fd/. The little hack
3063 * below allows us to generate a name for these objects on demand:
3064 */
Jan Blunckcf28b482008-02-14 19:38:44 -08003065 if (path->dentry->d_op && path->dentry->d_op->d_dname)
3066 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003067
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003068 rcu_read_lock();
3069 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003070 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003071 rcu_read_unlock();
3072
Al Viro02125a82011-12-05 08:43:34 -05003073 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003074 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003075 return res;
3076}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003077EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003078
3079/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003080 * Helper function for dentry_operations.d_dname() members
3081 */
3082char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3083 const char *fmt, ...)
3084{
3085 va_list args;
3086 char temp[64];
3087 int sz;
3088
3089 va_start(args, fmt);
3090 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3091 va_end(args);
3092
3093 if (sz > sizeof(temp) || sz > buflen)
3094 return ERR_PTR(-ENAMETOOLONG);
3095
3096 buffer += buflen - sz;
3097 return memcpy(buffer, temp, sz);
3098}
3099
Al Viro118b2302013-08-24 12:08:17 -04003100char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3101{
3102 char *end = buffer + buflen;
3103 /* these dentries are never renamed, so d_lock is not needed */
3104 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003105 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003106 prepend(&end, &buflen, "/", 1))
3107 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003108 return end;
Al Viro118b2302013-08-24 12:08:17 -04003109}
3110
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003111/*
Ram Pai6092d042008-03-27 13:06:20 +01003112 * Write full pathname from the root of the filesystem into the buffer.
3113 */
Nick Pigginec2447c2011-01-07 17:49:29 +11003114static char *__dentry_path(struct dentry *dentry, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003115{
Waiman Long232d2d62013-09-09 12:18:13 -04003116 char *end, *retval;
3117 int len, seq = 0;
3118 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003119
Al Viro48f5ec22013-09-09 15:22:25 -04003120 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003121restart:
3122 end = buf + buflen;
3123 len = buflen;
3124 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003125 if (buflen < 1)
3126 goto Elong;
3127 /* Get '/' right */
3128 retval = end-1;
3129 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003130 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003131 while (!IS_ROOT(dentry)) {
3132 struct dentry *parent = dentry->d_parent;
Nick Piggin9abca362011-01-07 17:49:36 +11003133 int error;
Ram Pai6092d042008-03-27 13:06:20 +01003134
Ram Pai6092d042008-03-27 13:06:20 +01003135 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003136 error = prepend_name(&end, &len, &dentry->d_name);
3137 if (error)
3138 break;
Ram Pai6092d042008-03-27 13:06:20 +01003139
3140 retval = end;
3141 dentry = parent;
3142 }
Al Viro48f5ec22013-09-09 15:22:25 -04003143 if (!(seq & 1))
3144 rcu_read_unlock();
3145 if (need_seqretry(&rename_lock, seq)) {
3146 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003147 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003148 }
3149 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003150 if (error)
3151 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003152 return retval;
3153Elong:
3154 return ERR_PTR(-ENAMETOOLONG);
3155}
Nick Pigginec2447c2011-01-07 17:49:29 +11003156
3157char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3158{
Waiman Long232d2d62013-09-09 12:18:13 -04003159 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003160}
3161EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003162
3163char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3164{
3165 char *p = NULL;
3166 char *retval;
3167
Al Viroc1031352010-06-06 22:31:14 -04003168 if (d_unlinked(dentry)) {
3169 p = buf + buflen;
3170 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3171 goto Elong;
3172 buflen++;
3173 }
3174 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003175 if (!IS_ERR(retval) && p)
3176 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003177 return retval;
3178Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003179 return ERR_PTR(-ENAMETOOLONG);
3180}
3181
Linus Torvalds8b19e342013-09-12 10:35:47 -07003182static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3183 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003184{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003185 unsigned seq;
3186
3187 do {
3188 seq = read_seqcount_begin(&fs->seq);
3189 *root = fs->root;
3190 *pwd = fs->pwd;
3191 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003192}
3193
Ram Pai6092d042008-03-27 13:06:20 +01003194/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003195 * NOTE! The user-level library version returns a
3196 * character pointer. The kernel system call just
3197 * returns the length of the buffer filled (which
3198 * includes the ending '\0' character), or a negative
3199 * error value. So libc would do something like
3200 *
3201 * char *getcwd(char * buf, size_t size)
3202 * {
3203 * int retval;
3204 *
3205 * retval = sys_getcwd(buf, size);
3206 * if (retval >= 0)
3207 * return buf;
3208 * errno = -retval;
3209 * return NULL;
3210 * }
3211 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003212SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003213{
Linus Torvalds552ce542007-02-13 12:08:18 -08003214 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003215 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003216 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003217
3218 if (!page)
3219 return -ENOMEM;
3220
Linus Torvalds8b19e342013-09-12 10:35:47 -07003221 rcu_read_lock();
3222 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003223
Linus Torvalds552ce542007-02-13 12:08:18 -08003224 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003225 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003226 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003227 char *cwd = page + PATH_MAX;
3228 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003229
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003230 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003231 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003232 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003233
Al Viro02125a82011-12-05 08:43:34 -05003234 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003235 goto out;
3236
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003237 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003238 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003239 error = prepend_unreachable(&cwd, &buflen);
3240 if (error)
3241 goto out;
3242 }
3243
Linus Torvalds552ce542007-02-13 12:08:18 -08003244 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003245 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003246 if (len <= size) {
3247 error = len;
3248 if (copy_to_user(buf, cwd, len))
3249 error = -EFAULT;
3250 }
Nick Piggin949854d2011-01-07 17:49:37 +11003251 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003252 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003253 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003254
3255out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003256 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003257 return error;
3258}
3259
3260/*
3261 * Test whether new_dentry is a subdirectory of old_dentry.
3262 *
3263 * Trivially implemented using the dcache structure
3264 */
3265
3266/**
3267 * is_subdir - is new dentry a subdirectory of old_dentry
3268 * @new_dentry: new dentry
3269 * @old_dentry: old dentry
3270 *
3271 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
3272 * Returns 0 otherwise.
3273 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3274 */
3275
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003276int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003277{
3278 int result;
Nick Piggin949854d2011-01-07 17:49:37 +11003279 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003280
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003281 if (new_dentry == old_dentry)
3282 return 1;
3283
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003284 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003285 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003286 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003287 /*
3288 * Need rcu_readlock to protect against the d_parent trashing
3289 * due to d_move
3290 */
3291 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003292 if (d_ancestor(old_dentry, new_dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003293 result = 1;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003294 else
3295 result = 0;
Nick Piggin949854d2011-01-07 17:49:37 +11003296 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003297 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003298
3299 return result;
3300}
3301
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003302static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003303{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003304 struct dentry *root = data;
3305 if (dentry != root) {
3306 if (d_unhashed(dentry) || !dentry->d_inode)
3307 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003308
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003309 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3310 dentry->d_flags |= DCACHE_GENOCIDE;
3311 dentry->d_lockref.count--;
3312 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003313 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003314 return D_WALK_CONTINUE;
3315}
Nick Piggin58db63d2011-01-07 17:49:39 +11003316
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003317void d_genocide(struct dentry *parent)
3318{
3319 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003320}
3321
Al Viro60545d02013-06-07 01:20:27 -04003322void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003323{
Al Viro60545d02013-06-07 01:20:27 -04003324 inode_dec_link_count(inode);
3325 BUG_ON(dentry->d_name.name != dentry->d_iname ||
3326 !hlist_unhashed(&dentry->d_alias) ||
3327 !d_unlinked(dentry));
3328 spin_lock(&dentry->d_parent->d_lock);
3329 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3330 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3331 (unsigned long long)inode->i_ino);
3332 spin_unlock(&dentry->d_lock);
3333 spin_unlock(&dentry->d_parent->d_lock);
3334 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003335}
Al Viro60545d02013-06-07 01:20:27 -04003336EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003337
3338static __initdata unsigned long dhash_entries;
3339static int __init set_dhash_entries(char *str)
3340{
3341 if (!str)
3342 return 0;
3343 dhash_entries = simple_strtoul(str, &str, 0);
3344 return 1;
3345}
3346__setup("dhash_entries=", set_dhash_entries);
3347
3348static void __init dcache_init_early(void)
3349{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003350 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003351
3352 /* If hashes are distributed across NUMA nodes, defer
3353 * hash allocation until vmalloc space is available.
3354 */
3355 if (hashdist)
3356 return;
3357
3358 dentry_hashtable =
3359 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003360 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003361 dhash_entries,
3362 13,
3363 HASH_EARLY,
3364 &d_hash_shift,
3365 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003366 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003367 0);
3368
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003369 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003370 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003371}
3372
Denis Cheng74bf17c2007-10-16 23:26:30 -07003373static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003374{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003375 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003376
3377 /*
3378 * A constructor could be added for stable state like the lists,
3379 * but it is probably not worth it because of the cache nature
3380 * of the dcache.
3381 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003382 dentry_cache = KMEM_CACHE(dentry,
3383 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003384
3385 /* Hash may have been set up in dcache_init_early */
3386 if (!hashdist)
3387 return;
3388
3389 dentry_hashtable =
3390 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003391 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003392 dhash_entries,
3393 13,
3394 0,
3395 &d_hash_shift,
3396 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003397 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003398 0);
3399
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003400 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003401 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003402}
3403
3404/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003405struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003406EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003407
Linus Torvalds1da177e2005-04-16 15:20:36 -07003408EXPORT_SYMBOL(d_genocide);
3409
Linus Torvalds1da177e2005-04-16 15:20:36 -07003410void __init vfs_caches_init_early(void)
3411{
3412 dcache_init_early();
3413 inode_init_early();
3414}
3415
3416void __init vfs_caches_init(unsigned long mempages)
3417{
3418 unsigned long reserve;
3419
3420 /* Base hash sizes on available memory, with a reserve equal to
3421 150% of current kernel size */
3422
3423 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
3424 mempages -= reserve;
3425
3426 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003427 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003428
Denis Cheng74bf17c2007-10-16 23:26:30 -07003429 dcache_init();
3430 inode_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003431 files_init(mempages);
Denis Cheng74bf17c2007-10-16 23:26:30 -07003432 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003433 bdev_cache_init();
3434 chrdev_init();
3435}