blob: dab7db10d68528e6d9bfdb8fa022a5f2c21abecc [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070091/*
92 * This is the single most critical data structure when it comes
93 * to the dcache: the hashtable for lookups. Somebody should try
94 * to make this good - I've just made it work.
95 *
96 * This hash-function tries to avoid losing too many bits of hash
97 * information, yet avoid using a prime hash-size or similar.
98 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800100static unsigned int d_hash_mask __read_mostly;
101static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100102
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700103static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100104
Linus Torvalds8966be92012-03-02 14:23:30 -0800105static inline struct hlist_bl_head *d_hash(const struct dentry *parent,
Linus Torvalds6d7d1a02012-03-19 16:19:53 -0700106 unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100107{
Linus Torvalds6d7d1a02012-03-19 16:19:53 -0700108 hash += (unsigned long) parent / L1_CACHE_BYTES;
Al Viro482db902013-10-25 16:41:01 -0400109 hash = hash + (hash >> d_hash_shift);
110 return dentry_hashtable + (hash & d_hash_mask);
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100111}
112
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113/* Statistics gathering. */
114struct dentry_stat_t dentry_stat = {
115 .age_limit = 45,
116};
117
Glauber Costa3942c072013-08-28 10:17:53 +1000118static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000119static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400120
121#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000122
123/*
124 * Here we resort to our own counters instead of using generic per-cpu counters
125 * for consistency with what the vfs inode code does. We are expected to harvest
126 * better code and performance by having our own specialized counters.
127 *
128 * Please note that the loop is done over all possible CPUs, not over all online
129 * CPUs. The reason for this is that we don't want to play games with CPUs going
130 * on and off. If one of them goes off, we will just keep their counters.
131 *
132 * glommer: See cffbc8a for details, and if you ever intend to change this,
133 * please update all vfs counters to match.
134 */
Glauber Costa3942c072013-08-28 10:17:53 +1000135static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100136{
137 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000138 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100139 for_each_possible_cpu(i)
140 sum += per_cpu(nr_dentry, i);
141 return sum < 0 ? 0 : sum;
142}
143
Dave Chinner62d36c72013-08-28 10:17:54 +1000144static long get_nr_dentry_unused(void)
145{
146 int i;
147 long sum = 0;
148 for_each_possible_cpu(i)
149 sum += per_cpu(nr_dentry_unused, i);
150 return sum < 0 ? 0 : sum;
151}
152
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400153int proc_nr_dentry(ctl_table *table, int write, void __user *buffer,
154 size_t *lenp, loff_t *ppos)
155{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100156 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000157 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000158 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400159}
160#endif
161
Linus Torvalds5483f182012-03-04 15:51:42 -0800162/*
163 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
164 * The strings are both count bytes long, and count is non-zero.
165 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700166#ifdef CONFIG_DCACHE_WORD_ACCESS
167
168#include <asm/word-at-a-time.h>
169/*
170 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
171 * aligned allocation for this particular component. We don't
172 * strictly need the load_unaligned_zeropad() safety, but it
173 * doesn't hurt either.
174 *
175 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
176 * need the careful unaligned handling.
177 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700178static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800179{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800180 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800181
182 for (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700183 a = *(unsigned long *)cs;
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700184 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800185 if (tcount < sizeof(unsigned long))
186 break;
187 if (unlikely(a != b))
188 return 1;
189 cs += sizeof(unsigned long);
190 ct += sizeof(unsigned long);
191 tcount -= sizeof(unsigned long);
192 if (!tcount)
193 return 0;
194 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000195 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800196 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700197}
198
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800199#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700200
Linus Torvalds94753db52012-05-10 12:19:19 -0700201static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700202{
Linus Torvalds5483f182012-03-04 15:51:42 -0800203 do {
204 if (*cs != *ct)
205 return 1;
206 cs++;
207 ct++;
208 tcount--;
209 } while (tcount);
210 return 0;
211}
212
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700213#endif
214
Linus Torvalds94753db52012-05-10 12:19:19 -0700215static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
216{
Linus Torvalds6326c712012-05-21 16:14:04 -0700217 const unsigned char *cs;
Linus Torvalds94753db52012-05-10 12:19:19 -0700218 /*
219 * Be careful about RCU walk racing with rename:
220 * use ACCESS_ONCE to fetch the name pointer.
221 *
222 * NOTE! Even if a rename will mean that the length
223 * was not loaded atomically, we don't care. The
224 * RCU walk will check the sequence count eventually,
225 * and catch it. And we won't overrun the buffer,
226 * because we're reading the name pointer atomically,
227 * and a dentry name is guaranteed to be properly
228 * terminated with a NUL byte.
229 *
230 * End result: even if 'len' is wrong, we'll exit
231 * early because the data cannot match (there can
232 * be no NUL in the ct/tcount data)
233 */
Linus Torvalds6326c712012-05-21 16:14:04 -0700234 cs = ACCESS_ONCE(dentry->d_name.name);
235 smp_read_barrier_depends();
236 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700237}
238
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400239static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400241 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
242
Al Virob3d9b7a2012-06-09 13:51:19 -0400243 WARN_ON(!hlist_unhashed(&dentry->d_alias));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 if (dname_external(dentry))
245 kfree(dentry->d_name.name);
246 kmem_cache_free(dentry_cache, dentry);
247}
248
Al Virob4f03542014-04-29 23:40:14 -0400249static void dentry_free(struct dentry *dentry)
250{
251 /* if dentry was never visible to RCU, immediate free is OK */
252 if (!(dentry->d_flags & DCACHE_RCUACCESS))
253 __d_free(&dentry->d_u.d_rcu);
254 else
255 call_rcu(&dentry->d_u.d_rcu, __d_free);
256}
257
Nick Piggin31e6b012011-01-07 17:49:52 +1100258/**
259 * dentry_rcuwalk_barrier - invalidate in-progress rcu-walk lookups
Randy Dunlapff5fdb62011-01-22 20:16:06 -0800260 * @dentry: the target dentry
Nick Piggin31e6b012011-01-07 17:49:52 +1100261 * After this call, in-progress rcu-walk path lookup will fail. This
262 * should be called after unhashing, and after changing d_inode (if
263 * the dentry has not already been unhashed).
264 */
265static inline void dentry_rcuwalk_barrier(struct dentry *dentry)
266{
267 assert_spin_locked(&dentry->d_lock);
268 /* Go through a barrier */
269 write_seqcount_barrier(&dentry->d_seq);
270}
271
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272/*
273 * Release the dentry's inode, using the filesystem
Nick Piggin31e6b012011-01-07 17:49:52 +1100274 * d_iput() operation if defined. Dentry has no refcount
275 * and is unhashed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 */
Arjan van de Ven858119e2006-01-14 13:20:43 -0800277static void dentry_iput(struct dentry * dentry)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200278 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100279 __releases(dentry->d_inode->i_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280{
281 struct inode *inode = dentry->d_inode;
282 if (inode) {
283 dentry->d_inode = NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -0400284 hlist_del_init(&dentry->d_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100286 spin_unlock(&inode->i_lock);
Linus Torvaldsf805fbd2005-09-19 19:54:29 -0700287 if (!inode->i_nlink)
288 fsnotify_inoderemove(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 if (dentry->d_op && dentry->d_op->d_iput)
290 dentry->d_op->d_iput(dentry, inode);
291 else
292 iput(inode);
293 } else {
294 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 }
296}
297
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700298/*
Nick Piggin31e6b012011-01-07 17:49:52 +1100299 * Release the dentry's inode, using the filesystem
300 * d_iput() operation if defined. dentry remains in-use.
301 */
302static void dentry_unlink_inode(struct dentry * dentry)
303 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100304 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100305{
306 struct inode *inode = dentry->d_inode;
David Howellsb18825a2013-09-12 19:22:53 +0100307 __d_clear_type(dentry);
Nick Piggin31e6b012011-01-07 17:49:52 +1100308 dentry->d_inode = NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -0400309 hlist_del_init(&dentry->d_alias);
Nick Piggin31e6b012011-01-07 17:49:52 +1100310 dentry_rcuwalk_barrier(dentry);
311 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100312 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100313 if (!inode->i_nlink)
314 fsnotify_inoderemove(inode);
315 if (dentry->d_op && dentry->d_op->d_iput)
316 dentry->d_op->d_iput(dentry, inode);
317 else
318 iput(inode);
319}
320
321/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400322 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
323 * is in use - which includes both the "real" per-superblock
324 * LRU list _and_ the DCACHE_SHRINK_LIST use.
325 *
326 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
327 * on the shrink list (ie not on the superblock LRU list).
328 *
329 * The per-cpu "nr_dentry_unused" counters are updated with
330 * the DCACHE_LRU_LIST bit.
331 *
332 * These helper functions make sure we always follow the
333 * rules. d_lock must be held by the caller.
334 */
335#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
336static void d_lru_add(struct dentry *dentry)
337{
338 D_FLAG_VERIFY(dentry, 0);
339 dentry->d_flags |= DCACHE_LRU_LIST;
340 this_cpu_inc(nr_dentry_unused);
341 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
342}
343
344static void d_lru_del(struct dentry *dentry)
345{
346 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
347 dentry->d_flags &= ~DCACHE_LRU_LIST;
348 this_cpu_dec(nr_dentry_unused);
349 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
350}
351
352static void d_shrink_del(struct dentry *dentry)
353{
354 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
355 list_del_init(&dentry->d_lru);
356 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
357 this_cpu_dec(nr_dentry_unused);
358}
359
360static void d_shrink_add(struct dentry *dentry, struct list_head *list)
361{
362 D_FLAG_VERIFY(dentry, 0);
363 list_add(&dentry->d_lru, list);
364 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
365 this_cpu_inc(nr_dentry_unused);
366}
367
368/*
369 * These can only be called under the global LRU lock, ie during the
370 * callback for freeing the LRU list. "isolate" removes it from the
371 * LRU lists entirely, while shrink_move moves it to the indicated
372 * private list.
373 */
374static void d_lru_isolate(struct dentry *dentry)
375{
376 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
377 dentry->d_flags &= ~DCACHE_LRU_LIST;
378 this_cpu_dec(nr_dentry_unused);
379 list_del_init(&dentry->d_lru);
380}
381
382static void d_lru_shrink_move(struct dentry *dentry, struct list_head *list)
383{
384 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
385 dentry->d_flags |= DCACHE_SHRINK_LIST;
386 list_move_tail(&dentry->d_lru, list);
387}
388
389/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000390 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700391 */
392static void dentry_lru_add(struct dentry *dentry)
393{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400394 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
395 d_lru_add(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700396}
397
Sage Weilf0023bc2011-10-28 10:02:42 -0700398/*
399 * Remove a dentry with references from the LRU.
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000400 *
401 * If we are on the shrink list, then we can get to try_prune_one_dentry() and
402 * lose our last reference through the parent walk. In this case, we need to
403 * remove ourselves from the shrink list, not the LRU.
Sage Weilf0023bc2011-10-28 10:02:42 -0700404 */
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700405static void dentry_lru_del(struct dentry *dentry)
406{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400407 if (dentry->d_flags & DCACHE_LRU_LIST) {
408 if (dentry->d_flags & DCACHE_SHRINK_LIST)
409 return d_shrink_del(dentry);
410 d_lru_del(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700411 }
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700412}
413
Miklos Szeredid52b9082007-05-08 00:23:46 -0700414/**
Nick Piggin789680d2011-01-07 17:49:30 +1100415 * d_drop - drop a dentry
416 * @dentry: dentry to drop
417 *
418 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
419 * be found through a VFS lookup any more. Note that this is different from
420 * deleting the dentry - d_delete will try to mark the dentry negative if
421 * possible, giving a successful _negative_ lookup, while d_drop will
422 * just make the cache lookup fail.
423 *
424 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
425 * reason (NFS timeouts or autofs deletes).
426 *
427 * __d_drop requires dentry->d_lock.
428 */
429void __d_drop(struct dentry *dentry)
430{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700431 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400432 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400433 /*
434 * Hashed dentries are normally on the dentry hashtable,
435 * with the exception of those newly allocated by
436 * d_obtain_alias, which are always IS_ROOT:
437 */
438 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400439 b = &dentry->d_sb->s_anon;
440 else
441 b = d_hash(dentry->d_parent, dentry->d_name.hash);
442
443 hlist_bl_lock(b);
444 __hlist_bl_del(&dentry->d_hash);
445 dentry->d_hash.pprev = NULL;
446 hlist_bl_unlock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -0700447 dentry_rcuwalk_barrier(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +1100448 }
449}
450EXPORT_SYMBOL(__d_drop);
451
452void d_drop(struct dentry *dentry)
453{
Nick Piggin789680d2011-01-07 17:49:30 +1100454 spin_lock(&dentry->d_lock);
455 __d_drop(dentry);
456 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100457}
458EXPORT_SYMBOL(d_drop);
459
Nick Piggin77812a12011-01-07 17:49:48 +1100460/*
461 * Finish off a dentry we've decided to kill.
462 * dentry->d_lock must be held, returns with it unlocked.
463 * If ref is non-zero, then decrement the refcount too.
464 * Returns dentry requiring refcount drop, or NULL if we're done.
465 */
Linus Torvalds358eec12013-10-31 15:43:02 -0700466static struct dentry *
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000467dentry_kill(struct dentry *dentry, int unlock_on_failure)
Nick Piggin77812a12011-01-07 17:49:48 +1100468 __releases(dentry->d_lock)
469{
Nick Piggin873feea2011-01-07 17:50:06 +1100470 struct inode *inode;
Nick Piggin77812a12011-01-07 17:49:48 +1100471 struct dentry *parent;
472
Nick Piggin873feea2011-01-07 17:50:06 +1100473 inode = dentry->d_inode;
474 if (inode && !spin_trylock(&inode->i_lock)) {
Nick Piggin77812a12011-01-07 17:49:48 +1100475relock:
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000476 if (unlock_on_failure) {
477 spin_unlock(&dentry->d_lock);
478 cpu_relax();
479 }
Nick Piggin77812a12011-01-07 17:49:48 +1100480 return dentry; /* try again with same dentry */
481 }
482 if (IS_ROOT(dentry))
483 parent = NULL;
484 else
485 parent = dentry->d_parent;
486 if (parent && !spin_trylock(&parent->d_lock)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100487 if (inode)
488 spin_unlock(&inode->i_lock);
Nick Piggin77812a12011-01-07 17:49:48 +1100489 goto relock;
490 }
Nick Piggin31e6b012011-01-07 17:49:52 +1100491
Linus Torvalds0d984392013-09-08 13:46:52 -0700492 /*
493 * The dentry is now unrecoverably dead to the world.
494 */
495 lockref_mark_dead(&dentry->d_lockref);
496
Sage Weilf0023bc2011-10-28 10:02:42 -0700497 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700498 * inform the fs via d_prune that this dentry is about to be
499 * unhashed and destroyed.
500 */
Yan, Zheng590fb512013-08-13 15:42:02 +0800501 if ((dentry->d_flags & DCACHE_OP_PRUNE) && !d_unhashed(dentry))
Yan, Zheng61572bb2013-04-15 14:13:21 +0800502 dentry->d_op->d_prune(dentry);
503
504 dentry_lru_del(dentry);
Nick Piggin77812a12011-01-07 17:49:48 +1100505 /* if it was on the hash then remove it */
506 __d_drop(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400507 list_del(&dentry->d_u.d_child);
508 /*
509 * Inform d_walk() that we are no longer attached to the
510 * dentry tree
511 */
512 dentry->d_flags |= DCACHE_DENTRY_KILLED;
513 if (parent)
514 spin_unlock(&parent->d_lock);
515 dentry_iput(dentry);
516 /*
517 * dentry_iput drops the locks, at which point nobody (except
518 * transient RCU lookups) can reach this dentry.
519 */
520 BUG_ON((int)dentry->d_lockref.count > 0);
521 this_cpu_dec(nr_dentry);
522 if (dentry->d_op && dentry->d_op->d_release)
523 dentry->d_op->d_release(dentry);
524
Al Virob4f03542014-04-29 23:40:14 -0400525 dentry_free(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400526 return parent;
Nick Piggin77812a12011-01-07 17:49:48 +1100527}
528
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529/*
530 * This is dput
531 *
532 * This is complicated by the fact that we do not want to put
533 * dentries that are no longer on any hash chain on the unused
534 * list: we'd much rather just get rid of them immediately.
535 *
536 * However, that implies that we have to traverse the dentry
537 * tree upwards to the parents which might _also_ now be
538 * scheduled for deletion (it may have been only waiting for
539 * its last child to go away).
540 *
541 * This tail recursion is done by hand as we don't want to depend
542 * on the compiler to always get this right (gcc generally doesn't).
543 * Real recursion would eat up our stack space.
544 */
545
546/*
547 * dput - release a dentry
548 * @dentry: dentry to release
549 *
550 * Release a dentry. This will drop the usage count and if appropriate
551 * call the dentry unlink method as well as removing it from the queues and
552 * releasing its resources. If the parent dentries were scheduled for release
553 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555void dput(struct dentry *dentry)
556{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700557 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 return;
559
560repeat:
Waiman Long98474232013-08-28 18:24:59 -0700561 if (lockref_put_or_lock(&dentry->d_lockref))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700564 /* Unreachable? Get rid of it */
565 if (unlikely(d_unhashed(dentry)))
566 goto kill_it;
567
568 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100570 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 }
Nick Piggin265ac902010-10-10 05:36:24 -0400572
Linus Torvalds358eec12013-10-31 15:43:02 -0700573 if (!(dentry->d_flags & DCACHE_REFERENCED))
574 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400575 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400576
Waiman Long98474232013-08-28 18:24:59 -0700577 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100578 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 return;
580
Miklos Szeredid52b9082007-05-08 00:23:46 -0700581kill_it:
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000582 dentry = dentry_kill(dentry, 1);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700583 if (dentry)
584 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700586EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
588/**
589 * d_invalidate - invalidate a dentry
590 * @dentry: dentry to invalidate
591 *
592 * Try to invalidate the dentry if it turns out to be
593 * possible. If there are other dentries that can be
594 * reached through this one we can't delete it and we
595 * return -EBUSY. On success we return 0.
596 *
597 * no dcache lock.
598 */
599
600int d_invalidate(struct dentry * dentry)
601{
602 /*
603 * If it's already been dropped, return OK.
604 */
Nick Pigginda502952011-01-07 17:49:33 +1100605 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 if (d_unhashed(dentry)) {
Nick Pigginda502952011-01-07 17:49:33 +1100607 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 return 0;
609 }
610 /*
611 * Check whether to do a partial shrink_dcache
612 * to get rid of unused child entries.
613 */
614 if (!list_empty(&dentry->d_subdirs)) {
Nick Pigginda502952011-01-07 17:49:33 +1100615 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 shrink_dcache_parent(dentry);
Nick Pigginda502952011-01-07 17:49:33 +1100617 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 }
619
620 /*
621 * Somebody else still using it?
622 *
623 * If it's a directory, we can't drop it
624 * for fear of somebody re-populating it
625 * with children (even though dropping it
626 * would make it unreachable from the root,
627 * we might still populate it if it was a
628 * working directory or similar).
Al Viro50e69632011-11-07 16:39:57 +0000629 * We also need to leave mountpoints alone,
630 * directory or not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 */
Waiman Long98474232013-08-28 18:24:59 -0700632 if (dentry->d_lockref.count > 1 && dentry->d_inode) {
Al Viro50e69632011-11-07 16:39:57 +0000633 if (S_ISDIR(dentry->d_inode->i_mode) || d_mountpoint(dentry)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 return -EBUSY;
636 }
637 }
638
639 __d_drop(dentry);
640 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 return 0;
642}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700643EXPORT_SYMBOL(d_invalidate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100645/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100646static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647{
Waiman Long98474232013-08-28 18:24:59 -0700648 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649}
650
Nick Piggindc0474b2011-01-07 17:49:43 +1100651static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100652{
Waiman Long98474232013-08-28 18:24:59 -0700653 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100654}
655
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100656struct dentry *dget_parent(struct dentry *dentry)
657{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700658 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100659 struct dentry *ret;
660
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700661 /*
662 * Do optimistic parent lookup without any
663 * locking.
664 */
665 rcu_read_lock();
666 ret = ACCESS_ONCE(dentry->d_parent);
667 gotref = lockref_get_not_zero(&ret->d_lockref);
668 rcu_read_unlock();
669 if (likely(gotref)) {
670 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
671 return ret;
672 dput(ret);
673 }
674
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100675repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100676 /*
677 * Don't need rcu_dereference because we re-check it was correct under
678 * the lock.
679 */
680 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100681 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100682 spin_lock(&ret->d_lock);
683 if (unlikely(ret != dentry->d_parent)) {
684 spin_unlock(&ret->d_lock);
685 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100686 goto repeat;
687 }
Nick Piggina734eb42011-01-07 17:49:44 +1100688 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700689 BUG_ON(!ret->d_lockref.count);
690 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100691 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100692 return ret;
693}
694EXPORT_SYMBOL(dget_parent);
695
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696/**
697 * d_find_alias - grab a hashed alias of inode
698 * @inode: inode in question
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700699 * @want_discon: flag, used by d_splice_alias, to request
700 * that only a DISCONNECTED alias be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 *
702 * If inode has a hashed alias, or is a directory and has any alias,
703 * acquire the reference to alias and return it. Otherwise return NULL.
704 * Notice that if inode is a directory there can be only one alias and
705 * it can be unhashed only if it has no children, or if it is the root
706 * of a filesystem.
707 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700708 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700709 * any other hashed alias over that one unless @want_discon is set,
710 * in which case only return an IS_ROOT, DCACHE_DISCONNECTED alias.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 */
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700712static struct dentry *__d_find_alias(struct inode *inode, int want_discon)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713{
Nick Pigginda502952011-01-07 17:49:33 +1100714 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
Nick Pigginda502952011-01-07 17:49:33 +1100716again:
717 discon_alias = NULL;
Sasha Levinb67bfe02013-02-27 17:06:00 -0800718 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100719 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700721 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100722 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 discon_alias = alias;
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700724 } else if (!want_discon) {
Nick Piggindc0474b2011-01-07 17:49:43 +1100725 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100726 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 return alias;
728 }
729 }
Nick Pigginda502952011-01-07 17:49:33 +1100730 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 }
Nick Pigginda502952011-01-07 17:49:33 +1100732 if (discon_alias) {
733 alias = discon_alias;
734 spin_lock(&alias->d_lock);
735 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
736 if (IS_ROOT(alias) &&
737 (alias->d_flags & DCACHE_DISCONNECTED)) {
Nick Piggindc0474b2011-01-07 17:49:43 +1100738 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100739 spin_unlock(&alias->d_lock);
740 return alias;
741 }
742 }
743 spin_unlock(&alias->d_lock);
744 goto again;
745 }
746 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747}
748
Nick Pigginda502952011-01-07 17:49:33 +1100749struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750{
David Howells214fda12006-03-25 03:06:36 -0800751 struct dentry *de = NULL;
752
Al Virob3d9b7a2012-06-09 13:51:19 -0400753 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100754 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700755 de = __d_find_alias(inode, 0);
Nick Piggin873feea2011-01-07 17:50:06 +1100756 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800757 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 return de;
759}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700760EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
762/*
763 * Try to kill dentries associated with this inode.
764 * WARNING: you must own a reference to inode.
765 */
766void d_prune_aliases(struct inode *inode)
767{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700768 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100770 spin_lock(&inode->i_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -0800771 hlist_for_each_entry(dentry, &inode->i_dentry, d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700773 if (!dentry->d_lockref.count) {
Yan, Zheng590fb512013-08-13 15:42:02 +0800774 /*
775 * inform the fs via d_prune that this dentry
776 * is about to be unhashed and destroyed.
777 */
778 if ((dentry->d_flags & DCACHE_OP_PRUNE) &&
779 !d_unhashed(dentry))
780 dentry->d_op->d_prune(dentry);
781
Nick Piggindc0474b2011-01-07 17:49:43 +1100782 __dget_dlock(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 __d_drop(dentry);
784 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100785 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 dput(dentry);
787 goto restart;
788 }
789 spin_unlock(&dentry->d_lock);
790 }
Nick Piggin873feea2011-01-07 17:50:06 +1100791 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700793EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400795static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796{
Al Viro5c47e6d2014-04-29 16:13:18 -0400797 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700798
Nick Pigginec336792011-01-07 17:49:47 +1100799 rcu_read_lock();
800 for (;;) {
Nick Pigginec336792011-01-07 17:49:47 +1100801 dentry = list_entry_rcu(list->prev, struct dentry, d_lru);
802 if (&dentry->d_lru == list)
803 break; /* empty */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400804
805 /*
806 * Get the dentry lock, and re-verify that the dentry is
807 * this on the shrinking list. If it is, we know that
808 * DCACHE_SHRINK_LIST and DCACHE_LRU_LIST are set.
809 */
Nick Pigginec336792011-01-07 17:49:47 +1100810 spin_lock(&dentry->d_lock);
811 if (dentry != list_entry(list->prev, struct dentry, d_lru)) {
812 spin_unlock(&dentry->d_lock);
Nick Piggin23044502011-01-07 17:49:31 +1100813 continue;
814 }
815
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000817 * The dispose list is isolated and dentries are not accounted
818 * to the LRU here, so we can simply remove it from the list
819 * here regardless of whether it is referenced or not.
820 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400821 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000822
823 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000825 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 */
Waiman Long98474232013-08-28 18:24:59 -0700827 if (dentry->d_lockref.count) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700828 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 continue;
830 }
Nick Pigginec336792011-01-07 17:49:47 +1100831 rcu_read_unlock();
Nick Piggin77812a12011-01-07 17:49:48 +1100832
Al Viro5c47e6d2014-04-29 16:13:18 -0400833 parent = dentry_kill(dentry, 0);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400834 /*
Al Viro5c47e6d2014-04-29 16:13:18 -0400835 * If dentry_kill returns NULL, we have nothing more to do.
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400836 */
Al Viro5c47e6d2014-04-29 16:13:18 -0400837 if (!parent) {
838 rcu_read_lock();
839 continue;
840 }
841 if (unlikely(parent == dentry)) {
842 /*
843 * trylocks have failed and d_lock has been held the
844 * whole time, so it could not have been added to any
845 * other lists. Just add it back to the shrink list.
846 */
847 rcu_read_lock();
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400848 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000849 spin_unlock(&dentry->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -0400850 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000851 }
Al Viro5c47e6d2014-04-29 16:13:18 -0400852 /*
853 * We need to prune ancestors too. This is necessary to prevent
854 * quadratic behavior of shrink_dcache_parent(), but is also
855 * expected to be beneficial in reducing dentry cache
856 * fragmentation.
857 */
858 dentry = parent;
859 while (dentry && !lockref_put_or_lock(&dentry->d_lockref))
860 dentry = dentry_kill(dentry, 1);
861 rcu_read_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 }
Nick Pigginec336792011-01-07 17:49:47 +1100863 rcu_read_unlock();
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400864}
865
Dave Chinnerf6041562013-08-28 10:18:00 +1000866static enum lru_status
867dentry_lru_isolate(struct list_head *item, spinlock_t *lru_lock, void *arg)
868{
869 struct list_head *freeable = arg;
870 struct dentry *dentry = container_of(item, struct dentry, d_lru);
871
872
873 /*
874 * we are inverting the lru lock/dentry->d_lock here,
875 * so use a trylock. If we fail to get the lock, just skip
876 * it
877 */
878 if (!spin_trylock(&dentry->d_lock))
879 return LRU_SKIP;
880
881 /*
882 * Referenced dentries are still in use. If they have active
883 * counts, just remove them from the LRU. Otherwise give them
884 * another pass through the LRU.
885 */
886 if (dentry->d_lockref.count) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400887 d_lru_isolate(dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +1000888 spin_unlock(&dentry->d_lock);
889 return LRU_REMOVED;
890 }
891
892 if (dentry->d_flags & DCACHE_REFERENCED) {
893 dentry->d_flags &= ~DCACHE_REFERENCED;
894 spin_unlock(&dentry->d_lock);
895
896 /*
897 * The list move itself will be made by the common LRU code. At
898 * this point, we've dropped the dentry->d_lock but keep the
899 * lru lock. This is safe to do, since every list movement is
900 * protected by the lru lock even if both locks are held.
901 *
902 * This is guaranteed by the fact that all LRU management
903 * functions are intermediated by the LRU API calls like
904 * list_lru_add and list_lru_del. List movement in this file
905 * only ever occur through this functions or through callbacks
906 * like this one, that are called from the LRU API.
907 *
908 * The only exceptions to this are functions like
909 * shrink_dentry_list, and code that first checks for the
910 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
911 * operating only with stack provided lists after they are
912 * properly isolated from the main list. It is thus, always a
913 * local access.
914 */
915 return LRU_ROTATE;
916 }
917
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400918 d_lru_shrink_move(dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +1000919 spin_unlock(&dentry->d_lock);
920
921 return LRU_REMOVED;
922}
923
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400924/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000925 * prune_dcache_sb - shrink the dcache
926 * @sb: superblock
Dave Chinnerf6041562013-08-28 10:18:00 +1000927 * @nr_to_scan : number of entries to try to free
Dave Chinner9b17c622013-08-28 10:18:05 +1000928 * @nid: which node to scan for freeable entities
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400929 *
Dave Chinnerf6041562013-08-28 10:18:00 +1000930 * Attempt to shrink the superblock dcache LRU by @nr_to_scan entries. This is
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000931 * done when we need more memory an called from the superblock shrinker
932 * function.
933 *
934 * This function may fail to free any resources if all the dentries are in
935 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400936 */
Dave Chinner9b17c622013-08-28 10:18:05 +1000937long prune_dcache_sb(struct super_block *sb, unsigned long nr_to_scan,
938 int nid)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400939{
Dave Chinnerf6041562013-08-28 10:18:00 +1000940 LIST_HEAD(dispose);
941 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400942
Dave Chinner9b17c622013-08-28 10:18:05 +1000943 freed = list_lru_walk_node(&sb->s_dentry_lru, nid, dentry_lru_isolate,
944 &dispose, &nr_to_scan);
Dave Chinnerf6041562013-08-28 10:18:00 +1000945 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +1000946 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947}
948
Glauber Costa4e717f52013-08-28 10:18:03 +1000949static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
950 spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000951{
Glauber Costa4e717f52013-08-28 10:18:03 +1000952 struct list_head *freeable = arg;
953 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000954
Glauber Costa4e717f52013-08-28 10:18:03 +1000955 /*
956 * we are inverting the lru lock/dentry->d_lock here,
957 * so use a trylock. If we fail to get the lock, just skip
958 * it
959 */
960 if (!spin_trylock(&dentry->d_lock))
961 return LRU_SKIP;
962
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400963 d_lru_shrink_move(dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +1000964 spin_unlock(&dentry->d_lock);
965
966 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000967}
968
Glauber Costa4e717f52013-08-28 10:18:03 +1000969
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700970/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 * shrink_dcache_sb - shrink dcache for a superblock
972 * @sb: superblock
973 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400974 * Shrink the dcache for the specified super block. This is used to free
975 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400977void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978{
Glauber Costa4e717f52013-08-28 10:18:03 +1000979 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400980
Glauber Costa4e717f52013-08-28 10:18:03 +1000981 do {
982 LIST_HEAD(dispose);
983
984 freed = list_lru_walk(&sb->s_dentry_lru,
985 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
986
987 this_cpu_sub(nr_dentry_unused, freed);
988 shrink_dentry_list(&dispose);
989 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700991EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +0200994 * enum d_walk_ret - action to talke during tree walk
995 * @D_WALK_CONTINUE: contrinue walk
996 * @D_WALK_QUIT: quit walk
997 * @D_WALK_NORETRY: quit when retry is needed
998 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001000enum d_walk_ret {
1001 D_WALK_CONTINUE,
1002 D_WALK_QUIT,
1003 D_WALK_NORETRY,
1004 D_WALK_SKIP,
1005};
1006
1007/**
1008 * d_walk - walk the dentry tree
1009 * @parent: start of walk
1010 * @data: data passed to @enter() and @finish()
1011 * @enter: callback when first entering the dentry
1012 * @finish: callback when successfully finished the walk
1013 *
1014 * The @enter() and @finish() callbacks are called with d_lock held.
1015 */
1016static void d_walk(struct dentry *parent, void *data,
1017 enum d_walk_ret (*enter)(void *, struct dentry *),
1018 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019{
Nick Piggin949854d2011-01-07 17:49:37 +11001020 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001022 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001023 enum d_walk_ret ret;
1024 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001025
Nick Piggin58db63d2011-01-07 17:49:39 +11001026again:
Al Viro48f5ec22013-09-09 15:22:25 -04001027 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001028 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001029 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001030
1031 ret = enter(data, this_parent);
1032 switch (ret) {
1033 case D_WALK_CONTINUE:
1034 break;
1035 case D_WALK_QUIT:
1036 case D_WALK_SKIP:
1037 goto out_unlock;
1038 case D_WALK_NORETRY:
1039 retry = false;
1040 break;
1041 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042repeat:
1043 next = this_parent->d_subdirs.next;
1044resume:
1045 while (next != &this_parent->d_subdirs) {
1046 struct list_head *tmp = next;
Eric Dumazet5160ee62006-01-08 01:03:32 -08001047 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001049
1050 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001051
1052 ret = enter(data, dentry);
1053 switch (ret) {
1054 case D_WALK_CONTINUE:
1055 break;
1056 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001057 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001058 goto out_unlock;
1059 case D_WALK_NORETRY:
1060 retry = false;
1061 break;
1062 case D_WALK_SKIP:
1063 spin_unlock(&dentry->d_lock);
1064 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001065 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001066
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001068 spin_unlock(&this_parent->d_lock);
1069 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001071 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 goto repeat;
1073 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001074 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 }
1076 /*
1077 * All done at this level ... ascend and resume the search.
1078 */
1079 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001080 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001081 this_parent = child->d_parent;
1082
1083 rcu_read_lock();
1084 spin_unlock(&child->d_lock);
1085 spin_lock(&this_parent->d_lock);
1086
1087 /*
1088 * might go back up the wrong parent if we have had a rename
1089 * or deletion
1090 */
1091 if (this_parent != child->d_parent ||
1092 (child->d_flags & DCACHE_DENTRY_KILLED) ||
1093 need_seqretry(&rename_lock, seq)) {
1094 spin_unlock(&this_parent->d_lock);
1095 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11001096 goto rename_retry;
Al Viro31dec132013-10-25 17:04:27 -04001097 }
1098 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11001099 next = child->d_u.d_child.next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 goto resume;
1101 }
Al Viro48f5ec22013-09-09 15:22:25 -04001102 if (need_seqretry(&rename_lock, seq)) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001103 spin_unlock(&this_parent->d_lock);
1104 goto rename_retry;
1105 }
1106 if (finish)
1107 finish(data);
1108
1109out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001110 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001111 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001112 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001113
1114rename_retry:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001115 if (!retry)
1116 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001117 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001118 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001120
1121/*
1122 * Search for at least 1 mount point in the dentry's subdirs.
1123 * We descend to the next level whenever the d_subdirs
1124 * list is non-empty and continue searching.
1125 */
1126
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001127static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1128{
1129 int *ret = data;
1130 if (d_mountpoint(dentry)) {
1131 *ret = 1;
1132 return D_WALK_QUIT;
1133 }
1134 return D_WALK_CONTINUE;
1135}
1136
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001137/**
1138 * have_submounts - check for mounts over a dentry
1139 * @parent: dentry to check.
1140 *
1141 * Return true if the parent or its subdirectories contain
1142 * a mount point
1143 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001144int have_submounts(struct dentry *parent)
1145{
1146 int ret = 0;
1147
1148 d_walk(parent, &ret, check_mount, NULL);
1149
1150 return ret;
1151}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001152EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153
1154/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001155 * Called by mount code to set a mountpoint and check if the mountpoint is
1156 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1157 * subtree can become unreachable).
1158 *
1159 * Only one of check_submounts_and_drop() and d_set_mounted() must succeed. For
1160 * this reason take rename_lock and d_lock on dentry and ancestors.
1161 */
1162int d_set_mounted(struct dentry *dentry)
1163{
1164 struct dentry *p;
1165 int ret = -ENOENT;
1166 write_seqlock(&rename_lock);
1167 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
1168 /* Need exclusion wrt. check_submounts_and_drop() */
1169 spin_lock(&p->d_lock);
1170 if (unlikely(d_unhashed(p))) {
1171 spin_unlock(&p->d_lock);
1172 goto out;
1173 }
1174 spin_unlock(&p->d_lock);
1175 }
1176 spin_lock(&dentry->d_lock);
1177 if (!d_unlinked(dentry)) {
1178 dentry->d_flags |= DCACHE_MOUNTED;
1179 ret = 0;
1180 }
1181 spin_unlock(&dentry->d_lock);
1182out:
1183 write_sequnlock(&rename_lock);
1184 return ret;
1185}
1186
1187/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001188 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 * and move any unused dentries to the end of the unused
1190 * list for prune_dcache(). We descend to the next level
1191 * whenever the d_subdirs list is non-empty and continue
1192 * searching.
1193 *
1194 * It returns zero iff there are no unused children,
1195 * otherwise it returns the number of children moved to
1196 * the end of the unused list. This may not be the total
1197 * number of unused children, because select_parent can
1198 * drop the lock and return early due to latency
1199 * constraints.
1200 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001201
1202struct select_data {
1203 struct dentry *start;
1204 struct list_head dispose;
1205 int found;
1206};
1207
1208static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001210 struct select_data *data = _data;
1211 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001213 if (data->start == dentry)
1214 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001216 /*
1217 * move only zero ref count dentries to the dispose list.
1218 *
1219 * Those which are presently on the shrink list, being processed
1220 * by shrink_dentry_list(), shouldn't be moved. Otherwise the
1221 * loop in shrink_dcache_parent() might not make any progress
1222 * and loop forever.
1223 */
1224 if (dentry->d_lockref.count) {
1225 dentry_lru_del(dentry);
1226 } else if (!(dentry->d_flags & DCACHE_SHRINK_LIST)) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001227 /*
1228 * We can't use d_lru_shrink_move() because we
1229 * need to get the global LRU lock and do the
Linus Torvalds05a82522013-09-15 07:11:01 -04001230 * LRU accounting.
Linus Torvalds89dc77b2013-09-13 22:55:10 -04001231 */
1232 d_lru_del(dentry);
1233 d_shrink_add(dentry, &data->dispose);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001234 data->found++;
1235 ret = D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 }
1237 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001238 * We can return to the caller if we have found some (this
1239 * ensures forward progress). We'll be coming back to find
1240 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001242 if (data->found && need_resched())
1243 ret = D_WALK_QUIT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001245 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246}
1247
1248/**
1249 * shrink_dcache_parent - prune dcache
1250 * @parent: parent of entries to prune
1251 *
1252 * Prune the dcache to remove unused children of the parent dentry.
1253 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001254void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001256 for (;;) {
1257 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001259 INIT_LIST_HEAD(&data.dispose);
1260 data.start = parent;
1261 data.found = 0;
1262
1263 d_walk(parent, &data, select_collect, NULL);
1264 if (!data.found)
1265 break;
1266
1267 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001268 cond_resched();
1269 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001271EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272
Al Viro42c32602013-11-08 12:31:16 -05001273static enum d_walk_ret umount_collect(void *_data, struct dentry *dentry)
1274{
1275 struct select_data *data = _data;
1276 enum d_walk_ret ret = D_WALK_CONTINUE;
1277
1278 if (dentry->d_lockref.count) {
1279 dentry_lru_del(dentry);
1280 if (likely(!list_empty(&dentry->d_subdirs)))
1281 goto out;
1282 if (dentry == data->start && dentry->d_lockref.count == 1)
1283 goto out;
1284 printk(KERN_ERR
1285 "BUG: Dentry %p{i=%lx,n=%s}"
1286 " still in use (%d)"
1287 " [unmount of %s %s]\n",
1288 dentry,
1289 dentry->d_inode ?
1290 dentry->d_inode->i_ino : 0UL,
1291 dentry->d_name.name,
1292 dentry->d_lockref.count,
1293 dentry->d_sb->s_type->name,
1294 dentry->d_sb->s_id);
1295 BUG();
1296 } else if (!(dentry->d_flags & DCACHE_SHRINK_LIST)) {
1297 /*
1298 * We can't use d_lru_shrink_move() because we
1299 * need to get the global LRU lock and do the
1300 * LRU accounting.
1301 */
1302 if (dentry->d_flags & DCACHE_LRU_LIST)
1303 d_lru_del(dentry);
1304 d_shrink_add(dentry, &data->dispose);
1305 data->found++;
1306 ret = D_WALK_NORETRY;
1307 }
1308out:
1309 if (data->found && need_resched())
1310 ret = D_WALK_QUIT;
1311 return ret;
1312}
1313
1314/*
1315 * destroy the dentries attached to a superblock on unmounting
1316 */
1317void shrink_dcache_for_umount(struct super_block *sb)
1318{
1319 struct dentry *dentry;
1320
1321 if (down_read_trylock(&sb->s_umount))
1322 BUG();
1323
1324 dentry = sb->s_root;
1325 sb->s_root = NULL;
1326 for (;;) {
1327 struct select_data data;
1328
1329 INIT_LIST_HEAD(&data.dispose);
1330 data.start = dentry;
1331 data.found = 0;
1332
1333 d_walk(dentry, &data, umount_collect, NULL);
1334 if (!data.found)
1335 break;
1336
1337 shrink_dentry_list(&data.dispose);
1338 cond_resched();
1339 }
1340 d_drop(dentry);
1341 dput(dentry);
1342
1343 while (!hlist_bl_empty(&sb->s_anon)) {
1344 struct select_data data;
1345 dentry = hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash);
1346
1347 INIT_LIST_HEAD(&data.dispose);
1348 data.start = NULL;
1349 data.found = 0;
1350
1351 d_walk(dentry, &data, umount_collect, NULL);
1352 if (data.found)
1353 shrink_dentry_list(&data.dispose);
1354 cond_resched();
1355 }
1356}
1357
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001358static enum d_walk_ret check_and_collect(void *_data, struct dentry *dentry)
1359{
1360 struct select_data *data = _data;
1361
1362 if (d_mountpoint(dentry)) {
1363 data->found = -EBUSY;
1364 return D_WALK_QUIT;
1365 }
1366
1367 return select_collect(_data, dentry);
1368}
1369
1370static void check_and_drop(void *_data)
1371{
1372 struct select_data *data = _data;
1373
1374 if (d_mountpoint(data->start))
1375 data->found = -EBUSY;
1376 if (!data->found)
1377 __d_drop(data->start);
1378}
1379
1380/**
1381 * check_submounts_and_drop - prune dcache, check for submounts and drop
1382 *
1383 * All done as a single atomic operation relative to has_unlinked_ancestor().
1384 * Returns 0 if successfully unhashed @parent. If there were submounts then
1385 * return -EBUSY.
1386 *
1387 * @dentry: dentry to prune and drop
1388 */
1389int check_submounts_and_drop(struct dentry *dentry)
1390{
1391 int ret = 0;
1392
1393 /* Negative dentries can be dropped without further checks */
1394 if (!dentry->d_inode) {
1395 d_drop(dentry);
1396 goto out;
1397 }
1398
1399 for (;;) {
1400 struct select_data data;
1401
1402 INIT_LIST_HEAD(&data.dispose);
1403 data.start = dentry;
1404 data.found = 0;
1405
1406 d_walk(dentry, &data, check_and_collect, check_and_drop);
1407 ret = data.found;
1408
1409 if (!list_empty(&data.dispose))
1410 shrink_dentry_list(&data.dispose);
1411
1412 if (ret <= 0)
1413 break;
1414
1415 cond_resched();
1416 }
1417
1418out:
1419 return ret;
1420}
1421EXPORT_SYMBOL(check_submounts_and_drop);
1422
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423/**
Al Viroa4464db2011-07-07 15:03:58 -04001424 * __d_alloc - allocate a dcache entry
1425 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 * @name: qstr of the name
1427 *
1428 * Allocates a dentry. It returns %NULL if there is insufficient memory
1429 * available. On a success the dentry is returned. The name passed in is
1430 * copied and the copy passed in may be reused after this call.
1431 */
1432
Al Viroa4464db2011-07-07 15:03:58 -04001433struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434{
1435 struct dentry *dentry;
1436 char *dname;
1437
Mel Gormane12ba742007-10-16 01:25:52 -07001438 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 if (!dentry)
1440 return NULL;
1441
Linus Torvalds6326c712012-05-21 16:14:04 -07001442 /*
1443 * We guarantee that the inline name is always NUL-terminated.
1444 * This way the memcpy() done by the name switching in rename
1445 * will still always have a NUL at the end, even if we might
1446 * be overwriting an internal NUL character
1447 */
1448 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 if (name->len > DNAME_INLINE_LEN-1) {
1450 dname = kmalloc(name->len + 1, GFP_KERNEL);
1451 if (!dname) {
1452 kmem_cache_free(dentry_cache, dentry);
1453 return NULL;
1454 }
1455 } else {
1456 dname = dentry->d_iname;
1457 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458
1459 dentry->d_name.len = name->len;
1460 dentry->d_name.hash = name->hash;
1461 memcpy(dname, name->name, name->len);
1462 dname[name->len] = 0;
1463
Linus Torvalds6326c712012-05-21 16:14:04 -07001464 /* Make sure we always see the terminating NUL character */
1465 smp_wmb();
1466 dentry->d_name.name = dname;
1467
Waiman Long98474232013-08-28 18:24:59 -07001468 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001469 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001471 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001473 dentry->d_parent = dentry;
1474 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475 dentry->d_op = NULL;
1476 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001477 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 INIT_LIST_HEAD(&dentry->d_lru);
1479 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Virob3d9b7a2012-06-09 13:51:19 -04001480 INIT_HLIST_NODE(&dentry->d_alias);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001481 INIT_LIST_HEAD(&dentry->d_u.d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001482 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483
Nick Piggin3e880fb2011-01-07 17:49:19 +11001484 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001485
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 return dentry;
1487}
Al Viroa4464db2011-07-07 15:03:58 -04001488
1489/**
1490 * d_alloc - allocate a dcache entry
1491 * @parent: parent of entry to allocate
1492 * @name: qstr of the name
1493 *
1494 * Allocates a dentry. It returns %NULL if there is insufficient memory
1495 * available. On a success the dentry is returned. The name passed in is
1496 * copied and the copy passed in may be reused after this call.
1497 */
1498struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1499{
1500 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1501 if (!dentry)
1502 return NULL;
1503
1504 spin_lock(&parent->d_lock);
1505 /*
1506 * don't need child lock because it is not subject
1507 * to concurrency here
1508 */
1509 __dget_dlock(parent);
1510 dentry->d_parent = parent;
1511 list_add(&dentry->d_u.d_child, &parent->d_subdirs);
1512 spin_unlock(&parent->d_lock);
1513
1514 return dentry;
1515}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001516EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001518/**
1519 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1520 * @sb: the superblock
1521 * @name: qstr of the name
1522 *
1523 * For a filesystem that just pins its dentries in memory and never
1524 * performs lookups at all, return an unhashed IS_ROOT dentry.
1525 */
Nick Piggin4b936882011-01-07 17:50:07 +11001526struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1527{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001528 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001529}
1530EXPORT_SYMBOL(d_alloc_pseudo);
1531
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1533{
1534 struct qstr q;
1535
1536 q.name = name;
1537 q.len = strlen(name);
1538 q.hash = full_name_hash(q.name, q.len);
1539 return d_alloc(parent, &q);
1540}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001541EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542
Nick Pigginfb045ad2011-01-07 17:49:55 +11001543void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1544{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001545 WARN_ON_ONCE(dentry->d_op);
1546 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001547 DCACHE_OP_COMPARE |
1548 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001549 DCACHE_OP_WEAK_REVALIDATE |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001550 DCACHE_OP_DELETE ));
1551 dentry->d_op = op;
1552 if (!op)
1553 return;
1554 if (op->d_hash)
1555 dentry->d_flags |= DCACHE_OP_HASH;
1556 if (op->d_compare)
1557 dentry->d_flags |= DCACHE_OP_COMPARE;
1558 if (op->d_revalidate)
1559 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001560 if (op->d_weak_revalidate)
1561 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001562 if (op->d_delete)
1563 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001564 if (op->d_prune)
1565 dentry->d_flags |= DCACHE_OP_PRUNE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001566
1567}
1568EXPORT_SYMBOL(d_set_d_op);
1569
David Howellsb18825a2013-09-12 19:22:53 +01001570static unsigned d_flags_for_inode(struct inode *inode)
1571{
1572 unsigned add_flags = DCACHE_FILE_TYPE;
1573
1574 if (!inode)
1575 return DCACHE_MISS_TYPE;
1576
1577 if (S_ISDIR(inode->i_mode)) {
1578 add_flags = DCACHE_DIRECTORY_TYPE;
1579 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1580 if (unlikely(!inode->i_op->lookup))
1581 add_flags = DCACHE_AUTODIR_TYPE;
1582 else
1583 inode->i_opflags |= IOP_LOOKUP;
1584 }
1585 } else if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
1586 if (unlikely(inode->i_op->follow_link))
1587 add_flags = DCACHE_SYMLINK_TYPE;
1588 else
1589 inode->i_opflags |= IOP_NOFOLLOW;
1590 }
1591
1592 if (unlikely(IS_AUTOMOUNT(inode)))
1593 add_flags |= DCACHE_NEED_AUTOMOUNT;
1594 return add_flags;
1595}
1596
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001597static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1598{
David Howellsb18825a2013-09-12 19:22:53 +01001599 unsigned add_flags = d_flags_for_inode(inode);
1600
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001601 spin_lock(&dentry->d_lock);
Al Viro22213312014-04-19 12:30:58 -04001602 __d_set_type(dentry, add_flags);
David Howellsb18825a2013-09-12 19:22:53 +01001603 if (inode)
Al Virob3d9b7a2012-06-09 13:51:19 -04001604 hlist_add_head(&dentry->d_alias, &inode->i_dentry);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001605 dentry->d_inode = inode;
Nick Piggin31e6b012011-01-07 17:49:52 +11001606 dentry_rcuwalk_barrier(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001607 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001608 fsnotify_d_instantiate(dentry, inode);
1609}
1610
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611/**
1612 * d_instantiate - fill in inode information for a dentry
1613 * @entry: dentry to complete
1614 * @inode: inode to attach to this dentry
1615 *
1616 * Fill in inode information in the entry.
1617 *
1618 * This turns negative dentries into productive full members
1619 * of society.
1620 *
1621 * NOTE! This assumes that the inode count has been incremented
1622 * (or otherwise set) by the caller to indicate that it is now
1623 * in use by the dcache.
1624 */
1625
1626void d_instantiate(struct dentry *entry, struct inode * inode)
1627{
Al Virob3d9b7a2012-06-09 13:51:19 -04001628 BUG_ON(!hlist_unhashed(&entry->d_alias));
Nick Piggin873feea2011-01-07 17:50:06 +11001629 if (inode)
1630 spin_lock(&inode->i_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001631 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001632 if (inode)
1633 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 security_d_instantiate(entry, inode);
1635}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001636EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637
1638/**
1639 * d_instantiate_unique - instantiate a non-aliased dentry
1640 * @entry: dentry to instantiate
1641 * @inode: inode to attach to this dentry
1642 *
1643 * Fill in inode information in the entry. On success, it returns NULL.
1644 * If an unhashed alias of "entry" already exists, then we return the
Oleg Drokine866cfa2006-01-09 20:52:51 -08001645 * aliased dentry instead and drop one reference to inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 *
1647 * Note that in order to avoid conflicts with rename() etc, the caller
1648 * had better be holding the parent directory semaphore.
Oleg Drokine866cfa2006-01-09 20:52:51 -08001649 *
1650 * This also assumes that the inode count has been incremented
1651 * (or otherwise set) by the caller to indicate that it is now
1652 * in use by the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 */
David Howells770bfad2006-08-22 20:06:07 -04001654static struct dentry *__d_instantiate_unique(struct dentry *entry,
1655 struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656{
1657 struct dentry *alias;
1658 int len = entry->d_name.len;
1659 const char *name = entry->d_name.name;
1660 unsigned int hash = entry->d_name.hash;
1661
David Howells770bfad2006-08-22 20:06:07 -04001662 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001663 __d_instantiate(entry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001664 return NULL;
1665 }
1666
Sasha Levinb67bfe02013-02-27 17:06:00 -08001667 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Piggin9abca362011-01-07 17:49:36 +11001668 /*
1669 * Don't need alias->d_lock here, because aliases with
1670 * d_parent == entry->d_parent are not subject to name or
1671 * parent changes, because the parent inode i_mutex is held.
1672 */
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001673 if (alias->d_name.hash != hash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 continue;
1675 if (alias->d_parent != entry->d_parent)
1676 continue;
Linus Torvaldsee983e82012-05-10 12:37:10 -07001677 if (alias->d_name.len != len)
1678 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001679 if (dentry_cmp(alias, name, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 continue;
Nick Piggindc0474b2011-01-07 17:49:43 +11001681 __dget(alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 return alias;
1683 }
David Howells770bfad2006-08-22 20:06:07 -04001684
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001685 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 return NULL;
1687}
David Howells770bfad2006-08-22 20:06:07 -04001688
1689struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1690{
1691 struct dentry *result;
1692
Al Virob3d9b7a2012-06-09 13:51:19 -04001693 BUG_ON(!hlist_unhashed(&entry->d_alias));
David Howells770bfad2006-08-22 20:06:07 -04001694
Nick Piggin873feea2011-01-07 17:50:06 +11001695 if (inode)
1696 spin_lock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001697 result = __d_instantiate_unique(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001698 if (inode)
1699 spin_unlock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001700
1701 if (!result) {
1702 security_d_instantiate(entry, inode);
1703 return NULL;
1704 }
1705
1706 BUG_ON(!d_unhashed(result));
1707 iput(inode);
1708 return result;
1709}
1710
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711EXPORT_SYMBOL(d_instantiate_unique);
1712
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001713/**
1714 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1715 * @entry: dentry to complete
1716 * @inode: inode to attach to this dentry
1717 *
1718 * Fill in inode information in the entry. If a directory alias is found, then
1719 * return an error (and drop inode). Together with d_materialise_unique() this
1720 * guarantees that a directory inode may never have more than one alias.
1721 */
1722int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1723{
1724 BUG_ON(!hlist_unhashed(&entry->d_alias));
1725
1726 spin_lock(&inode->i_lock);
1727 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1728 spin_unlock(&inode->i_lock);
1729 iput(inode);
1730 return -EBUSY;
1731 }
1732 __d_instantiate(entry, inode);
1733 spin_unlock(&inode->i_lock);
1734 security_d_instantiate(entry, inode);
1735
1736 return 0;
1737}
1738EXPORT_SYMBOL(d_instantiate_no_diralias);
1739
Al Viroadc0e912012-01-08 16:49:21 -05001740struct dentry *d_make_root(struct inode *root_inode)
1741{
1742 struct dentry *res = NULL;
1743
1744 if (root_inode) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07001745 static const struct qstr name = QSTR_INIT("/", 1);
Al Viroadc0e912012-01-08 16:49:21 -05001746
1747 res = __d_alloc(root_inode->i_sb, &name);
1748 if (res)
1749 d_instantiate(res, root_inode);
1750 else
1751 iput(root_inode);
1752 }
1753 return res;
1754}
1755EXPORT_SYMBOL(d_make_root);
1756
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001757static struct dentry * __d_find_any_alias(struct inode *inode)
1758{
1759 struct dentry *alias;
1760
Al Virob3d9b7a2012-06-09 13:51:19 -04001761 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001762 return NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001763 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001764 __dget(alias);
1765 return alias;
1766}
1767
Sage Weil46f72b32012-01-10 09:04:37 -08001768/**
1769 * d_find_any_alias - find any alias for a given inode
1770 * @inode: inode to find an alias for
1771 *
1772 * If any aliases exist for the given inode, take and return a
1773 * reference for one of them. If no aliases exist, return %NULL.
1774 */
1775struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001776{
1777 struct dentry *de;
1778
1779 spin_lock(&inode->i_lock);
1780 de = __d_find_any_alias(inode);
1781 spin_unlock(&inode->i_lock);
1782 return de;
1783}
Sage Weil46f72b32012-01-10 09:04:37 -08001784EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001785
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786/**
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001787 * d_obtain_alias - find or allocate a dentry for a given inode
1788 * @inode: inode to allocate the dentry for
1789 *
1790 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1791 * similar open by handle operations. The returned dentry may be anonymous,
1792 * or may have a full name (if the inode was already in the cache).
1793 *
1794 * When called on a directory inode, we must ensure that the inode only ever
1795 * has one dentry. If a dentry is found, that is returned instead of
1796 * allocating a new one.
1797 *
1798 * On successful return, the reference to the inode has been transferred
Christoph Hellwig44003722008-08-11 15:49:04 +02001799 * to the dentry. In case of an error the reference on the inode is released.
1800 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1801 * be passed in and will be the error will be propagate to the return value,
1802 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001803 */
1804struct dentry *d_obtain_alias(struct inode *inode)
1805{
NeilBrownb911a6b2012-11-08 16:09:37 -08001806 static const struct qstr anonstring = QSTR_INIT("/", 1);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001807 struct dentry *tmp;
1808 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001809 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001810
1811 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001812 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001813 if (IS_ERR(inode))
1814 return ERR_CAST(inode);
1815
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001816 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001817 if (res)
1818 goto out_iput;
1819
Al Viroa4464db2011-07-07 15:03:58 -04001820 tmp = __d_alloc(inode->i_sb, &anonstring);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001821 if (!tmp) {
1822 res = ERR_PTR(-ENOMEM);
1823 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001824 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001825
Nick Piggin873feea2011-01-07 17:50:06 +11001826 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001827 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001828 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001829 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001830 dput(tmp);
1831 goto out_iput;
1832 }
1833
1834 /* attach a disconnected dentry */
David Howellsb18825a2013-09-12 19:22:53 +01001835 add_flags = d_flags_for_inode(inode) | DCACHE_DISCONNECTED;
1836
Christoph Hellwig9308a612008-08-11 15:49:12 +02001837 spin_lock(&tmp->d_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001838 tmp->d_inode = inode;
David Howellsb18825a2013-09-12 19:22:53 +01001839 tmp->d_flags |= add_flags;
Al Virob3d9b7a2012-06-09 13:51:19 -04001840 hlist_add_head(&tmp->d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001841 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001842 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001843 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001844 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001845 spin_unlock(&inode->i_lock);
Josef Bacik24ff6662010-11-18 20:52:55 -05001846 security_d_instantiate(tmp, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001847
Christoph Hellwig9308a612008-08-11 15:49:12 +02001848 return tmp;
1849
1850 out_iput:
Josef Bacik24ff6662010-11-18 20:52:55 -05001851 if (res && !IS_ERR(res))
1852 security_d_instantiate(res, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001853 iput(inode);
1854 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001855}
Benny Halevyadc48722009-02-27 14:02:59 -08001856EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857
1858/**
1859 * d_splice_alias - splice a disconnected dentry into the tree if one exists
1860 * @inode: the inode which may have a disconnected dentry
1861 * @dentry: a negative dentry which we want to point to the inode.
1862 *
1863 * If inode is a directory and has a 'disconnected' dentry (i.e. IS_ROOT and
1864 * DCACHE_DISCONNECTED), then d_move that in place of the given dentry
1865 * and return it, else simply d_add the inode to the dentry and return NULL.
1866 *
1867 * This is needed in the lookup routine of any filesystem that is exportable
1868 * (via knfsd) so that we can build dcache paths to directories effectively.
1869 *
1870 * If a dentry was found and moved, then it is returned. Otherwise NULL
1871 * is returned. This matches the expected return value of ->lookup.
1872 *
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001873 * Cluster filesystems may call this function with a negative, hashed dentry.
1874 * In that case, we know that the inode will be a regular file, and also this
1875 * will only occur during atomic_open. So we need to check for the dentry
1876 * being already hashed only in the final case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 */
1878struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
1879{
1880 struct dentry *new = NULL;
1881
Al Viroa9049372011-07-08 21:20:11 -04001882 if (IS_ERR(inode))
1883 return ERR_CAST(inode);
1884
NeilBrown21c0d8f2006-10-04 02:16:16 -07001885 if (inode && S_ISDIR(inode->i_mode)) {
Nick Piggin873feea2011-01-07 17:50:06 +11001886 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001887 new = __d_find_alias(inode, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 if (new) {
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001889 BUG_ON(!(new->d_flags & DCACHE_DISCONNECTED));
Nick Piggin873feea2011-01-07 17:50:06 +11001890 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891 security_d_instantiate(new, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 d_move(new, dentry);
1893 iput(inode);
1894 } else {
Nick Piggin873feea2011-01-07 17:50:06 +11001895 /* already taking inode->i_lock, so d_add() by hand */
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001896 __d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001897 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 security_d_instantiate(dentry, inode);
1899 d_rehash(dentry);
1900 }
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001901 } else {
1902 d_instantiate(dentry, inode);
1903 if (d_unhashed(dentry))
1904 d_rehash(dentry);
1905 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 return new;
1907}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001908EXPORT_SYMBOL(d_splice_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909
Barry Naujok94035402008-05-21 16:50:46 +10001910/**
1911 * d_add_ci - lookup or allocate new dentry with case-exact name
1912 * @inode: the inode case-insensitive lookup has found
1913 * @dentry: the negative dentry that was passed to the parent's lookup func
1914 * @name: the case-exact name to be associated with the returned dentry
1915 *
1916 * This is to avoid filling the dcache with case-insensitive names to the
1917 * same inode, only the actual correct case is stored in the dcache for
1918 * case-insensitive filesystems.
1919 *
1920 * For a case-insensitive lookup match and if the the case-exact dentry
1921 * already exists in in the dcache, use it and return it.
1922 *
1923 * If no entry exists with the exact case name, allocate new dentry with
1924 * the exact case, and return the spliced entry.
1925 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001926struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001927 struct qstr *name)
1928{
Barry Naujok94035402008-05-21 16:50:46 +10001929 struct dentry *found;
1930 struct dentry *new;
1931
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001932 /*
1933 * First check if a dentry matching the name already exists,
1934 * if not go ahead and create it now.
1935 */
Barry Naujok94035402008-05-21 16:50:46 +10001936 found = d_hash_and_lookup(dentry->d_parent, name);
Al Viro4f522a22013-02-11 23:20:37 -05001937 if (unlikely(IS_ERR(found)))
1938 goto err_out;
Barry Naujok94035402008-05-21 16:50:46 +10001939 if (!found) {
1940 new = d_alloc(dentry->d_parent, name);
1941 if (!new) {
Al Viro4f522a22013-02-11 23:20:37 -05001942 found = ERR_PTR(-ENOMEM);
Barry Naujok94035402008-05-21 16:50:46 +10001943 goto err_out;
1944 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001945
Barry Naujok94035402008-05-21 16:50:46 +10001946 found = d_splice_alias(inode, new);
1947 if (found) {
1948 dput(new);
1949 return found;
1950 }
1951 return new;
1952 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001953
1954 /*
1955 * If a matching dentry exists, and it's not negative use it.
1956 *
1957 * Decrement the reference count to balance the iget() done
1958 * earlier on.
1959 */
Barry Naujok94035402008-05-21 16:50:46 +10001960 if (found->d_inode) {
1961 if (unlikely(found->d_inode != inode)) {
1962 /* This can't happen because bad inodes are unhashed. */
1963 BUG_ON(!is_bad_inode(inode));
1964 BUG_ON(!is_bad_inode(found->d_inode));
1965 }
Barry Naujok94035402008-05-21 16:50:46 +10001966 iput(inode);
1967 return found;
1968 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001969
Barry Naujok94035402008-05-21 16:50:46 +10001970 /*
1971 * Negative dentry: instantiate it unless the inode is a directory and
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001972 * already has a dentry.
Barry Naujok94035402008-05-21 16:50:46 +10001973 */
Al Viro4513d892011-07-17 10:52:14 -04001974 new = d_splice_alias(inode, found);
1975 if (new) {
1976 dput(found);
1977 found = new;
Barry Naujok94035402008-05-21 16:50:46 +10001978 }
Al Viro4513d892011-07-17 10:52:14 -04001979 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001980
1981err_out:
1982 iput(inode);
Al Viro4f522a22013-02-11 23:20:37 -05001983 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001984}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001985EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001987/*
1988 * Do the slow-case of the dentry name compare.
1989 *
1990 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07001991 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001992 * filesystem can rely on them, and can use the 'name' and
1993 * 'len' information without worrying about walking off the
1994 * end of memory etc.
1995 *
1996 * Thus the read_seqcount_retry() and the "duplicate" info
1997 * in arguments (the low-level filesystem should not look
1998 * at the dentry inode or name contents directly, since
1999 * rename can change them while we're in RCU mode).
2000 */
2001enum slow_d_compare {
2002 D_COMP_OK,
2003 D_COMP_NOMATCH,
2004 D_COMP_SEQRETRY,
2005};
2006
2007static noinline enum slow_d_compare slow_dentry_cmp(
2008 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002009 struct dentry *dentry,
2010 unsigned int seq,
2011 const struct qstr *name)
2012{
2013 int tlen = dentry->d_name.len;
2014 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002015
2016 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2017 cpu_relax();
2018 return D_COMP_SEQRETRY;
2019 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002020 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002021 return D_COMP_NOMATCH;
2022 return D_COMP_OK;
2023}
2024
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002026 * __d_lookup_rcu - search for a dentry (racy, store-free)
2027 * @parent: parent dentry
2028 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002029 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002030 * Returns: dentry, or NULL
2031 *
2032 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2033 * resolution (store-free path walking) design described in
2034 * Documentation/filesystems/path-lookup.txt.
2035 *
2036 * This is not to be used outside core vfs.
2037 *
2038 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2039 * held, and rcu_read_lock held. The returned dentry must not be stored into
2040 * without taking d_lock and checking d_seq sequence count against @seq
2041 * returned here.
2042 *
Linus Torvalds15570082013-09-02 11:38:06 -07002043 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002044 * function.
2045 *
2046 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2047 * the returned dentry, so long as its parent's seqlock is checked after the
2048 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2049 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002050 *
2051 * NOTE! The caller *has* to check the resulting dentry against the sequence
2052 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002053 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002054struct dentry *__d_lookup_rcu(const struct dentry *parent,
2055 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002056 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002057{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002058 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002059 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002060 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002061 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002062 struct dentry *dentry;
2063
2064 /*
2065 * Note: There is significant duplication with __d_lookup_rcu which is
2066 * required to prevent single threaded performance regressions
2067 * especially on architectures where smp_rmb (in seqcounts) are costly.
2068 * Keep the two functions in sync.
2069 */
2070
2071 /*
2072 * The hash list is protected using RCU.
2073 *
2074 * Carefully use d_seq when comparing a candidate dentry, to avoid
2075 * races with d_move().
2076 *
2077 * It is possible that concurrent renames can mess up our list
2078 * walk here and result in missing our dentry, resulting in the
2079 * false-negative result. d_lookup() protects against concurrent
2080 * renames using rename_lock seqlock.
2081 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002082 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002083 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002084 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002085 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002086
Nick Piggin31e6b012011-01-07 17:49:52 +11002087seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002088 /*
2089 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002090 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002091 *
2092 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002093 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002094 *
2095 * NOTE! We do a "raw" seqcount_begin here. That means that
2096 * we don't wait for the sequence count to stabilize if it
2097 * is in the middle of a sequence change. If we do the slow
2098 * dentry compare, we will do seqretries until it is stable,
2099 * and if we end up with a successful lookup, we actually
2100 * want to exit RCU lookup anyway.
2101 */
2102 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002103 if (dentry->d_parent != parent)
2104 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002105 if (d_unhashed(dentry))
2106 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002107
2108 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002109 if (dentry->d_name.hash != hashlen_hash(hashlen))
2110 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002111 *seqp = seq;
2112 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002113 case D_COMP_OK:
2114 return dentry;
2115 case D_COMP_NOMATCH:
2116 continue;
2117 default:
2118 goto seqretry;
2119 }
2120 }
2121
Linus Torvalds26fe5752012-05-10 13:14:12 -07002122 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002123 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002124 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002125 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002126 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002127 }
2128 return NULL;
2129}
2130
2131/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132 * d_lookup - search for a dentry
2133 * @parent: parent dentry
2134 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002135 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002137 * d_lookup searches the children of the parent dentry for the name in
2138 * question. If the dentry is found its reference count is incremented and the
2139 * dentry is returned. The caller must use dput to free the entry when it has
2140 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 */
Al Viroda2d8452013-01-24 18:29:34 -05002142struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143{
Nick Piggin31e6b012011-01-07 17:49:52 +11002144 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002145 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146
2147 do {
2148 seq = read_seqbegin(&rename_lock);
2149 dentry = __d_lookup(parent, name);
2150 if (dentry)
2151 break;
2152 } while (read_seqretry(&rename_lock, seq));
2153 return dentry;
2154}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002155EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156
Nick Piggin31e6b012011-01-07 17:49:52 +11002157/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002158 * __d_lookup - search for a dentry (racy)
2159 * @parent: parent dentry
2160 * @name: qstr of name we wish to find
2161 * Returns: dentry, or NULL
2162 *
2163 * __d_lookup is like d_lookup, however it may (rarely) return a
2164 * false-negative result due to unrelated rename activity.
2165 *
2166 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2167 * however it must be used carefully, eg. with a following d_lookup in
2168 * the case of failure.
2169 *
2170 * __d_lookup callers must be commented.
2171 */
Al Viroa713ca22013-01-24 18:27:00 -05002172struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173{
2174 unsigned int len = name->len;
2175 unsigned int hash = name->hash;
2176 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002177 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002178 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002179 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002180 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181
Nick Pigginb04f7842010-08-18 04:37:34 +10002182 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002183 * Note: There is significant duplication with __d_lookup_rcu which is
2184 * required to prevent single threaded performance regressions
2185 * especially on architectures where smp_rmb (in seqcounts) are costly.
2186 * Keep the two functions in sync.
2187 */
2188
2189 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002190 * The hash list is protected using RCU.
2191 *
2192 * Take d_lock when comparing a candidate dentry, to avoid races
2193 * with d_move().
2194 *
2195 * It is possible that concurrent renames can mess up our list
2196 * walk here and result in missing our dentry, resulting in the
2197 * false-negative result. d_lookup() protects against concurrent
2198 * renames using rename_lock seqlock.
2199 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002200 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002201 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202 rcu_read_lock();
2203
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002204 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206 if (dentry->d_name.hash != hash)
2207 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208
2209 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 if (dentry->d_parent != parent)
2211 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002212 if (d_unhashed(dentry))
2213 goto next;
2214
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215 /*
2216 * It is safe to compare names since d_move() cannot
2217 * change the qstr (protected by d_lock).
2218 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002219 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002220 int tlen = dentry->d_name.len;
2221 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002222 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 goto next;
2224 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002225 if (dentry->d_name.len != len)
2226 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002227 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228 goto next;
2229 }
2230
Waiman Long98474232013-08-28 18:24:59 -07002231 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002232 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233 spin_unlock(&dentry->d_lock);
2234 break;
2235next:
2236 spin_unlock(&dentry->d_lock);
2237 }
2238 rcu_read_unlock();
2239
2240 return found;
2241}
2242
2243/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002244 * d_hash_and_lookup - hash the qstr then search for a dentry
2245 * @dir: Directory to search in
2246 * @name: qstr of name we wish to find
2247 *
Al Viro4f522a22013-02-11 23:20:37 -05002248 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002249 */
2250struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2251{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002252 /*
2253 * Check for a fs-specific hash function. Note that we must
2254 * calculate the standard hash first, as the d_op->d_hash()
2255 * routine may choose to leave the hash value unchanged.
2256 */
2257 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002258 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002259 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002260 if (unlikely(err < 0))
2261 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002262 }
Al Viro4f522a22013-02-11 23:20:37 -05002263 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002264}
Al Viro4f522a22013-02-11 23:20:37 -05002265EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002266
2267/**
Nick Piggin786a5e12011-01-07 17:49:16 +11002268 * d_validate - verify dentry provided from insecure source (deprecated)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269 * @dentry: The dentry alleged to be valid child of @dparent
Randy Dunlapff5fdb62011-01-22 20:16:06 -08002270 * @dparent: The parent dentry (known to be valid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271 *
2272 * An insecure source has sent us a dentry, here we verify it and dget() it.
2273 * This is used by ncpfs in its readdir implementation.
2274 * Zero is returned in the dentry is invalid.
Nick Piggin786a5e12011-01-07 17:49:16 +11002275 *
2276 * This function is slow for big directories, and deprecated, do not use it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 */
Nick Piggind3a23e12011-01-05 20:01:21 +11002278int d_validate(struct dentry *dentry, struct dentry *dparent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279{
Nick Piggin786a5e12011-01-07 17:49:16 +11002280 struct dentry *child;
Nick Piggind3a23e12011-01-05 20:01:21 +11002281
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002282 spin_lock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002283 list_for_each_entry(child, &dparent->d_subdirs, d_u.d_child) {
2284 if (dentry == child) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002285 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Nick Piggindc0474b2011-01-07 17:49:43 +11002286 __dget_dlock(dentry);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002287 spin_unlock(&dentry->d_lock);
2288 spin_unlock(&dparent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 return 1;
2290 }
2291 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002292 spin_unlock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002293
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294 return 0;
2295}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002296EXPORT_SYMBOL(d_validate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297
2298/*
2299 * When a file is deleted, we have two options:
2300 * - turn this dentry into a negative dentry
2301 * - unhash this dentry and free it.
2302 *
2303 * Usually, we want to just turn this into
2304 * a negative dentry, but if anybody else is
2305 * currently using the dentry or the inode
2306 * we can't do that and we fall back on removing
2307 * it from the hash queues and waiting for
2308 * it to be deleted later when it has no users
2309 */
2310
2311/**
2312 * d_delete - delete a dentry
2313 * @dentry: The dentry to delete
2314 *
2315 * Turn the dentry into a negative dentry if possible, otherwise
2316 * remove it from the hash queues so it can be deleted later
2317 */
2318
2319void d_delete(struct dentry * dentry)
2320{
Nick Piggin873feea2011-01-07 17:50:06 +11002321 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002322 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323 /*
2324 * Are we the only user?
2325 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002326again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002328 inode = dentry->d_inode;
2329 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002330 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002331 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002332 spin_unlock(&dentry->d_lock);
2333 cpu_relax();
2334 goto again;
2335 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002336 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002337 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002338 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339 return;
2340 }
2341
2342 if (!d_unhashed(dentry))
2343 __d_drop(dentry);
2344
2345 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002346
2347 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002348}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002349EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002351static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002353 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002354 hlist_bl_lock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -07002355 entry->d_flags |= DCACHE_RCUACCESS;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002356 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002357 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358}
2359
David Howells770bfad2006-08-22 20:06:07 -04002360static void _d_rehash(struct dentry * entry)
2361{
2362 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2363}
2364
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365/**
2366 * d_rehash - add an entry back to the hash
2367 * @entry: dentry to add to the hash
2368 *
2369 * Adds a dentry to the hash according to its name.
2370 */
2371
2372void d_rehash(struct dentry * entry)
2373{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002375 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002378EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002380/**
2381 * dentry_update_name_case - update case insensitive dentry with a new name
2382 * @dentry: dentry to be updated
2383 * @name: new name
2384 *
2385 * Update a case insensitive dentry with new case of name.
2386 *
2387 * dentry must have been returned by d_lookup with name @name. Old and new
2388 * name lengths must match (ie. no d_compare which allows mismatched name
2389 * lengths).
2390 *
2391 * Parent inode i_mutex must be held over d_lookup and into this call (to
2392 * keep renames and concurrent inserts, and readdir(2) away).
2393 */
2394void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2395{
Linus Torvalds7ebfa572011-04-15 07:34:26 -07002396 BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002397 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2398
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002399 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002400 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002401 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002402 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002403 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002404}
2405EXPORT_SYMBOL(dentry_update_name_case);
2406
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407static void switch_names(struct dentry *dentry, struct dentry *target)
2408{
2409 if (dname_external(target)) {
2410 if (dname_external(dentry)) {
2411 /*
2412 * Both external: swap the pointers
2413 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002414 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415 } else {
2416 /*
2417 * dentry:internal, target:external. Steal target's
2418 * storage and make target internal.
2419 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002420 memcpy(target->d_iname, dentry->d_name.name,
2421 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002422 dentry->d_name.name = target->d_name.name;
2423 target->d_name.name = target->d_iname;
2424 }
2425 } else {
2426 if (dname_external(dentry)) {
2427 /*
2428 * dentry:external, target:internal. Give dentry's
2429 * storage to target and make dentry internal
2430 */
2431 memcpy(dentry->d_iname, target->d_name.name,
2432 target->d_name.len + 1);
2433 target->d_name.name = dentry->d_name.name;
2434 dentry->d_name.name = dentry->d_iname;
2435 } else {
2436 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002437 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002439 unsigned int i;
2440 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2441 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2442 swap(((long *) &dentry->d_iname)[i],
2443 ((long *) &target->d_iname)[i]);
2444 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445 }
2446 }
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002447 swap(dentry->d_name.len, target->d_name.len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448}
2449
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002450static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2451{
2452 /*
2453 * XXXX: do we really need to take target->d_lock?
2454 */
2455 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2456 spin_lock(&target->d_parent->d_lock);
2457 else {
2458 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2459 spin_lock(&dentry->d_parent->d_lock);
2460 spin_lock_nested(&target->d_parent->d_lock,
2461 DENTRY_D_LOCK_NESTED);
2462 } else {
2463 spin_lock(&target->d_parent->d_lock);
2464 spin_lock_nested(&dentry->d_parent->d_lock,
2465 DENTRY_D_LOCK_NESTED);
2466 }
2467 }
2468 if (target < dentry) {
2469 spin_lock_nested(&target->d_lock, 2);
2470 spin_lock_nested(&dentry->d_lock, 3);
2471 } else {
2472 spin_lock_nested(&dentry->d_lock, 2);
2473 spin_lock_nested(&target->d_lock, 3);
2474 }
2475}
2476
2477static void dentry_unlock_parents_for_move(struct dentry *dentry,
2478 struct dentry *target)
2479{
2480 if (target->d_parent != dentry->d_parent)
2481 spin_unlock(&dentry->d_parent->d_lock);
2482 if (target->d_parent != target)
2483 spin_unlock(&target->d_parent->d_lock);
2484}
2485
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002487 * When switching names, the actual string doesn't strictly have to
2488 * be preserved in the target - because we're dropping the target
2489 * anyway. As such, we can just do a simple memcpy() to copy over
2490 * the new name before we switch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491 *
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002492 * Note that we have to be a lot more careful about getting the hash
2493 * switched - we have to switch the hash value properly even if it
2494 * then no longer matches the actual (corrupted) string of the target.
2495 * The hash value has to match the hash queue that the dentry is on..
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002497/*
Al Viro18367502011-07-12 21:42:24 -04002498 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002499 * @dentry: entry to move
2500 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002501 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002502 *
2503 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002504 * dcache entries should not be moved in this way. Caller must hold
2505 * rename_lock, the i_mutex of the source and target directories,
2506 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002508static void __d_move(struct dentry *dentry, struct dentry *target,
2509 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002511 if (!dentry->d_inode)
2512 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2513
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002514 BUG_ON(d_ancestor(dentry, target));
2515 BUG_ON(d_ancestor(target, dentry));
2516
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002517 dentry_lock_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518
Nick Piggin31e6b012011-01-07 17:49:52 +11002519 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002520 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002521
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002522 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2523
2524 /*
2525 * Move the dentry to the target hash queue. Don't bother checking
2526 * for the same hash queue because of how unlikely it is.
2527 */
2528 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002529 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530
Miklos Szeredida1ce062014-04-01 17:08:43 +02002531 /*
2532 * Unhash the target (d_delete() is not usable here). If exchanging
2533 * the two dentries, then rehash onto the other's hash queue.
2534 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002535 __d_drop(target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002536 if (exchange) {
2537 __d_rehash(target,
2538 d_hash(dentry->d_parent, dentry->d_name.hash));
2539 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002540
Eric Dumazet5160ee62006-01-08 01:03:32 -08002541 list_del(&dentry->d_u.d_child);
2542 list_del(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543
2544 /* Switch the names.. */
2545 switch_names(dentry, target);
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002546 swap(dentry->d_name.hash, target->d_name.hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547
2548 /* ... and switch the parents */
2549 if (IS_ROOT(dentry)) {
2550 dentry->d_parent = target->d_parent;
2551 target->d_parent = target;
Eric Dumazet5160ee62006-01-08 01:03:32 -08002552 INIT_LIST_HEAD(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553 } else {
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002554 swap(dentry->d_parent, target->d_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555
2556 /* And add them back to the (new) parent lists */
Eric Dumazet5160ee62006-01-08 01:03:32 -08002557 list_add(&target->d_u.d_child, &target->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558 }
2559
Eric Dumazet5160ee62006-01-08 01:03:32 -08002560 list_add(&dentry->d_u.d_child, &dentry->d_parent->d_subdirs);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002561
Nick Piggin31e6b012011-01-07 17:49:52 +11002562 write_seqcount_end(&target->d_seq);
2563 write_seqcount_end(&dentry->d_seq);
2564
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002565 dentry_unlock_parents_for_move(dentry, target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002566 if (exchange)
2567 fsnotify_d_move(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568 spin_unlock(&target->d_lock);
Nick Pigginc32ccd82006-03-25 03:07:09 -08002569 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002571}
2572
2573/*
2574 * d_move - move a dentry
2575 * @dentry: entry to move
2576 * @target: new dentry
2577 *
2578 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002579 * dcache entries should not be moved in this way. See the locking
2580 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002581 */
2582void d_move(struct dentry *dentry, struct dentry *target)
2583{
2584 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002585 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002586 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002587}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002588EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002589
Miklos Szeredida1ce062014-04-01 17:08:43 +02002590/*
2591 * d_exchange - exchange two dentries
2592 * @dentry1: first dentry
2593 * @dentry2: second dentry
2594 */
2595void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2596{
2597 write_seqlock(&rename_lock);
2598
2599 WARN_ON(!dentry1->d_inode);
2600 WARN_ON(!dentry2->d_inode);
2601 WARN_ON(IS_ROOT(dentry1));
2602 WARN_ON(IS_ROOT(dentry2));
2603
2604 __d_move(dentry1, dentry2, true);
2605
2606 write_sequnlock(&rename_lock);
2607}
2608
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002609/**
2610 * d_ancestor - search for an ancestor
2611 * @p1: ancestor dentry
2612 * @p2: child dentry
2613 *
2614 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2615 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002616 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002617struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002618{
2619 struct dentry *p;
2620
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002621 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002622 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002623 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002624 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002625 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002626}
2627
2628/*
2629 * This helper attempts to cope with remotely renamed directories
2630 *
2631 * It assumes that the caller is already holding
Al Viro18367502011-07-12 21:42:24 -04002632 * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002633 *
2634 * Note: If ever the locking in lock_rename() changes, then please
2635 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002636 */
Nick Piggin873feea2011-01-07 17:50:06 +11002637static struct dentry *__d_unalias(struct inode *inode,
2638 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002639{
2640 struct mutex *m1 = NULL, *m2 = NULL;
Al Viroee3efa92012-06-08 15:59:33 -04002641 struct dentry *ret = ERR_PTR(-EBUSY);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002642
2643 /* If alias and dentry share a parent, then no extra locks required */
2644 if (alias->d_parent == dentry->d_parent)
2645 goto out_unalias;
2646
Trond Myklebust9eaef272006-10-21 10:24:20 -07002647 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002648 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2649 goto out_err;
2650 m1 = &dentry->d_sb->s_vfs_rename_mutex;
2651 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
2652 goto out_err;
2653 m2 = &alias->d_parent->d_inode->i_mutex;
2654out_unalias:
Al Viroee3efa92012-06-08 15:59:33 -04002655 if (likely(!d_mountpoint(alias))) {
Miklos Szeredida1ce062014-04-01 17:08:43 +02002656 __d_move(alias, dentry, false);
Al Viroee3efa92012-06-08 15:59:33 -04002657 ret = alias;
2658 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002659out_err:
Nick Piggin873feea2011-01-07 17:50:06 +11002660 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002661 if (m2)
2662 mutex_unlock(m2);
2663 if (m1)
2664 mutex_unlock(m1);
2665 return ret;
2666}
2667
2668/*
David Howells770bfad2006-08-22 20:06:07 -04002669 * Prepare an anonymous dentry for life in the superblock's dentry tree as a
2670 * named dentry in place of the dentry to be replaced.
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002671 * returns with anon->d_lock held!
David Howells770bfad2006-08-22 20:06:07 -04002672 */
2673static void __d_materialise_dentry(struct dentry *dentry, struct dentry *anon)
2674{
Al Viro740da422013-01-30 10:13:38 -05002675 struct dentry *dparent;
David Howells770bfad2006-08-22 20:06:07 -04002676
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002677 dentry_lock_for_move(anon, dentry);
David Howells770bfad2006-08-22 20:06:07 -04002678
Nick Piggin31e6b012011-01-07 17:49:52 +11002679 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002680 write_seqcount_begin_nested(&anon->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002681
David Howells770bfad2006-08-22 20:06:07 -04002682 dparent = dentry->d_parent;
David Howells770bfad2006-08-22 20:06:07 -04002683
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002684 switch_names(dentry, anon);
2685 swap(dentry->d_name.hash, anon->d_name.hash);
2686
Al Viro740da422013-01-30 10:13:38 -05002687 dentry->d_parent = dentry;
2688 list_del_init(&dentry->d_u.d_child);
2689 anon->d_parent = dparent;
Wei Yongjun9ed53b12013-03-12 00:10:50 +08002690 list_move(&anon->d_u.d_child, &dparent->d_subdirs);
David Howells770bfad2006-08-22 20:06:07 -04002691
Nick Piggin31e6b012011-01-07 17:49:52 +11002692 write_seqcount_end(&dentry->d_seq);
2693 write_seqcount_end(&anon->d_seq);
2694
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002695 dentry_unlock_parents_for_move(anon, dentry);
2696 spin_unlock(&dentry->d_lock);
2697
2698 /* anon->d_lock still locked, returns locked */
David Howells770bfad2006-08-22 20:06:07 -04002699}
2700
2701/**
2702 * d_materialise_unique - introduce an inode into the tree
2703 * @dentry: candidate dentry
2704 * @inode: inode to bind to the dentry, to which aliases may be attached
2705 *
2706 * Introduces an dentry into the tree, substituting an extant disconnected
Jeff Laytonc46c8872011-07-26 13:33:16 -04002707 * root directory alias in its place if there is one. Caller must hold the
2708 * i_mutex of the parent directory.
David Howells770bfad2006-08-22 20:06:07 -04002709 */
2710struct dentry *d_materialise_unique(struct dentry *dentry, struct inode *inode)
2711{
Trond Myklebust9eaef272006-10-21 10:24:20 -07002712 struct dentry *actual;
David Howells770bfad2006-08-22 20:06:07 -04002713
2714 BUG_ON(!d_unhashed(dentry));
2715
David Howells770bfad2006-08-22 20:06:07 -04002716 if (!inode) {
2717 actual = dentry;
OGAWA Hirofumi360da902008-10-16 07:50:28 +09002718 __d_instantiate(dentry, NULL);
Nick Piggin357f8e62011-01-07 17:49:42 +11002719 d_rehash(actual);
2720 goto out_nolock;
David Howells770bfad2006-08-22 20:06:07 -04002721 }
2722
Nick Piggin873feea2011-01-07 17:50:06 +11002723 spin_lock(&inode->i_lock);
Nick Piggin357f8e62011-01-07 17:49:42 +11002724
Trond Myklebust9eaef272006-10-21 10:24:20 -07002725 if (S_ISDIR(inode->i_mode)) {
2726 struct dentry *alias;
David Howells770bfad2006-08-22 20:06:07 -04002727
Trond Myklebust9eaef272006-10-21 10:24:20 -07002728 /* Does an aliased dentry already exist? */
Linus Torvalds32ba9c32012-06-08 10:34:03 -07002729 alias = __d_find_alias(inode, 0);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002730 if (alias) {
2731 actual = alias;
Al Viro18367502011-07-12 21:42:24 -04002732 write_seqlock(&rename_lock);
2733
2734 if (d_ancestor(alias, dentry)) {
2735 /* Check for loops */
2736 actual = ERR_PTR(-ELOOP);
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002737 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002738 } else if (IS_ROOT(alias)) {
2739 /* Is this an anonymous mountpoint that we
2740 * could splice into our tree? */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002741 __d_materialise_dentry(dentry, alias);
Al Viro18367502011-07-12 21:42:24 -04002742 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002743 __d_drop(alias);
2744 goto found;
Al Viro18367502011-07-12 21:42:24 -04002745 } else {
2746 /* Nope, but we must(!) avoid directory
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002747 * aliasing. This drops inode->i_lock */
Al Viro18367502011-07-12 21:42:24 -04002748 actual = __d_unalias(inode, dentry, alias);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002749 }
Al Viro18367502011-07-12 21:42:24 -04002750 write_sequnlock(&rename_lock);
David Howellsdd179942011-08-16 15:31:30 +01002751 if (IS_ERR(actual)) {
2752 if (PTR_ERR(actual) == -ELOOP)
2753 pr_warn_ratelimited(
2754 "VFS: Lookup of '%s' in %s %s"
2755 " would have caused loop\n",
2756 dentry->d_name.name,
2757 inode->i_sb->s_type->name,
2758 inode->i_sb->s_id);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002759 dput(alias);
David Howellsdd179942011-08-16 15:31:30 +01002760 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002761 goto out_nolock;
2762 }
David Howells770bfad2006-08-22 20:06:07 -04002763 }
2764
2765 /* Add a unique reference */
2766 actual = __d_instantiate_unique(dentry, inode);
2767 if (!actual)
2768 actual = dentry;
Nick Piggin357f8e62011-01-07 17:49:42 +11002769 else
2770 BUG_ON(!d_unhashed(actual));
David Howells770bfad2006-08-22 20:06:07 -04002771
David Howells770bfad2006-08-22 20:06:07 -04002772 spin_lock(&actual->d_lock);
2773found:
2774 _d_rehash(actual);
2775 spin_unlock(&actual->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002776 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002777out_nolock:
David Howells770bfad2006-08-22 20:06:07 -04002778 if (actual == dentry) {
2779 security_d_instantiate(dentry, inode);
2780 return NULL;
2781 }
2782
2783 iput(inode);
2784 return actual;
David Howells770bfad2006-08-22 20:06:07 -04002785}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002786EXPORT_SYMBOL_GPL(d_materialise_unique);
David Howells770bfad2006-08-22 20:06:07 -04002787
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002788static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002789{
2790 *buflen -= namelen;
2791 if (*buflen < 0)
2792 return -ENAMETOOLONG;
2793 *buffer -= namelen;
2794 memcpy(*buffer, str, namelen);
2795 return 0;
2796}
2797
Waiman Long232d2d62013-09-09 12:18:13 -04002798/**
2799 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04002800 * @buffer: buffer pointer
2801 * @buflen: allocated length of the buffer
2802 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04002803 *
2804 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
2805 * make sure that either the old or the new name pointer and length are
2806 * fetched. However, there may be mismatch between length and pointer.
2807 * The length cannot be trusted, we need to copy it byte-by-byte until
2808 * the length is reached or a null byte is found. It also prepends "/" at
2809 * the beginning of the name. The sequence number check at the caller will
2810 * retry it again when a d_move() does happen. So any garbage in the buffer
2811 * due to mismatched pointer and length will be discarded.
2812 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002813static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2814{
Waiman Long232d2d62013-09-09 12:18:13 -04002815 const char *dname = ACCESS_ONCE(name->name);
2816 u32 dlen = ACCESS_ONCE(name->len);
2817 char *p;
2818
Waiman Long232d2d62013-09-09 12:18:13 -04002819 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04002820 if (*buflen < 0)
2821 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04002822 p = *buffer -= dlen + 1;
2823 *p++ = '/';
2824 while (dlen--) {
2825 char c = *dname++;
2826 if (!c)
2827 break;
2828 *p++ = c;
2829 }
2830 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002831}
2832
Linus Torvalds1da177e2005-04-16 15:20:36 -07002833/**
Randy Dunlap208898c2010-11-18 15:02:49 -08002834 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002835 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002836 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002837 * @buffer: pointer to the end of the buffer
2838 * @buflen: pointer to buffer length
2839 *
Waiman Long18129972013-09-12 10:55:35 -04002840 * The function will first try to write out the pathname without taking any
2841 * lock other than the RCU read lock to make sure that dentries won't go away.
2842 * It only checks the sequence number of the global rename_lock as any change
2843 * in the dentry's d_seq will be preceded by changes in the rename_lock
2844 * sequence number. If the sequence number had been changed, it will restart
2845 * the whole pathname back-tracing sequence again by taking the rename_lock.
2846 * In this case, there is no need to take the RCU read lock as the recursive
2847 * parent pointer references will keep the dentry chain alive as long as no
2848 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002849 */
Al Viro02125a82011-12-05 08:43:34 -05002850static int prepend_path(const struct path *path,
2851 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002852 char **buffer, int *buflen)
2853{
Al Viroede4ceb2013-11-13 07:45:40 -05002854 struct dentry *dentry;
2855 struct vfsmount *vfsmnt;
2856 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002857 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04002858 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04002859 char *bptr;
2860 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002861
Al Viro48f5ec22013-09-09 15:22:25 -04002862 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04002863restart_mnt:
2864 read_seqbegin_or_lock(&mount_lock, &m_seq);
2865 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002866 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002867restart:
2868 bptr = *buffer;
2869 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04002870 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05002871 dentry = path->dentry;
2872 vfsmnt = path->mnt;
2873 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04002874 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002875 while (dentry != root->dentry || vfsmnt != root->mnt) {
2876 struct dentry * parent;
2877
2878 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04002879 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002880 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04002881 if (mnt != parent) {
2882 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
2883 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04002884 vfsmnt = &mnt->mnt;
2885 continue;
2886 }
2887 /*
2888 * Filesystems needing to implement special "root names"
2889 * should do so with ->d_dname()
2890 */
2891 if (IS_ROOT(dentry) &&
2892 (dentry->d_name.len != 1 ||
2893 dentry->d_name.name[0] != '/')) {
2894 WARN(1, "Root dentry has weird name <%.*s>\n",
2895 (int) dentry->d_name.len,
2896 dentry->d_name.name);
2897 }
2898 if (!error)
2899 error = is_mounted(vfsmnt) ? 1 : 2;
2900 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002901 }
2902 parent = dentry->d_parent;
2903 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002904 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002905 if (error)
2906 break;
2907
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002908 dentry = parent;
2909 }
Al Viro48f5ec22013-09-09 15:22:25 -04002910 if (!(seq & 1))
2911 rcu_read_unlock();
2912 if (need_seqretry(&rename_lock, seq)) {
2913 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04002914 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002915 }
Al Viro48f5ec22013-09-09 15:22:25 -04002916 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002917
2918 if (!(m_seq & 1))
2919 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04002920 if (need_seqretry(&mount_lock, m_seq)) {
2921 m_seq = 1;
2922 goto restart_mnt;
2923 }
2924 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002925
Waiman Long232d2d62013-09-09 12:18:13 -04002926 if (error >= 0 && bptr == *buffer) {
2927 if (--blen < 0)
2928 error = -ENAMETOOLONG;
2929 else
2930 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002931 }
Waiman Long232d2d62013-09-09 12:18:13 -04002932 *buffer = bptr;
2933 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04002934 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002935}
2936
2937/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002938 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002939 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002940 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07002941 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07002942 * @buflen: buffer length
2943 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002944 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002945 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002946 * Returns a pointer into the buffer or an error code if the
2947 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08002948 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04002949 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002950 *
Al Viro02125a82011-12-05 08:43:34 -05002951 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002952 */
Al Viro02125a82011-12-05 08:43:34 -05002953char *__d_path(const struct path *path,
2954 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002955 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002956{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002957 char *res = buf + buflen;
2958 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002959
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002960 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002961 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002962
Al Viro02125a82011-12-05 08:43:34 -05002963 if (error < 0)
2964 return ERR_PTR(error);
2965 if (error > 0)
2966 return NULL;
2967 return res;
2968}
2969
2970char *d_absolute_path(const struct path *path,
2971 char *buf, int buflen)
2972{
2973 struct path root = {};
2974 char *res = buf + buflen;
2975 int error;
2976
2977 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05002978 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05002979
2980 if (error > 1)
2981 error = -EINVAL;
2982 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002983 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002984 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002985}
2986
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002987/*
2988 * same as __d_path but appends "(deleted)" for unlinked files.
2989 */
Al Viro02125a82011-12-05 08:43:34 -05002990static int path_with_deleted(const struct path *path,
2991 const struct path *root,
2992 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002993{
2994 prepend(buf, buflen, "\0", 1);
2995 if (d_unlinked(path->dentry)) {
2996 int error = prepend(buf, buflen, " (deleted)", 10);
2997 if (error)
2998 return error;
2999 }
3000
3001 return prepend_path(path, root, buf, buflen);
3002}
3003
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003004static int prepend_unreachable(char **buffer, int *buflen)
3005{
3006 return prepend(buffer, buflen, "(unreachable)", 13);
3007}
3008
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003009static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3010{
3011 unsigned seq;
3012
3013 do {
3014 seq = read_seqcount_begin(&fs->seq);
3015 *root = fs->root;
3016 } while (read_seqcount_retry(&fs->seq, seq));
3017}
3018
Jan Bluncka03a8a702008-02-14 19:38:32 -08003019/**
3020 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003021 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003022 * @buf: buffer to return value in
3023 * @buflen: buffer length
3024 *
3025 * Convert a dentry into an ASCII path name. If the entry has been deleted
3026 * the string " (deleted)" is appended. Note that this is ambiguous.
3027 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003028 * Returns a pointer into the buffer or an error code if the path was
3029 * too long. Note: Callers should use the returned pointer, not the passed
3030 * in buffer, to use the name! The implementation often starts at an offset
3031 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003032 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003033 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003034 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003035char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003036{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003037 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003038 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003039 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003040
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003041 /*
3042 * We have various synthetic filesystems that never get mounted. On
3043 * these filesystems dentries are never used for lookup purposes, and
3044 * thus don't need to be hashed. They also don't need a name until a
3045 * user wants to identify the object in /proc/pid/fd/. The little hack
3046 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003047 *
3048 * Some pseudo inodes are mountable. When they are mounted
3049 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3050 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003051 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003052 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3053 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003054 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003055
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003056 rcu_read_lock();
3057 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003058 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003059 rcu_read_unlock();
3060
Al Viro02125a82011-12-05 08:43:34 -05003061 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003062 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003063 return res;
3064}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003065EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003066
3067/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003068 * Helper function for dentry_operations.d_dname() members
3069 */
3070char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3071 const char *fmt, ...)
3072{
3073 va_list args;
3074 char temp[64];
3075 int sz;
3076
3077 va_start(args, fmt);
3078 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3079 va_end(args);
3080
3081 if (sz > sizeof(temp) || sz > buflen)
3082 return ERR_PTR(-ENAMETOOLONG);
3083
3084 buffer += buflen - sz;
3085 return memcpy(buffer, temp, sz);
3086}
3087
Al Viro118b2302013-08-24 12:08:17 -04003088char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3089{
3090 char *end = buffer + buflen;
3091 /* these dentries are never renamed, so d_lock is not needed */
3092 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003093 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003094 prepend(&end, &buflen, "/", 1))
3095 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003096 return end;
Al Viro118b2302013-08-24 12:08:17 -04003097}
David Herrmann31bbe162014-01-03 14:09:47 +01003098EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003099
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003100/*
Ram Pai6092d042008-03-27 13:06:20 +01003101 * Write full pathname from the root of the filesystem into the buffer.
3102 */
Al Virof6500802014-01-26 12:37:55 -05003103static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003104{
Al Virof6500802014-01-26 12:37:55 -05003105 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003106 char *end, *retval;
3107 int len, seq = 0;
3108 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003109
Al Virof6500802014-01-26 12:37:55 -05003110 if (buflen < 2)
3111 goto Elong;
3112
Al Viro48f5ec22013-09-09 15:22:25 -04003113 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003114restart:
Al Virof6500802014-01-26 12:37:55 -05003115 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003116 end = buf + buflen;
3117 len = buflen;
3118 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003119 /* Get '/' right */
3120 retval = end-1;
3121 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003122 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003123 while (!IS_ROOT(dentry)) {
3124 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003125
Ram Pai6092d042008-03-27 13:06:20 +01003126 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003127 error = prepend_name(&end, &len, &dentry->d_name);
3128 if (error)
3129 break;
Ram Pai6092d042008-03-27 13:06:20 +01003130
3131 retval = end;
3132 dentry = parent;
3133 }
Al Viro48f5ec22013-09-09 15:22:25 -04003134 if (!(seq & 1))
3135 rcu_read_unlock();
3136 if (need_seqretry(&rename_lock, seq)) {
3137 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003138 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003139 }
3140 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003141 if (error)
3142 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003143 return retval;
3144Elong:
3145 return ERR_PTR(-ENAMETOOLONG);
3146}
Nick Pigginec2447c2011-01-07 17:49:29 +11003147
3148char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3149{
Waiman Long232d2d62013-09-09 12:18:13 -04003150 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003151}
3152EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003153
3154char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3155{
3156 char *p = NULL;
3157 char *retval;
3158
Al Viroc1031352010-06-06 22:31:14 -04003159 if (d_unlinked(dentry)) {
3160 p = buf + buflen;
3161 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3162 goto Elong;
3163 buflen++;
3164 }
3165 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003166 if (!IS_ERR(retval) && p)
3167 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003168 return retval;
3169Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003170 return ERR_PTR(-ENAMETOOLONG);
3171}
3172
Linus Torvalds8b19e342013-09-12 10:35:47 -07003173static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3174 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003175{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003176 unsigned seq;
3177
3178 do {
3179 seq = read_seqcount_begin(&fs->seq);
3180 *root = fs->root;
3181 *pwd = fs->pwd;
3182 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003183}
3184
Ram Pai6092d042008-03-27 13:06:20 +01003185/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003186 * NOTE! The user-level library version returns a
3187 * character pointer. The kernel system call just
3188 * returns the length of the buffer filled (which
3189 * includes the ending '\0' character), or a negative
3190 * error value. So libc would do something like
3191 *
3192 * char *getcwd(char * buf, size_t size)
3193 * {
3194 * int retval;
3195 *
3196 * retval = sys_getcwd(buf, size);
3197 * if (retval >= 0)
3198 * return buf;
3199 * errno = -retval;
3200 * return NULL;
3201 * }
3202 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003203SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003204{
Linus Torvalds552ce542007-02-13 12:08:18 -08003205 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003206 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003207 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003208
3209 if (!page)
3210 return -ENOMEM;
3211
Linus Torvalds8b19e342013-09-12 10:35:47 -07003212 rcu_read_lock();
3213 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003214
Linus Torvalds552ce542007-02-13 12:08:18 -08003215 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003216 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003217 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003218 char *cwd = page + PATH_MAX;
3219 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003220
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003221 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003222 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003223 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003224
Al Viro02125a82011-12-05 08:43:34 -05003225 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003226 goto out;
3227
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003228 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003229 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003230 error = prepend_unreachable(&cwd, &buflen);
3231 if (error)
3232 goto out;
3233 }
3234
Linus Torvalds552ce542007-02-13 12:08:18 -08003235 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003236 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003237 if (len <= size) {
3238 error = len;
3239 if (copy_to_user(buf, cwd, len))
3240 error = -EFAULT;
3241 }
Nick Piggin949854d2011-01-07 17:49:37 +11003242 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003243 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003244 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003245
3246out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003247 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003248 return error;
3249}
3250
3251/*
3252 * Test whether new_dentry is a subdirectory of old_dentry.
3253 *
3254 * Trivially implemented using the dcache structure
3255 */
3256
3257/**
3258 * is_subdir - is new dentry a subdirectory of old_dentry
3259 * @new_dentry: new dentry
3260 * @old_dentry: old dentry
3261 *
3262 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
3263 * Returns 0 otherwise.
3264 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3265 */
3266
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003267int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003268{
3269 int result;
Nick Piggin949854d2011-01-07 17:49:37 +11003270 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003271
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003272 if (new_dentry == old_dentry)
3273 return 1;
3274
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003275 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003276 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003277 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003278 /*
3279 * Need rcu_readlock to protect against the d_parent trashing
3280 * due to d_move
3281 */
3282 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003283 if (d_ancestor(old_dentry, new_dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003284 result = 1;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003285 else
3286 result = 0;
Nick Piggin949854d2011-01-07 17:49:37 +11003287 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003288 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003289
3290 return result;
3291}
3292
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003293static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003294{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003295 struct dentry *root = data;
3296 if (dentry != root) {
3297 if (d_unhashed(dentry) || !dentry->d_inode)
3298 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003299
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003300 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3301 dentry->d_flags |= DCACHE_GENOCIDE;
3302 dentry->d_lockref.count--;
3303 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003304 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003305 return D_WALK_CONTINUE;
3306}
Nick Piggin58db63d2011-01-07 17:49:39 +11003307
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003308void d_genocide(struct dentry *parent)
3309{
3310 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003311}
3312
Al Viro60545d02013-06-07 01:20:27 -04003313void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003314{
Al Viro60545d02013-06-07 01:20:27 -04003315 inode_dec_link_count(inode);
3316 BUG_ON(dentry->d_name.name != dentry->d_iname ||
3317 !hlist_unhashed(&dentry->d_alias) ||
3318 !d_unlinked(dentry));
3319 spin_lock(&dentry->d_parent->d_lock);
3320 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3321 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3322 (unsigned long long)inode->i_ino);
3323 spin_unlock(&dentry->d_lock);
3324 spin_unlock(&dentry->d_parent->d_lock);
3325 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003326}
Al Viro60545d02013-06-07 01:20:27 -04003327EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003328
3329static __initdata unsigned long dhash_entries;
3330static int __init set_dhash_entries(char *str)
3331{
3332 if (!str)
3333 return 0;
3334 dhash_entries = simple_strtoul(str, &str, 0);
3335 return 1;
3336}
3337__setup("dhash_entries=", set_dhash_entries);
3338
3339static void __init dcache_init_early(void)
3340{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003341 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003342
3343 /* If hashes are distributed across NUMA nodes, defer
3344 * hash allocation until vmalloc space is available.
3345 */
3346 if (hashdist)
3347 return;
3348
3349 dentry_hashtable =
3350 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003351 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003352 dhash_entries,
3353 13,
3354 HASH_EARLY,
3355 &d_hash_shift,
3356 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003357 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003358 0);
3359
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003360 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003361 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003362}
3363
Denis Cheng74bf17c2007-10-16 23:26:30 -07003364static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003365{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003366 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003367
3368 /*
3369 * A constructor could be added for stable state like the lists,
3370 * but it is probably not worth it because of the cache nature
3371 * of the dcache.
3372 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003373 dentry_cache = KMEM_CACHE(dentry,
3374 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003375
3376 /* Hash may have been set up in dcache_init_early */
3377 if (!hashdist)
3378 return;
3379
3380 dentry_hashtable =
3381 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003382 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003383 dhash_entries,
3384 13,
3385 0,
3386 &d_hash_shift,
3387 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003388 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003389 0);
3390
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003391 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003392 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003393}
3394
3395/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003396struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003397EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003398
Linus Torvalds1da177e2005-04-16 15:20:36 -07003399EXPORT_SYMBOL(d_genocide);
3400
Linus Torvalds1da177e2005-04-16 15:20:36 -07003401void __init vfs_caches_init_early(void)
3402{
3403 dcache_init_early();
3404 inode_init_early();
3405}
3406
3407void __init vfs_caches_init(unsigned long mempages)
3408{
3409 unsigned long reserve;
3410
3411 /* Base hash sizes on available memory, with a reserve equal to
3412 150% of current kernel size */
3413
3414 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
3415 mempages -= reserve;
3416
3417 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003418 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003419
Denis Cheng74bf17c2007-10-16 23:26:30 -07003420 dcache_init();
3421 inode_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003422 files_init(mempages);
Denis Cheng74bf17c2007-10-16 23:26:30 -07003423 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003424 bdev_cache_init();
3425 chrdev_init();
3426}