blob: 2321e1a861f6e62e659e2be3caecd9842d9b09b9 [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
Miklos Szeredid52b9082007-05-08 00:23:46 -0700398/**
Nick Piggin789680d2011-01-07 17:49:30 +1100399 * d_drop - drop a dentry
400 * @dentry: dentry to drop
401 *
402 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
403 * be found through a VFS lookup any more. Note that this is different from
404 * deleting the dentry - d_delete will try to mark the dentry negative if
405 * possible, giving a successful _negative_ lookup, while d_drop will
406 * just make the cache lookup fail.
407 *
408 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
409 * reason (NFS timeouts or autofs deletes).
410 *
411 * __d_drop requires dentry->d_lock.
412 */
413void __d_drop(struct dentry *dentry)
414{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700415 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400416 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400417 /*
418 * Hashed dentries are normally on the dentry hashtable,
419 * with the exception of those newly allocated by
420 * d_obtain_alias, which are always IS_ROOT:
421 */
422 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400423 b = &dentry->d_sb->s_anon;
424 else
425 b = d_hash(dentry->d_parent, dentry->d_name.hash);
426
427 hlist_bl_lock(b);
428 __hlist_bl_del(&dentry->d_hash);
429 dentry->d_hash.pprev = NULL;
430 hlist_bl_unlock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -0700431 dentry_rcuwalk_barrier(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +1100432 }
433}
434EXPORT_SYMBOL(__d_drop);
435
436void d_drop(struct dentry *dentry)
437{
Nick Piggin789680d2011-01-07 17:49:30 +1100438 spin_lock(&dentry->d_lock);
439 __d_drop(dentry);
440 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100441}
442EXPORT_SYMBOL(d_drop);
443
Nick Piggin77812a12011-01-07 17:49:48 +1100444/*
445 * Finish off a dentry we've decided to kill.
446 * dentry->d_lock must be held, returns with it unlocked.
447 * If ref is non-zero, then decrement the refcount too.
448 * Returns dentry requiring refcount drop, or NULL if we're done.
449 */
Linus Torvalds358eec12013-10-31 15:43:02 -0700450static struct dentry *
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000451dentry_kill(struct dentry *dentry, int unlock_on_failure)
Nick Piggin77812a12011-01-07 17:49:48 +1100452 __releases(dentry->d_lock)
453{
Nick Piggin873feea2011-01-07 17:50:06 +1100454 struct inode *inode;
Al Viro41edf272014-05-01 10:30:00 -0400455 struct dentry *parent = NULL;
456 bool can_free = true;
457
458 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
459 can_free = dentry->d_flags & DCACHE_MAY_FREE;
460 spin_unlock(&dentry->d_lock);
461 goto out;
462 }
Nick Piggin77812a12011-01-07 17:49:48 +1100463
Nick Piggin873feea2011-01-07 17:50:06 +1100464 inode = dentry->d_inode;
465 if (inode && !spin_trylock(&inode->i_lock)) {
Nick Piggin77812a12011-01-07 17:49:48 +1100466relock:
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000467 if (unlock_on_failure) {
468 spin_unlock(&dentry->d_lock);
469 cpu_relax();
470 }
Nick Piggin77812a12011-01-07 17:49:48 +1100471 return dentry; /* try again with same dentry */
472 }
Al Viro41edf272014-05-01 10:30:00 -0400473 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100474 parent = dentry->d_parent;
475 if (parent && !spin_trylock(&parent->d_lock)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100476 if (inode)
477 spin_unlock(&inode->i_lock);
Nick Piggin77812a12011-01-07 17:49:48 +1100478 goto relock;
479 }
Nick Piggin31e6b012011-01-07 17:49:52 +1100480
Linus Torvalds0d984392013-09-08 13:46:52 -0700481 /*
482 * The dentry is now unrecoverably dead to the world.
483 */
484 lockref_mark_dead(&dentry->d_lockref);
485
Sage Weilf0023bc2011-10-28 10:02:42 -0700486 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700487 * inform the fs via d_prune that this dentry is about to be
488 * unhashed and destroyed.
489 */
Yan, Zheng590fb512013-08-13 15:42:02 +0800490 if ((dentry->d_flags & DCACHE_OP_PRUNE) && !d_unhashed(dentry))
Yan, Zheng61572bb2013-04-15 14:13:21 +0800491 dentry->d_op->d_prune(dentry);
492
Al Viro01b60352014-04-29 23:42:52 -0400493 if (dentry->d_flags & DCACHE_LRU_LIST) {
494 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
495 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400496 }
Nick Piggin77812a12011-01-07 17:49:48 +1100497 /* if it was on the hash then remove it */
498 __d_drop(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400499 list_del(&dentry->d_u.d_child);
500 /*
501 * Inform d_walk() that we are no longer attached to the
502 * dentry tree
503 */
504 dentry->d_flags |= DCACHE_DENTRY_KILLED;
505 if (parent)
506 spin_unlock(&parent->d_lock);
507 dentry_iput(dentry);
508 /*
509 * dentry_iput drops the locks, at which point nobody (except
510 * transient RCU lookups) can reach this dentry.
511 */
512 BUG_ON((int)dentry->d_lockref.count > 0);
513 this_cpu_dec(nr_dentry);
514 if (dentry->d_op && dentry->d_op->d_release)
515 dentry->d_op->d_release(dentry);
516
Al Viro41edf272014-05-01 10:30:00 -0400517 spin_lock(&dentry->d_lock);
518 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
519 dentry->d_flags |= DCACHE_MAY_FREE;
520 can_free = false;
521 }
522 spin_unlock(&dentry->d_lock);
523out:
524 if (likely(can_free))
525 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 */
Al Viro41edf272014-05-01 10:30:00 -0400827 if ((int)dentry->d_lockref.count > 0) {
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
Al Virofe915222014-05-03 00:02:25 -04001216 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001217 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001218 } else {
1219 if (dentry->d_flags & DCACHE_LRU_LIST)
1220 d_lru_del(dentry);
1221 if (!dentry->d_lockref.count) {
1222 d_shrink_add(dentry, &data->dispose);
1223 data->found++;
1224 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 }
1226 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001227 * We can return to the caller if we have found some (this
1228 * ensures forward progress). We'll be coming back to find
1229 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 */
Al Virofe915222014-05-03 00:02:25 -04001231 if (!list_empty(&data->dispose))
1232 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001234 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235}
1236
1237/**
1238 * shrink_dcache_parent - prune dcache
1239 * @parent: parent of entries to prune
1240 *
1241 * Prune the dcache to remove unused children of the parent dentry.
1242 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001243void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001245 for (;;) {
1246 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001248 INIT_LIST_HEAD(&data.dispose);
1249 data.start = parent;
1250 data.found = 0;
1251
1252 d_walk(parent, &data, select_collect, NULL);
1253 if (!data.found)
1254 break;
1255
1256 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001257 cond_resched();
1258 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001260EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261
Al Viro9c8c10e2014-05-02 20:36:10 -04001262static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001263{
Al Viro9c8c10e2014-05-02 20:36:10 -04001264 /* it has busy descendents; complain about those instead */
1265 if (!list_empty(&dentry->d_subdirs))
1266 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001267
Al Viro9c8c10e2014-05-02 20:36:10 -04001268 /* root with refcount 1 is fine */
1269 if (dentry == _data && dentry->d_lockref.count == 1)
1270 return D_WALK_CONTINUE;
1271
1272 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1273 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001274 dentry,
1275 dentry->d_inode ?
1276 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001277 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001278 dentry->d_lockref.count,
1279 dentry->d_sb->s_type->name,
1280 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001281 WARN_ON(1);
1282 return D_WALK_CONTINUE;
1283}
1284
1285static void do_one_tree(struct dentry *dentry)
1286{
1287 shrink_dcache_parent(dentry);
1288 d_walk(dentry, dentry, umount_check, NULL);
1289 d_drop(dentry);
1290 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001291}
1292
1293/*
1294 * destroy the dentries attached to a superblock on unmounting
1295 */
1296void shrink_dcache_for_umount(struct super_block *sb)
1297{
1298 struct dentry *dentry;
1299
Al Viro9c8c10e2014-05-02 20:36:10 -04001300 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001301
1302 dentry = sb->s_root;
1303 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001304 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001305
1306 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001307 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1308 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001309 }
1310}
1311
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001312static enum d_walk_ret check_and_collect(void *_data, struct dentry *dentry)
1313{
1314 struct select_data *data = _data;
1315
1316 if (d_mountpoint(dentry)) {
1317 data->found = -EBUSY;
1318 return D_WALK_QUIT;
1319 }
1320
1321 return select_collect(_data, dentry);
1322}
1323
1324static void check_and_drop(void *_data)
1325{
1326 struct select_data *data = _data;
1327
1328 if (d_mountpoint(data->start))
1329 data->found = -EBUSY;
1330 if (!data->found)
1331 __d_drop(data->start);
1332}
1333
1334/**
1335 * check_submounts_and_drop - prune dcache, check for submounts and drop
1336 *
1337 * All done as a single atomic operation relative to has_unlinked_ancestor().
1338 * Returns 0 if successfully unhashed @parent. If there were submounts then
1339 * return -EBUSY.
1340 *
1341 * @dentry: dentry to prune and drop
1342 */
1343int check_submounts_and_drop(struct dentry *dentry)
1344{
1345 int ret = 0;
1346
1347 /* Negative dentries can be dropped without further checks */
1348 if (!dentry->d_inode) {
1349 d_drop(dentry);
1350 goto out;
1351 }
1352
1353 for (;;) {
1354 struct select_data data;
1355
1356 INIT_LIST_HEAD(&data.dispose);
1357 data.start = dentry;
1358 data.found = 0;
1359
1360 d_walk(dentry, &data, check_and_collect, check_and_drop);
1361 ret = data.found;
1362
1363 if (!list_empty(&data.dispose))
1364 shrink_dentry_list(&data.dispose);
1365
1366 if (ret <= 0)
1367 break;
1368
1369 cond_resched();
1370 }
1371
1372out:
1373 return ret;
1374}
1375EXPORT_SYMBOL(check_submounts_and_drop);
1376
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377/**
Al Viroa4464db2011-07-07 15:03:58 -04001378 * __d_alloc - allocate a dcache entry
1379 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 * @name: qstr of the name
1381 *
1382 * Allocates a dentry. It returns %NULL if there is insufficient memory
1383 * available. On a success the dentry is returned. The name passed in is
1384 * copied and the copy passed in may be reused after this call.
1385 */
1386
Al Viroa4464db2011-07-07 15:03:58 -04001387struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388{
1389 struct dentry *dentry;
1390 char *dname;
1391
Mel Gormane12ba742007-10-16 01:25:52 -07001392 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 if (!dentry)
1394 return NULL;
1395
Linus Torvalds6326c712012-05-21 16:14:04 -07001396 /*
1397 * We guarantee that the inline name is always NUL-terminated.
1398 * This way the memcpy() done by the name switching in rename
1399 * will still always have a NUL at the end, even if we might
1400 * be overwriting an internal NUL character
1401 */
1402 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 if (name->len > DNAME_INLINE_LEN-1) {
1404 dname = kmalloc(name->len + 1, GFP_KERNEL);
1405 if (!dname) {
1406 kmem_cache_free(dentry_cache, dentry);
1407 return NULL;
1408 }
1409 } else {
1410 dname = dentry->d_iname;
1411 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412
1413 dentry->d_name.len = name->len;
1414 dentry->d_name.hash = name->hash;
1415 memcpy(dname, name->name, name->len);
1416 dname[name->len] = 0;
1417
Linus Torvalds6326c712012-05-21 16:14:04 -07001418 /* Make sure we always see the terminating NUL character */
1419 smp_wmb();
1420 dentry->d_name.name = dname;
1421
Waiman Long98474232013-08-28 18:24:59 -07001422 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001423 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001425 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001427 dentry->d_parent = dentry;
1428 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 dentry->d_op = NULL;
1430 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001431 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 INIT_LIST_HEAD(&dentry->d_lru);
1433 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Virob3d9b7a2012-06-09 13:51:19 -04001434 INIT_HLIST_NODE(&dentry->d_alias);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001435 INIT_LIST_HEAD(&dentry->d_u.d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001436 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437
Nick Piggin3e880fb2011-01-07 17:49:19 +11001438 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001439
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 return dentry;
1441}
Al Viroa4464db2011-07-07 15:03:58 -04001442
1443/**
1444 * d_alloc - allocate a dcache entry
1445 * @parent: parent of entry to allocate
1446 * @name: qstr of the name
1447 *
1448 * Allocates a dentry. It returns %NULL if there is insufficient memory
1449 * available. On a success the dentry is returned. The name passed in is
1450 * copied and the copy passed in may be reused after this call.
1451 */
1452struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1453{
1454 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1455 if (!dentry)
1456 return NULL;
1457
1458 spin_lock(&parent->d_lock);
1459 /*
1460 * don't need child lock because it is not subject
1461 * to concurrency here
1462 */
1463 __dget_dlock(parent);
1464 dentry->d_parent = parent;
1465 list_add(&dentry->d_u.d_child, &parent->d_subdirs);
1466 spin_unlock(&parent->d_lock);
1467
1468 return dentry;
1469}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001470EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001472/**
1473 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1474 * @sb: the superblock
1475 * @name: qstr of the name
1476 *
1477 * For a filesystem that just pins its dentries in memory and never
1478 * performs lookups at all, return an unhashed IS_ROOT dentry.
1479 */
Nick Piggin4b936882011-01-07 17:50:07 +11001480struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1481{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001482 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001483}
1484EXPORT_SYMBOL(d_alloc_pseudo);
1485
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1487{
1488 struct qstr q;
1489
1490 q.name = name;
1491 q.len = strlen(name);
1492 q.hash = full_name_hash(q.name, q.len);
1493 return d_alloc(parent, &q);
1494}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001495EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496
Nick Pigginfb045ad2011-01-07 17:49:55 +11001497void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1498{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001499 WARN_ON_ONCE(dentry->d_op);
1500 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001501 DCACHE_OP_COMPARE |
1502 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001503 DCACHE_OP_WEAK_REVALIDATE |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001504 DCACHE_OP_DELETE ));
1505 dentry->d_op = op;
1506 if (!op)
1507 return;
1508 if (op->d_hash)
1509 dentry->d_flags |= DCACHE_OP_HASH;
1510 if (op->d_compare)
1511 dentry->d_flags |= DCACHE_OP_COMPARE;
1512 if (op->d_revalidate)
1513 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001514 if (op->d_weak_revalidate)
1515 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001516 if (op->d_delete)
1517 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001518 if (op->d_prune)
1519 dentry->d_flags |= DCACHE_OP_PRUNE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001520
1521}
1522EXPORT_SYMBOL(d_set_d_op);
1523
David Howellsb18825a2013-09-12 19:22:53 +01001524static unsigned d_flags_for_inode(struct inode *inode)
1525{
1526 unsigned add_flags = DCACHE_FILE_TYPE;
1527
1528 if (!inode)
1529 return DCACHE_MISS_TYPE;
1530
1531 if (S_ISDIR(inode->i_mode)) {
1532 add_flags = DCACHE_DIRECTORY_TYPE;
1533 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1534 if (unlikely(!inode->i_op->lookup))
1535 add_flags = DCACHE_AUTODIR_TYPE;
1536 else
1537 inode->i_opflags |= IOP_LOOKUP;
1538 }
1539 } else if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
1540 if (unlikely(inode->i_op->follow_link))
1541 add_flags = DCACHE_SYMLINK_TYPE;
1542 else
1543 inode->i_opflags |= IOP_NOFOLLOW;
1544 }
1545
1546 if (unlikely(IS_AUTOMOUNT(inode)))
1547 add_flags |= DCACHE_NEED_AUTOMOUNT;
1548 return add_flags;
1549}
1550
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001551static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1552{
David Howellsb18825a2013-09-12 19:22:53 +01001553 unsigned add_flags = d_flags_for_inode(inode);
1554
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001555 spin_lock(&dentry->d_lock);
Al Viro22213312014-04-19 12:30:58 -04001556 __d_set_type(dentry, add_flags);
David Howellsb18825a2013-09-12 19:22:53 +01001557 if (inode)
Al Virob3d9b7a2012-06-09 13:51:19 -04001558 hlist_add_head(&dentry->d_alias, &inode->i_dentry);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001559 dentry->d_inode = inode;
Nick Piggin31e6b012011-01-07 17:49:52 +11001560 dentry_rcuwalk_barrier(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001561 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001562 fsnotify_d_instantiate(dentry, inode);
1563}
1564
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565/**
1566 * d_instantiate - fill in inode information for a dentry
1567 * @entry: dentry to complete
1568 * @inode: inode to attach to this dentry
1569 *
1570 * Fill in inode information in the entry.
1571 *
1572 * This turns negative dentries into productive full members
1573 * of society.
1574 *
1575 * NOTE! This assumes that the inode count has been incremented
1576 * (or otherwise set) by the caller to indicate that it is now
1577 * in use by the dcache.
1578 */
1579
1580void d_instantiate(struct dentry *entry, struct inode * inode)
1581{
Al Virob3d9b7a2012-06-09 13:51:19 -04001582 BUG_ON(!hlist_unhashed(&entry->d_alias));
Nick Piggin873feea2011-01-07 17:50:06 +11001583 if (inode)
1584 spin_lock(&inode->i_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001585 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001586 if (inode)
1587 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 security_d_instantiate(entry, inode);
1589}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001590EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591
1592/**
1593 * d_instantiate_unique - instantiate a non-aliased dentry
1594 * @entry: dentry to instantiate
1595 * @inode: inode to attach to this dentry
1596 *
1597 * Fill in inode information in the entry. On success, it returns NULL.
1598 * If an unhashed alias of "entry" already exists, then we return the
Oleg Drokine866cfa2006-01-09 20:52:51 -08001599 * aliased dentry instead and drop one reference to inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600 *
1601 * Note that in order to avoid conflicts with rename() etc, the caller
1602 * had better be holding the parent directory semaphore.
Oleg Drokine866cfa2006-01-09 20:52:51 -08001603 *
1604 * This also assumes that the inode count has been incremented
1605 * (or otherwise set) by the caller to indicate that it is now
1606 * in use by the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 */
David Howells770bfad2006-08-22 20:06:07 -04001608static struct dentry *__d_instantiate_unique(struct dentry *entry,
1609 struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610{
1611 struct dentry *alias;
1612 int len = entry->d_name.len;
1613 const char *name = entry->d_name.name;
1614 unsigned int hash = entry->d_name.hash;
1615
David Howells770bfad2006-08-22 20:06:07 -04001616 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001617 __d_instantiate(entry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001618 return NULL;
1619 }
1620
Sasha Levinb67bfe02013-02-27 17:06:00 -08001621 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Piggin9abca362011-01-07 17:49:36 +11001622 /*
1623 * Don't need alias->d_lock here, because aliases with
1624 * d_parent == entry->d_parent are not subject to name or
1625 * parent changes, because the parent inode i_mutex is held.
1626 */
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001627 if (alias->d_name.hash != hash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 continue;
1629 if (alias->d_parent != entry->d_parent)
1630 continue;
Linus Torvaldsee983e82012-05-10 12:37:10 -07001631 if (alias->d_name.len != len)
1632 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001633 if (dentry_cmp(alias, name, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 continue;
Nick Piggindc0474b2011-01-07 17:49:43 +11001635 __dget(alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 return alias;
1637 }
David Howells770bfad2006-08-22 20:06:07 -04001638
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001639 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 return NULL;
1641}
David Howells770bfad2006-08-22 20:06:07 -04001642
1643struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1644{
1645 struct dentry *result;
1646
Al Virob3d9b7a2012-06-09 13:51:19 -04001647 BUG_ON(!hlist_unhashed(&entry->d_alias));
David Howells770bfad2006-08-22 20:06:07 -04001648
Nick Piggin873feea2011-01-07 17:50:06 +11001649 if (inode)
1650 spin_lock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001651 result = __d_instantiate_unique(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001652 if (inode)
1653 spin_unlock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001654
1655 if (!result) {
1656 security_d_instantiate(entry, inode);
1657 return NULL;
1658 }
1659
1660 BUG_ON(!d_unhashed(result));
1661 iput(inode);
1662 return result;
1663}
1664
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665EXPORT_SYMBOL(d_instantiate_unique);
1666
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001667/**
1668 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1669 * @entry: dentry to complete
1670 * @inode: inode to attach to this dentry
1671 *
1672 * Fill in inode information in the entry. If a directory alias is found, then
1673 * return an error (and drop inode). Together with d_materialise_unique() this
1674 * guarantees that a directory inode may never have more than one alias.
1675 */
1676int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1677{
1678 BUG_ON(!hlist_unhashed(&entry->d_alias));
1679
1680 spin_lock(&inode->i_lock);
1681 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1682 spin_unlock(&inode->i_lock);
1683 iput(inode);
1684 return -EBUSY;
1685 }
1686 __d_instantiate(entry, inode);
1687 spin_unlock(&inode->i_lock);
1688 security_d_instantiate(entry, inode);
1689
1690 return 0;
1691}
1692EXPORT_SYMBOL(d_instantiate_no_diralias);
1693
Al Viroadc0e912012-01-08 16:49:21 -05001694struct dentry *d_make_root(struct inode *root_inode)
1695{
1696 struct dentry *res = NULL;
1697
1698 if (root_inode) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07001699 static const struct qstr name = QSTR_INIT("/", 1);
Al Viroadc0e912012-01-08 16:49:21 -05001700
1701 res = __d_alloc(root_inode->i_sb, &name);
1702 if (res)
1703 d_instantiate(res, root_inode);
1704 else
1705 iput(root_inode);
1706 }
1707 return res;
1708}
1709EXPORT_SYMBOL(d_make_root);
1710
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001711static struct dentry * __d_find_any_alias(struct inode *inode)
1712{
1713 struct dentry *alias;
1714
Al Virob3d9b7a2012-06-09 13:51:19 -04001715 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001716 return NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001717 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001718 __dget(alias);
1719 return alias;
1720}
1721
Sage Weil46f72b32012-01-10 09:04:37 -08001722/**
1723 * d_find_any_alias - find any alias for a given inode
1724 * @inode: inode to find an alias for
1725 *
1726 * If any aliases exist for the given inode, take and return a
1727 * reference for one of them. If no aliases exist, return %NULL.
1728 */
1729struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001730{
1731 struct dentry *de;
1732
1733 spin_lock(&inode->i_lock);
1734 de = __d_find_any_alias(inode);
1735 spin_unlock(&inode->i_lock);
1736 return de;
1737}
Sage Weil46f72b32012-01-10 09:04:37 -08001738EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001739
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740/**
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001741 * d_obtain_alias - find or allocate a dentry for a given inode
1742 * @inode: inode to allocate the dentry for
1743 *
1744 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1745 * similar open by handle operations. The returned dentry may be anonymous,
1746 * or may have a full name (if the inode was already in the cache).
1747 *
1748 * When called on a directory inode, we must ensure that the inode only ever
1749 * has one dentry. If a dentry is found, that is returned instead of
1750 * allocating a new one.
1751 *
1752 * On successful return, the reference to the inode has been transferred
Christoph Hellwig44003722008-08-11 15:49:04 +02001753 * to the dentry. In case of an error the reference on the inode is released.
1754 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1755 * be passed in and will be the error will be propagate to the return value,
1756 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001757 */
1758struct dentry *d_obtain_alias(struct inode *inode)
1759{
NeilBrownb911a6b2012-11-08 16:09:37 -08001760 static const struct qstr anonstring = QSTR_INIT("/", 1);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001761 struct dentry *tmp;
1762 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001763 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001764
1765 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001766 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001767 if (IS_ERR(inode))
1768 return ERR_CAST(inode);
1769
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001770 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001771 if (res)
1772 goto out_iput;
1773
Al Viroa4464db2011-07-07 15:03:58 -04001774 tmp = __d_alloc(inode->i_sb, &anonstring);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001775 if (!tmp) {
1776 res = ERR_PTR(-ENOMEM);
1777 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001778 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001779
Nick Piggin873feea2011-01-07 17:50:06 +11001780 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001781 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001782 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001783 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001784 dput(tmp);
1785 goto out_iput;
1786 }
1787
1788 /* attach a disconnected dentry */
David Howellsb18825a2013-09-12 19:22:53 +01001789 add_flags = d_flags_for_inode(inode) | DCACHE_DISCONNECTED;
1790
Christoph Hellwig9308a612008-08-11 15:49:12 +02001791 spin_lock(&tmp->d_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001792 tmp->d_inode = inode;
David Howellsb18825a2013-09-12 19:22:53 +01001793 tmp->d_flags |= add_flags;
Al Virob3d9b7a2012-06-09 13:51:19 -04001794 hlist_add_head(&tmp->d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001795 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001796 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001797 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001798 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001799 spin_unlock(&inode->i_lock);
Josef Bacik24ff6662010-11-18 20:52:55 -05001800 security_d_instantiate(tmp, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001801
Christoph Hellwig9308a612008-08-11 15:49:12 +02001802 return tmp;
1803
1804 out_iput:
Josef Bacik24ff6662010-11-18 20:52:55 -05001805 if (res && !IS_ERR(res))
1806 security_d_instantiate(res, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001807 iput(inode);
1808 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001809}
Benny Halevyadc48722009-02-27 14:02:59 -08001810EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811
1812/**
1813 * d_splice_alias - splice a disconnected dentry into the tree if one exists
1814 * @inode: the inode which may have a disconnected dentry
1815 * @dentry: a negative dentry which we want to point to the inode.
1816 *
1817 * If inode is a directory and has a 'disconnected' dentry (i.e. IS_ROOT and
1818 * DCACHE_DISCONNECTED), then d_move that in place of the given dentry
1819 * and return it, else simply d_add the inode to the dentry and return NULL.
1820 *
1821 * This is needed in the lookup routine of any filesystem that is exportable
1822 * (via knfsd) so that we can build dcache paths to directories effectively.
1823 *
1824 * If a dentry was found and moved, then it is returned. Otherwise NULL
1825 * is returned. This matches the expected return value of ->lookup.
1826 *
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001827 * Cluster filesystems may call this function with a negative, hashed dentry.
1828 * In that case, we know that the inode will be a regular file, and also this
1829 * will only occur during atomic_open. So we need to check for the dentry
1830 * being already hashed only in the final case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 */
1832struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
1833{
1834 struct dentry *new = NULL;
1835
Al Viroa9049372011-07-08 21:20:11 -04001836 if (IS_ERR(inode))
1837 return ERR_CAST(inode);
1838
NeilBrown21c0d8f2006-10-04 02:16:16 -07001839 if (inode && S_ISDIR(inode->i_mode)) {
Nick Piggin873feea2011-01-07 17:50:06 +11001840 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001841 new = __d_find_alias(inode, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842 if (new) {
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001843 BUG_ON(!(new->d_flags & DCACHE_DISCONNECTED));
Nick Piggin873feea2011-01-07 17:50:06 +11001844 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845 security_d_instantiate(new, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846 d_move(new, dentry);
1847 iput(inode);
1848 } else {
Nick Piggin873feea2011-01-07 17:50:06 +11001849 /* already taking inode->i_lock, so d_add() by hand */
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001850 __d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001851 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852 security_d_instantiate(dentry, inode);
1853 d_rehash(dentry);
1854 }
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001855 } else {
1856 d_instantiate(dentry, inode);
1857 if (d_unhashed(dentry))
1858 d_rehash(dentry);
1859 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860 return new;
1861}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001862EXPORT_SYMBOL(d_splice_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863
Barry Naujok94035402008-05-21 16:50:46 +10001864/**
1865 * d_add_ci - lookup or allocate new dentry with case-exact name
1866 * @inode: the inode case-insensitive lookup has found
1867 * @dentry: the negative dentry that was passed to the parent's lookup func
1868 * @name: the case-exact name to be associated with the returned dentry
1869 *
1870 * This is to avoid filling the dcache with case-insensitive names to the
1871 * same inode, only the actual correct case is stored in the dcache for
1872 * case-insensitive filesystems.
1873 *
1874 * For a case-insensitive lookup match and if the the case-exact dentry
1875 * already exists in in the dcache, use it and return it.
1876 *
1877 * If no entry exists with the exact case name, allocate new dentry with
1878 * the exact case, and return the spliced entry.
1879 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001880struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001881 struct qstr *name)
1882{
Barry Naujok94035402008-05-21 16:50:46 +10001883 struct dentry *found;
1884 struct dentry *new;
1885
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001886 /*
1887 * First check if a dentry matching the name already exists,
1888 * if not go ahead and create it now.
1889 */
Barry Naujok94035402008-05-21 16:50:46 +10001890 found = d_hash_and_lookup(dentry->d_parent, name);
Al Viro4f522a22013-02-11 23:20:37 -05001891 if (unlikely(IS_ERR(found)))
1892 goto err_out;
Barry Naujok94035402008-05-21 16:50:46 +10001893 if (!found) {
1894 new = d_alloc(dentry->d_parent, name);
1895 if (!new) {
Al Viro4f522a22013-02-11 23:20:37 -05001896 found = ERR_PTR(-ENOMEM);
Barry Naujok94035402008-05-21 16:50:46 +10001897 goto err_out;
1898 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001899
Barry Naujok94035402008-05-21 16:50:46 +10001900 found = d_splice_alias(inode, new);
1901 if (found) {
1902 dput(new);
1903 return found;
1904 }
1905 return new;
1906 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001907
1908 /*
1909 * If a matching dentry exists, and it's not negative use it.
1910 *
1911 * Decrement the reference count to balance the iget() done
1912 * earlier on.
1913 */
Barry Naujok94035402008-05-21 16:50:46 +10001914 if (found->d_inode) {
1915 if (unlikely(found->d_inode != inode)) {
1916 /* This can't happen because bad inodes are unhashed. */
1917 BUG_ON(!is_bad_inode(inode));
1918 BUG_ON(!is_bad_inode(found->d_inode));
1919 }
Barry Naujok94035402008-05-21 16:50:46 +10001920 iput(inode);
1921 return found;
1922 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001923
Barry Naujok94035402008-05-21 16:50:46 +10001924 /*
1925 * Negative dentry: instantiate it unless the inode is a directory and
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001926 * already has a dentry.
Barry Naujok94035402008-05-21 16:50:46 +10001927 */
Al Viro4513d892011-07-17 10:52:14 -04001928 new = d_splice_alias(inode, found);
1929 if (new) {
1930 dput(found);
1931 found = new;
Barry Naujok94035402008-05-21 16:50:46 +10001932 }
Al Viro4513d892011-07-17 10:52:14 -04001933 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001934
1935err_out:
1936 iput(inode);
Al Viro4f522a22013-02-11 23:20:37 -05001937 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001938}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001939EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001941/*
1942 * Do the slow-case of the dentry name compare.
1943 *
1944 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07001945 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001946 * filesystem can rely on them, and can use the 'name' and
1947 * 'len' information without worrying about walking off the
1948 * end of memory etc.
1949 *
1950 * Thus the read_seqcount_retry() and the "duplicate" info
1951 * in arguments (the low-level filesystem should not look
1952 * at the dentry inode or name contents directly, since
1953 * rename can change them while we're in RCU mode).
1954 */
1955enum slow_d_compare {
1956 D_COMP_OK,
1957 D_COMP_NOMATCH,
1958 D_COMP_SEQRETRY,
1959};
1960
1961static noinline enum slow_d_compare slow_dentry_cmp(
1962 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001963 struct dentry *dentry,
1964 unsigned int seq,
1965 const struct qstr *name)
1966{
1967 int tlen = dentry->d_name.len;
1968 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001969
1970 if (read_seqcount_retry(&dentry->d_seq, seq)) {
1971 cpu_relax();
1972 return D_COMP_SEQRETRY;
1973 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07001974 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001975 return D_COMP_NOMATCH;
1976 return D_COMP_OK;
1977}
1978
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979/**
Nick Piggin31e6b012011-01-07 17:49:52 +11001980 * __d_lookup_rcu - search for a dentry (racy, store-free)
1981 * @parent: parent dentry
1982 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07001983 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11001984 * Returns: dentry, or NULL
1985 *
1986 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
1987 * resolution (store-free path walking) design described in
1988 * Documentation/filesystems/path-lookup.txt.
1989 *
1990 * This is not to be used outside core vfs.
1991 *
1992 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
1993 * held, and rcu_read_lock held. The returned dentry must not be stored into
1994 * without taking d_lock and checking d_seq sequence count against @seq
1995 * returned here.
1996 *
Linus Torvalds15570082013-09-02 11:38:06 -07001997 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11001998 * function.
1999 *
2000 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2001 * the returned dentry, so long as its parent's seqlock is checked after the
2002 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2003 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002004 *
2005 * NOTE! The caller *has* to check the resulting dentry against the sequence
2006 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002007 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002008struct dentry *__d_lookup_rcu(const struct dentry *parent,
2009 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002010 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002011{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002012 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002013 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002014 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002015 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002016 struct dentry *dentry;
2017
2018 /*
2019 * Note: There is significant duplication with __d_lookup_rcu which is
2020 * required to prevent single threaded performance regressions
2021 * especially on architectures where smp_rmb (in seqcounts) are costly.
2022 * Keep the two functions in sync.
2023 */
2024
2025 /*
2026 * The hash list is protected using RCU.
2027 *
2028 * Carefully use d_seq when comparing a candidate dentry, to avoid
2029 * races with d_move().
2030 *
2031 * It is possible that concurrent renames can mess up our list
2032 * walk here and result in missing our dentry, resulting in the
2033 * false-negative result. d_lookup() protects against concurrent
2034 * renames using rename_lock seqlock.
2035 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002036 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002037 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002038 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002039 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002040
Nick Piggin31e6b012011-01-07 17:49:52 +11002041seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002042 /*
2043 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002044 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002045 *
2046 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002047 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002048 *
2049 * NOTE! We do a "raw" seqcount_begin here. That means that
2050 * we don't wait for the sequence count to stabilize if it
2051 * is in the middle of a sequence change. If we do the slow
2052 * dentry compare, we will do seqretries until it is stable,
2053 * and if we end up with a successful lookup, we actually
2054 * want to exit RCU lookup anyway.
2055 */
2056 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002057 if (dentry->d_parent != parent)
2058 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002059 if (d_unhashed(dentry))
2060 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002061
2062 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002063 if (dentry->d_name.hash != hashlen_hash(hashlen))
2064 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002065 *seqp = seq;
2066 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002067 case D_COMP_OK:
2068 return dentry;
2069 case D_COMP_NOMATCH:
2070 continue;
2071 default:
2072 goto seqretry;
2073 }
2074 }
2075
Linus Torvalds26fe5752012-05-10 13:14:12 -07002076 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002077 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002078 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002079 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002080 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002081 }
2082 return NULL;
2083}
2084
2085/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 * d_lookup - search for a dentry
2087 * @parent: parent dentry
2088 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002089 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002091 * d_lookup searches the children of the parent dentry for the name in
2092 * question. If the dentry is found its reference count is incremented and the
2093 * dentry is returned. The caller must use dput to free the entry when it has
2094 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095 */
Al Viroda2d8452013-01-24 18:29:34 -05002096struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097{
Nick Piggin31e6b012011-01-07 17:49:52 +11002098 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002099 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100
2101 do {
2102 seq = read_seqbegin(&rename_lock);
2103 dentry = __d_lookup(parent, name);
2104 if (dentry)
2105 break;
2106 } while (read_seqretry(&rename_lock, seq));
2107 return dentry;
2108}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002109EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110
Nick Piggin31e6b012011-01-07 17:49:52 +11002111/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002112 * __d_lookup - search for a dentry (racy)
2113 * @parent: parent dentry
2114 * @name: qstr of name we wish to find
2115 * Returns: dentry, or NULL
2116 *
2117 * __d_lookup is like d_lookup, however it may (rarely) return a
2118 * false-negative result due to unrelated rename activity.
2119 *
2120 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2121 * however it must be used carefully, eg. with a following d_lookup in
2122 * the case of failure.
2123 *
2124 * __d_lookup callers must be commented.
2125 */
Al Viroa713ca22013-01-24 18:27:00 -05002126struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127{
2128 unsigned int len = name->len;
2129 unsigned int hash = name->hash;
2130 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002131 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002132 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002133 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002134 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135
Nick Pigginb04f7842010-08-18 04:37:34 +10002136 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002137 * Note: There is significant duplication with __d_lookup_rcu which is
2138 * required to prevent single threaded performance regressions
2139 * especially on architectures where smp_rmb (in seqcounts) are costly.
2140 * Keep the two functions in sync.
2141 */
2142
2143 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002144 * The hash list is protected using RCU.
2145 *
2146 * Take d_lock when comparing a candidate dentry, to avoid races
2147 * with d_move().
2148 *
2149 * It is possible that concurrent renames can mess up our list
2150 * walk here and result in missing our dentry, resulting in the
2151 * false-negative result. d_lookup() protects against concurrent
2152 * renames using rename_lock seqlock.
2153 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002154 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002155 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 rcu_read_lock();
2157
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002158 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 if (dentry->d_name.hash != hash)
2161 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162
2163 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 if (dentry->d_parent != parent)
2165 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002166 if (d_unhashed(dentry))
2167 goto next;
2168
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 /*
2170 * It is safe to compare names since d_move() cannot
2171 * change the qstr (protected by d_lock).
2172 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002173 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002174 int tlen = dentry->d_name.len;
2175 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002176 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 goto next;
2178 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002179 if (dentry->d_name.len != len)
2180 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002181 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 goto next;
2183 }
2184
Waiman Long98474232013-08-28 18:24:59 -07002185 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002186 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187 spin_unlock(&dentry->d_lock);
2188 break;
2189next:
2190 spin_unlock(&dentry->d_lock);
2191 }
2192 rcu_read_unlock();
2193
2194 return found;
2195}
2196
2197/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002198 * d_hash_and_lookup - hash the qstr then search for a dentry
2199 * @dir: Directory to search in
2200 * @name: qstr of name we wish to find
2201 *
Al Viro4f522a22013-02-11 23:20:37 -05002202 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002203 */
2204struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2205{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002206 /*
2207 * Check for a fs-specific hash function. Note that we must
2208 * calculate the standard hash first, as the d_op->d_hash()
2209 * routine may choose to leave the hash value unchanged.
2210 */
2211 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002212 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002213 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002214 if (unlikely(err < 0))
2215 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002216 }
Al Viro4f522a22013-02-11 23:20:37 -05002217 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002218}
Al Viro4f522a22013-02-11 23:20:37 -05002219EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002220
2221/**
Nick Piggin786a5e12011-01-07 17:49:16 +11002222 * d_validate - verify dentry provided from insecure source (deprecated)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 * @dentry: The dentry alleged to be valid child of @dparent
Randy Dunlapff5fdb62011-01-22 20:16:06 -08002224 * @dparent: The parent dentry (known to be valid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225 *
2226 * An insecure source has sent us a dentry, here we verify it and dget() it.
2227 * This is used by ncpfs in its readdir implementation.
2228 * Zero is returned in the dentry is invalid.
Nick Piggin786a5e12011-01-07 17:49:16 +11002229 *
2230 * This function is slow for big directories, and deprecated, do not use it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231 */
Nick Piggind3a23e12011-01-05 20:01:21 +11002232int d_validate(struct dentry *dentry, struct dentry *dparent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233{
Nick Piggin786a5e12011-01-07 17:49:16 +11002234 struct dentry *child;
Nick Piggind3a23e12011-01-05 20:01:21 +11002235
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002236 spin_lock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002237 list_for_each_entry(child, &dparent->d_subdirs, d_u.d_child) {
2238 if (dentry == child) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002239 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Nick Piggindc0474b2011-01-07 17:49:43 +11002240 __dget_dlock(dentry);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002241 spin_unlock(&dentry->d_lock);
2242 spin_unlock(&dparent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 return 1;
2244 }
2245 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002246 spin_unlock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002247
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 return 0;
2249}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002250EXPORT_SYMBOL(d_validate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251
2252/*
2253 * When a file is deleted, we have two options:
2254 * - turn this dentry into a negative dentry
2255 * - unhash this dentry and free it.
2256 *
2257 * Usually, we want to just turn this into
2258 * a negative dentry, but if anybody else is
2259 * currently using the dentry or the inode
2260 * we can't do that and we fall back on removing
2261 * it from the hash queues and waiting for
2262 * it to be deleted later when it has no users
2263 */
2264
2265/**
2266 * d_delete - delete a dentry
2267 * @dentry: The dentry to delete
2268 *
2269 * Turn the dentry into a negative dentry if possible, otherwise
2270 * remove it from the hash queues so it can be deleted later
2271 */
2272
2273void d_delete(struct dentry * dentry)
2274{
Nick Piggin873feea2011-01-07 17:50:06 +11002275 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002276 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 /*
2278 * Are we the only user?
2279 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002280again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002282 inode = dentry->d_inode;
2283 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002284 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002285 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002286 spin_unlock(&dentry->d_lock);
2287 cpu_relax();
2288 goto again;
2289 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002290 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002291 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002292 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293 return;
2294 }
2295
2296 if (!d_unhashed(dentry))
2297 __d_drop(dentry);
2298
2299 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002300
2301 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002303EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002305static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002307 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002308 hlist_bl_lock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -07002309 entry->d_flags |= DCACHE_RCUACCESS;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002310 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002311 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312}
2313
David Howells770bfad2006-08-22 20:06:07 -04002314static void _d_rehash(struct dentry * entry)
2315{
2316 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2317}
2318
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319/**
2320 * d_rehash - add an entry back to the hash
2321 * @entry: dentry to add to the hash
2322 *
2323 * Adds a dentry to the hash according to its name.
2324 */
2325
2326void d_rehash(struct dentry * entry)
2327{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002329 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002332EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002334/**
2335 * dentry_update_name_case - update case insensitive dentry with a new name
2336 * @dentry: dentry to be updated
2337 * @name: new name
2338 *
2339 * Update a case insensitive dentry with new case of name.
2340 *
2341 * dentry must have been returned by d_lookup with name @name. Old and new
2342 * name lengths must match (ie. no d_compare which allows mismatched name
2343 * lengths).
2344 *
2345 * Parent inode i_mutex must be held over d_lookup and into this call (to
2346 * keep renames and concurrent inserts, and readdir(2) away).
2347 */
2348void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2349{
Linus Torvalds7ebfa572011-04-15 07:34:26 -07002350 BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002351 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2352
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002353 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002354 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002355 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002356 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002357 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002358}
2359EXPORT_SYMBOL(dentry_update_name_case);
2360
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361static void switch_names(struct dentry *dentry, struct dentry *target)
2362{
2363 if (dname_external(target)) {
2364 if (dname_external(dentry)) {
2365 /*
2366 * Both external: swap the pointers
2367 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002368 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369 } else {
2370 /*
2371 * dentry:internal, target:external. Steal target's
2372 * storage and make target internal.
2373 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002374 memcpy(target->d_iname, dentry->d_name.name,
2375 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376 dentry->d_name.name = target->d_name.name;
2377 target->d_name.name = target->d_iname;
2378 }
2379 } else {
2380 if (dname_external(dentry)) {
2381 /*
2382 * dentry:external, target:internal. Give dentry's
2383 * storage to target and make dentry internal
2384 */
2385 memcpy(dentry->d_iname, target->d_name.name,
2386 target->d_name.len + 1);
2387 target->d_name.name = dentry->d_name.name;
2388 dentry->d_name.name = dentry->d_iname;
2389 } else {
2390 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002391 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002393 unsigned int i;
2394 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2395 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2396 swap(((long *) &dentry->d_iname)[i],
2397 ((long *) &target->d_iname)[i]);
2398 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399 }
2400 }
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002401 swap(dentry->d_name.len, target->d_name.len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402}
2403
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002404static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2405{
2406 /*
2407 * XXXX: do we really need to take target->d_lock?
2408 */
2409 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2410 spin_lock(&target->d_parent->d_lock);
2411 else {
2412 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2413 spin_lock(&dentry->d_parent->d_lock);
2414 spin_lock_nested(&target->d_parent->d_lock,
2415 DENTRY_D_LOCK_NESTED);
2416 } else {
2417 spin_lock(&target->d_parent->d_lock);
2418 spin_lock_nested(&dentry->d_parent->d_lock,
2419 DENTRY_D_LOCK_NESTED);
2420 }
2421 }
2422 if (target < dentry) {
2423 spin_lock_nested(&target->d_lock, 2);
2424 spin_lock_nested(&dentry->d_lock, 3);
2425 } else {
2426 spin_lock_nested(&dentry->d_lock, 2);
2427 spin_lock_nested(&target->d_lock, 3);
2428 }
2429}
2430
2431static void dentry_unlock_parents_for_move(struct dentry *dentry,
2432 struct dentry *target)
2433{
2434 if (target->d_parent != dentry->d_parent)
2435 spin_unlock(&dentry->d_parent->d_lock);
2436 if (target->d_parent != target)
2437 spin_unlock(&target->d_parent->d_lock);
2438}
2439
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002441 * When switching names, the actual string doesn't strictly have to
2442 * be preserved in the target - because we're dropping the target
2443 * anyway. As such, we can just do a simple memcpy() to copy over
2444 * the new name before we switch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445 *
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002446 * Note that we have to be a lot more careful about getting the hash
2447 * switched - we have to switch the hash value properly even if it
2448 * then no longer matches the actual (corrupted) string of the target.
2449 * The hash value has to match the hash queue that the dentry is on..
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002451/*
Al Viro18367502011-07-12 21:42:24 -04002452 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453 * @dentry: entry to move
2454 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002455 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456 *
2457 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002458 * dcache entries should not be moved in this way. Caller must hold
2459 * rename_lock, the i_mutex of the source and target directories,
2460 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002462static void __d_move(struct dentry *dentry, struct dentry *target,
2463 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465 if (!dentry->d_inode)
2466 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2467
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002468 BUG_ON(d_ancestor(dentry, target));
2469 BUG_ON(d_ancestor(target, dentry));
2470
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002471 dentry_lock_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472
Nick Piggin31e6b012011-01-07 17:49:52 +11002473 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002474 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002475
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002476 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2477
2478 /*
2479 * Move the dentry to the target hash queue. Don't bother checking
2480 * for the same hash queue because of how unlikely it is.
2481 */
2482 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002483 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484
Miklos Szeredida1ce062014-04-01 17:08:43 +02002485 /*
2486 * Unhash the target (d_delete() is not usable here). If exchanging
2487 * the two dentries, then rehash onto the other's hash queue.
2488 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489 __d_drop(target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002490 if (exchange) {
2491 __d_rehash(target,
2492 d_hash(dentry->d_parent, dentry->d_name.hash));
2493 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494
Eric Dumazet5160ee62006-01-08 01:03:32 -08002495 list_del(&dentry->d_u.d_child);
2496 list_del(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497
2498 /* Switch the names.. */
2499 switch_names(dentry, target);
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002500 swap(dentry->d_name.hash, target->d_name.hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501
2502 /* ... and switch the parents */
2503 if (IS_ROOT(dentry)) {
2504 dentry->d_parent = target->d_parent;
2505 target->d_parent = target;
Eric Dumazet5160ee62006-01-08 01:03:32 -08002506 INIT_LIST_HEAD(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507 } else {
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002508 swap(dentry->d_parent, target->d_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509
2510 /* And add them back to the (new) parent lists */
Eric Dumazet5160ee62006-01-08 01:03:32 -08002511 list_add(&target->d_u.d_child, &target->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512 }
2513
Eric Dumazet5160ee62006-01-08 01:03:32 -08002514 list_add(&dentry->d_u.d_child, &dentry->d_parent->d_subdirs);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002515
Nick Piggin31e6b012011-01-07 17:49:52 +11002516 write_seqcount_end(&target->d_seq);
2517 write_seqcount_end(&dentry->d_seq);
2518
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002519 dentry_unlock_parents_for_move(dentry, target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002520 if (exchange)
2521 fsnotify_d_move(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522 spin_unlock(&target->d_lock);
Nick Pigginc32ccd82006-03-25 03:07:09 -08002523 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002524 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002525}
2526
2527/*
2528 * d_move - move a dentry
2529 * @dentry: entry to move
2530 * @target: new dentry
2531 *
2532 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002533 * dcache entries should not be moved in this way. See the locking
2534 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002535 */
2536void d_move(struct dentry *dentry, struct dentry *target)
2537{
2538 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002539 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002540 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002541}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002542EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543
Miklos Szeredida1ce062014-04-01 17:08:43 +02002544/*
2545 * d_exchange - exchange two dentries
2546 * @dentry1: first dentry
2547 * @dentry2: second dentry
2548 */
2549void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2550{
2551 write_seqlock(&rename_lock);
2552
2553 WARN_ON(!dentry1->d_inode);
2554 WARN_ON(!dentry2->d_inode);
2555 WARN_ON(IS_ROOT(dentry1));
2556 WARN_ON(IS_ROOT(dentry2));
2557
2558 __d_move(dentry1, dentry2, true);
2559
2560 write_sequnlock(&rename_lock);
2561}
2562
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002563/**
2564 * d_ancestor - search for an ancestor
2565 * @p1: ancestor dentry
2566 * @p2: child dentry
2567 *
2568 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2569 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002570 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002571struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002572{
2573 struct dentry *p;
2574
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002575 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002576 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002577 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002578 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002579 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002580}
2581
2582/*
2583 * This helper attempts to cope with remotely renamed directories
2584 *
2585 * It assumes that the caller is already holding
Al Viro18367502011-07-12 21:42:24 -04002586 * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002587 *
2588 * Note: If ever the locking in lock_rename() changes, then please
2589 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002590 */
Nick Piggin873feea2011-01-07 17:50:06 +11002591static struct dentry *__d_unalias(struct inode *inode,
2592 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002593{
2594 struct mutex *m1 = NULL, *m2 = NULL;
Al Viroee3efa92012-06-08 15:59:33 -04002595 struct dentry *ret = ERR_PTR(-EBUSY);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002596
2597 /* If alias and dentry share a parent, then no extra locks required */
2598 if (alias->d_parent == dentry->d_parent)
2599 goto out_unalias;
2600
Trond Myklebust9eaef272006-10-21 10:24:20 -07002601 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002602 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2603 goto out_err;
2604 m1 = &dentry->d_sb->s_vfs_rename_mutex;
2605 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
2606 goto out_err;
2607 m2 = &alias->d_parent->d_inode->i_mutex;
2608out_unalias:
Al Viroee3efa92012-06-08 15:59:33 -04002609 if (likely(!d_mountpoint(alias))) {
Miklos Szeredida1ce062014-04-01 17:08:43 +02002610 __d_move(alias, dentry, false);
Al Viroee3efa92012-06-08 15:59:33 -04002611 ret = alias;
2612 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002613out_err:
Nick Piggin873feea2011-01-07 17:50:06 +11002614 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002615 if (m2)
2616 mutex_unlock(m2);
2617 if (m1)
2618 mutex_unlock(m1);
2619 return ret;
2620}
2621
2622/*
David Howells770bfad2006-08-22 20:06:07 -04002623 * Prepare an anonymous dentry for life in the superblock's dentry tree as a
2624 * named dentry in place of the dentry to be replaced.
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002625 * returns with anon->d_lock held!
David Howells770bfad2006-08-22 20:06:07 -04002626 */
2627static void __d_materialise_dentry(struct dentry *dentry, struct dentry *anon)
2628{
Al Viro740da422013-01-30 10:13:38 -05002629 struct dentry *dparent;
David Howells770bfad2006-08-22 20:06:07 -04002630
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002631 dentry_lock_for_move(anon, dentry);
David Howells770bfad2006-08-22 20:06:07 -04002632
Nick Piggin31e6b012011-01-07 17:49:52 +11002633 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002634 write_seqcount_begin_nested(&anon->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002635
David Howells770bfad2006-08-22 20:06:07 -04002636 dparent = dentry->d_parent;
David Howells770bfad2006-08-22 20:06:07 -04002637
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002638 switch_names(dentry, anon);
2639 swap(dentry->d_name.hash, anon->d_name.hash);
2640
Al Viro740da422013-01-30 10:13:38 -05002641 dentry->d_parent = dentry;
2642 list_del_init(&dentry->d_u.d_child);
2643 anon->d_parent = dparent;
Wei Yongjun9ed53b12013-03-12 00:10:50 +08002644 list_move(&anon->d_u.d_child, &dparent->d_subdirs);
David Howells770bfad2006-08-22 20:06:07 -04002645
Nick Piggin31e6b012011-01-07 17:49:52 +11002646 write_seqcount_end(&dentry->d_seq);
2647 write_seqcount_end(&anon->d_seq);
2648
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002649 dentry_unlock_parents_for_move(anon, dentry);
2650 spin_unlock(&dentry->d_lock);
2651
2652 /* anon->d_lock still locked, returns locked */
David Howells770bfad2006-08-22 20:06:07 -04002653}
2654
2655/**
2656 * d_materialise_unique - introduce an inode into the tree
2657 * @dentry: candidate dentry
2658 * @inode: inode to bind to the dentry, to which aliases may be attached
2659 *
2660 * Introduces an dentry into the tree, substituting an extant disconnected
Jeff Laytonc46c8872011-07-26 13:33:16 -04002661 * root directory alias in its place if there is one. Caller must hold the
2662 * i_mutex of the parent directory.
David Howells770bfad2006-08-22 20:06:07 -04002663 */
2664struct dentry *d_materialise_unique(struct dentry *dentry, struct inode *inode)
2665{
Trond Myklebust9eaef272006-10-21 10:24:20 -07002666 struct dentry *actual;
David Howells770bfad2006-08-22 20:06:07 -04002667
2668 BUG_ON(!d_unhashed(dentry));
2669
David Howells770bfad2006-08-22 20:06:07 -04002670 if (!inode) {
2671 actual = dentry;
OGAWA Hirofumi360da902008-10-16 07:50:28 +09002672 __d_instantiate(dentry, NULL);
Nick Piggin357f8e62011-01-07 17:49:42 +11002673 d_rehash(actual);
2674 goto out_nolock;
David Howells770bfad2006-08-22 20:06:07 -04002675 }
2676
Nick Piggin873feea2011-01-07 17:50:06 +11002677 spin_lock(&inode->i_lock);
Nick Piggin357f8e62011-01-07 17:49:42 +11002678
Trond Myklebust9eaef272006-10-21 10:24:20 -07002679 if (S_ISDIR(inode->i_mode)) {
2680 struct dentry *alias;
David Howells770bfad2006-08-22 20:06:07 -04002681
Trond Myklebust9eaef272006-10-21 10:24:20 -07002682 /* Does an aliased dentry already exist? */
Linus Torvalds32ba9c32012-06-08 10:34:03 -07002683 alias = __d_find_alias(inode, 0);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002684 if (alias) {
2685 actual = alias;
Al Viro18367502011-07-12 21:42:24 -04002686 write_seqlock(&rename_lock);
2687
2688 if (d_ancestor(alias, dentry)) {
2689 /* Check for loops */
2690 actual = ERR_PTR(-ELOOP);
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002691 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002692 } else if (IS_ROOT(alias)) {
2693 /* Is this an anonymous mountpoint that we
2694 * could splice into our tree? */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002695 __d_materialise_dentry(dentry, alias);
Al Viro18367502011-07-12 21:42:24 -04002696 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002697 __d_drop(alias);
2698 goto found;
Al Viro18367502011-07-12 21:42:24 -04002699 } else {
2700 /* Nope, but we must(!) avoid directory
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002701 * aliasing. This drops inode->i_lock */
Al Viro18367502011-07-12 21:42:24 -04002702 actual = __d_unalias(inode, dentry, alias);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002703 }
Al Viro18367502011-07-12 21:42:24 -04002704 write_sequnlock(&rename_lock);
David Howellsdd179942011-08-16 15:31:30 +01002705 if (IS_ERR(actual)) {
2706 if (PTR_ERR(actual) == -ELOOP)
2707 pr_warn_ratelimited(
2708 "VFS: Lookup of '%s' in %s %s"
2709 " would have caused loop\n",
2710 dentry->d_name.name,
2711 inode->i_sb->s_type->name,
2712 inode->i_sb->s_id);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002713 dput(alias);
David Howellsdd179942011-08-16 15:31:30 +01002714 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002715 goto out_nolock;
2716 }
David Howells770bfad2006-08-22 20:06:07 -04002717 }
2718
2719 /* Add a unique reference */
2720 actual = __d_instantiate_unique(dentry, inode);
2721 if (!actual)
2722 actual = dentry;
Nick Piggin357f8e62011-01-07 17:49:42 +11002723 else
2724 BUG_ON(!d_unhashed(actual));
David Howells770bfad2006-08-22 20:06:07 -04002725
David Howells770bfad2006-08-22 20:06:07 -04002726 spin_lock(&actual->d_lock);
2727found:
2728 _d_rehash(actual);
2729 spin_unlock(&actual->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002730 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002731out_nolock:
David Howells770bfad2006-08-22 20:06:07 -04002732 if (actual == dentry) {
2733 security_d_instantiate(dentry, inode);
2734 return NULL;
2735 }
2736
2737 iput(inode);
2738 return actual;
David Howells770bfad2006-08-22 20:06:07 -04002739}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002740EXPORT_SYMBOL_GPL(d_materialise_unique);
David Howells770bfad2006-08-22 20:06:07 -04002741
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002742static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002743{
2744 *buflen -= namelen;
2745 if (*buflen < 0)
2746 return -ENAMETOOLONG;
2747 *buffer -= namelen;
2748 memcpy(*buffer, str, namelen);
2749 return 0;
2750}
2751
Waiman Long232d2d62013-09-09 12:18:13 -04002752/**
2753 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04002754 * @buffer: buffer pointer
2755 * @buflen: allocated length of the buffer
2756 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04002757 *
2758 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
2759 * make sure that either the old or the new name pointer and length are
2760 * fetched. However, there may be mismatch between length and pointer.
2761 * The length cannot be trusted, we need to copy it byte-by-byte until
2762 * the length is reached or a null byte is found. It also prepends "/" at
2763 * the beginning of the name. The sequence number check at the caller will
2764 * retry it again when a d_move() does happen. So any garbage in the buffer
2765 * due to mismatched pointer and length will be discarded.
2766 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002767static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2768{
Waiman Long232d2d62013-09-09 12:18:13 -04002769 const char *dname = ACCESS_ONCE(name->name);
2770 u32 dlen = ACCESS_ONCE(name->len);
2771 char *p;
2772
Waiman Long232d2d62013-09-09 12:18:13 -04002773 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04002774 if (*buflen < 0)
2775 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04002776 p = *buffer -= dlen + 1;
2777 *p++ = '/';
2778 while (dlen--) {
2779 char c = *dname++;
2780 if (!c)
2781 break;
2782 *p++ = c;
2783 }
2784 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002785}
2786
Linus Torvalds1da177e2005-04-16 15:20:36 -07002787/**
Randy Dunlap208898c2010-11-18 15:02:49 -08002788 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002789 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002790 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002791 * @buffer: pointer to the end of the buffer
2792 * @buflen: pointer to buffer length
2793 *
Waiman Long18129972013-09-12 10:55:35 -04002794 * The function will first try to write out the pathname without taking any
2795 * lock other than the RCU read lock to make sure that dentries won't go away.
2796 * It only checks the sequence number of the global rename_lock as any change
2797 * in the dentry's d_seq will be preceded by changes in the rename_lock
2798 * sequence number. If the sequence number had been changed, it will restart
2799 * the whole pathname back-tracing sequence again by taking the rename_lock.
2800 * In this case, there is no need to take the RCU read lock as the recursive
2801 * parent pointer references will keep the dentry chain alive as long as no
2802 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002803 */
Al Viro02125a82011-12-05 08:43:34 -05002804static int prepend_path(const struct path *path,
2805 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002806 char **buffer, int *buflen)
2807{
Al Viroede4ceb2013-11-13 07:45:40 -05002808 struct dentry *dentry;
2809 struct vfsmount *vfsmnt;
2810 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002811 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04002812 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04002813 char *bptr;
2814 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002815
Al Viro48f5ec22013-09-09 15:22:25 -04002816 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04002817restart_mnt:
2818 read_seqbegin_or_lock(&mount_lock, &m_seq);
2819 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002820 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002821restart:
2822 bptr = *buffer;
2823 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04002824 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05002825 dentry = path->dentry;
2826 vfsmnt = path->mnt;
2827 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04002828 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002829 while (dentry != root->dentry || vfsmnt != root->mnt) {
2830 struct dentry * parent;
2831
2832 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04002833 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002834 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04002835 if (mnt != parent) {
2836 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
2837 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04002838 vfsmnt = &mnt->mnt;
2839 continue;
2840 }
2841 /*
2842 * Filesystems needing to implement special "root names"
2843 * should do so with ->d_dname()
2844 */
2845 if (IS_ROOT(dentry) &&
2846 (dentry->d_name.len != 1 ||
2847 dentry->d_name.name[0] != '/')) {
2848 WARN(1, "Root dentry has weird name <%.*s>\n",
2849 (int) dentry->d_name.len,
2850 dentry->d_name.name);
2851 }
2852 if (!error)
2853 error = is_mounted(vfsmnt) ? 1 : 2;
2854 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002855 }
2856 parent = dentry->d_parent;
2857 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002858 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002859 if (error)
2860 break;
2861
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002862 dentry = parent;
2863 }
Al Viro48f5ec22013-09-09 15:22:25 -04002864 if (!(seq & 1))
2865 rcu_read_unlock();
2866 if (need_seqretry(&rename_lock, seq)) {
2867 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04002868 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002869 }
Al Viro48f5ec22013-09-09 15:22:25 -04002870 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002871
2872 if (!(m_seq & 1))
2873 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04002874 if (need_seqretry(&mount_lock, m_seq)) {
2875 m_seq = 1;
2876 goto restart_mnt;
2877 }
2878 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002879
Waiman Long232d2d62013-09-09 12:18:13 -04002880 if (error >= 0 && bptr == *buffer) {
2881 if (--blen < 0)
2882 error = -ENAMETOOLONG;
2883 else
2884 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002885 }
Waiman Long232d2d62013-09-09 12:18:13 -04002886 *buffer = bptr;
2887 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04002888 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002889}
2890
2891/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002892 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002893 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002894 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07002895 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07002896 * @buflen: buffer length
2897 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002898 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002899 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002900 * Returns a pointer into the buffer or an error code if the
2901 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08002902 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04002903 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002904 *
Al Viro02125a82011-12-05 08:43:34 -05002905 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002906 */
Al Viro02125a82011-12-05 08:43:34 -05002907char *__d_path(const struct path *path,
2908 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002909 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002910{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002911 char *res = buf + buflen;
2912 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002913
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002914 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002915 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002916
Al Viro02125a82011-12-05 08:43:34 -05002917 if (error < 0)
2918 return ERR_PTR(error);
2919 if (error > 0)
2920 return NULL;
2921 return res;
2922}
2923
2924char *d_absolute_path(const struct path *path,
2925 char *buf, int buflen)
2926{
2927 struct path root = {};
2928 char *res = buf + buflen;
2929 int error;
2930
2931 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05002932 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05002933
2934 if (error > 1)
2935 error = -EINVAL;
2936 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002937 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002938 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002939}
2940
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002941/*
2942 * same as __d_path but appends "(deleted)" for unlinked files.
2943 */
Al Viro02125a82011-12-05 08:43:34 -05002944static int path_with_deleted(const struct path *path,
2945 const struct path *root,
2946 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002947{
2948 prepend(buf, buflen, "\0", 1);
2949 if (d_unlinked(path->dentry)) {
2950 int error = prepend(buf, buflen, " (deleted)", 10);
2951 if (error)
2952 return error;
2953 }
2954
2955 return prepend_path(path, root, buf, buflen);
2956}
2957
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002958static int prepend_unreachable(char **buffer, int *buflen)
2959{
2960 return prepend(buffer, buflen, "(unreachable)", 13);
2961}
2962
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07002963static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
2964{
2965 unsigned seq;
2966
2967 do {
2968 seq = read_seqcount_begin(&fs->seq);
2969 *root = fs->root;
2970 } while (read_seqcount_retry(&fs->seq, seq));
2971}
2972
Jan Bluncka03a8a702008-02-14 19:38:32 -08002973/**
2974 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08002975 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08002976 * @buf: buffer to return value in
2977 * @buflen: buffer length
2978 *
2979 * Convert a dentry into an ASCII path name. If the entry has been deleted
2980 * the string " (deleted)" is appended. Note that this is ambiguous.
2981 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002982 * Returns a pointer into the buffer or an error code if the path was
2983 * too long. Note: Callers should use the returned pointer, not the passed
2984 * in buffer, to use the name! The implementation often starts at an offset
2985 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002986 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002987 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002988 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07002989char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002990{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002991 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08002992 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002993 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002994
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002995 /*
2996 * We have various synthetic filesystems that never get mounted. On
2997 * these filesystems dentries are never used for lookup purposes, and
2998 * thus don't need to be hashed. They also don't need a name until a
2999 * user wants to identify the object in /proc/pid/fd/. The little hack
3000 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003001 *
3002 * Some pseudo inodes are mountable. When they are mounted
3003 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3004 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003005 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003006 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3007 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003008 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003009
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003010 rcu_read_lock();
3011 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003012 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003013 rcu_read_unlock();
3014
Al Viro02125a82011-12-05 08:43:34 -05003015 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003016 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003017 return res;
3018}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003019EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003020
3021/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003022 * Helper function for dentry_operations.d_dname() members
3023 */
3024char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3025 const char *fmt, ...)
3026{
3027 va_list args;
3028 char temp[64];
3029 int sz;
3030
3031 va_start(args, fmt);
3032 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3033 va_end(args);
3034
3035 if (sz > sizeof(temp) || sz > buflen)
3036 return ERR_PTR(-ENAMETOOLONG);
3037
3038 buffer += buflen - sz;
3039 return memcpy(buffer, temp, sz);
3040}
3041
Al Viro118b2302013-08-24 12:08:17 -04003042char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3043{
3044 char *end = buffer + buflen;
3045 /* these dentries are never renamed, so d_lock is not needed */
3046 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003047 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003048 prepend(&end, &buflen, "/", 1))
3049 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003050 return end;
Al Viro118b2302013-08-24 12:08:17 -04003051}
David Herrmann31bbe162014-01-03 14:09:47 +01003052EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003053
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003054/*
Ram Pai6092d042008-03-27 13:06:20 +01003055 * Write full pathname from the root of the filesystem into the buffer.
3056 */
Al Virof6500802014-01-26 12:37:55 -05003057static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003058{
Al Virof6500802014-01-26 12:37:55 -05003059 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003060 char *end, *retval;
3061 int len, seq = 0;
3062 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003063
Al Virof6500802014-01-26 12:37:55 -05003064 if (buflen < 2)
3065 goto Elong;
3066
Al Viro48f5ec22013-09-09 15:22:25 -04003067 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003068restart:
Al Virof6500802014-01-26 12:37:55 -05003069 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003070 end = buf + buflen;
3071 len = buflen;
3072 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003073 /* Get '/' right */
3074 retval = end-1;
3075 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003076 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003077 while (!IS_ROOT(dentry)) {
3078 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003079
Ram Pai6092d042008-03-27 13:06:20 +01003080 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003081 error = prepend_name(&end, &len, &dentry->d_name);
3082 if (error)
3083 break;
Ram Pai6092d042008-03-27 13:06:20 +01003084
3085 retval = end;
3086 dentry = parent;
3087 }
Al Viro48f5ec22013-09-09 15:22:25 -04003088 if (!(seq & 1))
3089 rcu_read_unlock();
3090 if (need_seqretry(&rename_lock, seq)) {
3091 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003092 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003093 }
3094 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003095 if (error)
3096 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003097 return retval;
3098Elong:
3099 return ERR_PTR(-ENAMETOOLONG);
3100}
Nick Pigginec2447c2011-01-07 17:49:29 +11003101
3102char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3103{
Waiman Long232d2d62013-09-09 12:18:13 -04003104 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003105}
3106EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003107
3108char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3109{
3110 char *p = NULL;
3111 char *retval;
3112
Al Viroc1031352010-06-06 22:31:14 -04003113 if (d_unlinked(dentry)) {
3114 p = buf + buflen;
3115 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3116 goto Elong;
3117 buflen++;
3118 }
3119 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003120 if (!IS_ERR(retval) && p)
3121 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003122 return retval;
3123Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003124 return ERR_PTR(-ENAMETOOLONG);
3125}
3126
Linus Torvalds8b19e342013-09-12 10:35:47 -07003127static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3128 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003129{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003130 unsigned seq;
3131
3132 do {
3133 seq = read_seqcount_begin(&fs->seq);
3134 *root = fs->root;
3135 *pwd = fs->pwd;
3136 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003137}
3138
Ram Pai6092d042008-03-27 13:06:20 +01003139/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003140 * NOTE! The user-level library version returns a
3141 * character pointer. The kernel system call just
3142 * returns the length of the buffer filled (which
3143 * includes the ending '\0' character), or a negative
3144 * error value. So libc would do something like
3145 *
3146 * char *getcwd(char * buf, size_t size)
3147 * {
3148 * int retval;
3149 *
3150 * retval = sys_getcwd(buf, size);
3151 * if (retval >= 0)
3152 * return buf;
3153 * errno = -retval;
3154 * return NULL;
3155 * }
3156 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003157SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003158{
Linus Torvalds552ce542007-02-13 12:08:18 -08003159 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003160 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003161 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003162
3163 if (!page)
3164 return -ENOMEM;
3165
Linus Torvalds8b19e342013-09-12 10:35:47 -07003166 rcu_read_lock();
3167 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003168
Linus Torvalds552ce542007-02-13 12:08:18 -08003169 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003170 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003171 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003172 char *cwd = page + PATH_MAX;
3173 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003174
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003175 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003176 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003177 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003178
Al Viro02125a82011-12-05 08:43:34 -05003179 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003180 goto out;
3181
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003182 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003183 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003184 error = prepend_unreachable(&cwd, &buflen);
3185 if (error)
3186 goto out;
3187 }
3188
Linus Torvalds552ce542007-02-13 12:08:18 -08003189 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003190 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003191 if (len <= size) {
3192 error = len;
3193 if (copy_to_user(buf, cwd, len))
3194 error = -EFAULT;
3195 }
Nick Piggin949854d2011-01-07 17:49:37 +11003196 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003197 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003198 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003199
3200out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003201 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003202 return error;
3203}
3204
3205/*
3206 * Test whether new_dentry is a subdirectory of old_dentry.
3207 *
3208 * Trivially implemented using the dcache structure
3209 */
3210
3211/**
3212 * is_subdir - is new dentry a subdirectory of old_dentry
3213 * @new_dentry: new dentry
3214 * @old_dentry: old dentry
3215 *
3216 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
3217 * Returns 0 otherwise.
3218 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3219 */
3220
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003221int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003222{
3223 int result;
Nick Piggin949854d2011-01-07 17:49:37 +11003224 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003225
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003226 if (new_dentry == old_dentry)
3227 return 1;
3228
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003229 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003230 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003231 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003232 /*
3233 * Need rcu_readlock to protect against the d_parent trashing
3234 * due to d_move
3235 */
3236 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003237 if (d_ancestor(old_dentry, new_dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003238 result = 1;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003239 else
3240 result = 0;
Nick Piggin949854d2011-01-07 17:49:37 +11003241 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003242 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003243
3244 return result;
3245}
3246
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003247static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003248{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003249 struct dentry *root = data;
3250 if (dentry != root) {
3251 if (d_unhashed(dentry) || !dentry->d_inode)
3252 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003253
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003254 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3255 dentry->d_flags |= DCACHE_GENOCIDE;
3256 dentry->d_lockref.count--;
3257 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003258 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003259 return D_WALK_CONTINUE;
3260}
Nick Piggin58db63d2011-01-07 17:49:39 +11003261
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003262void d_genocide(struct dentry *parent)
3263{
3264 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003265}
3266
Al Viro60545d02013-06-07 01:20:27 -04003267void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003268{
Al Viro60545d02013-06-07 01:20:27 -04003269 inode_dec_link_count(inode);
3270 BUG_ON(dentry->d_name.name != dentry->d_iname ||
3271 !hlist_unhashed(&dentry->d_alias) ||
3272 !d_unlinked(dentry));
3273 spin_lock(&dentry->d_parent->d_lock);
3274 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3275 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3276 (unsigned long long)inode->i_ino);
3277 spin_unlock(&dentry->d_lock);
3278 spin_unlock(&dentry->d_parent->d_lock);
3279 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003280}
Al Viro60545d02013-06-07 01:20:27 -04003281EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003282
3283static __initdata unsigned long dhash_entries;
3284static int __init set_dhash_entries(char *str)
3285{
3286 if (!str)
3287 return 0;
3288 dhash_entries = simple_strtoul(str, &str, 0);
3289 return 1;
3290}
3291__setup("dhash_entries=", set_dhash_entries);
3292
3293static void __init dcache_init_early(void)
3294{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003295 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003296
3297 /* If hashes are distributed across NUMA nodes, defer
3298 * hash allocation until vmalloc space is available.
3299 */
3300 if (hashdist)
3301 return;
3302
3303 dentry_hashtable =
3304 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003305 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003306 dhash_entries,
3307 13,
3308 HASH_EARLY,
3309 &d_hash_shift,
3310 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003311 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003312 0);
3313
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003314 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003315 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003316}
3317
Denis Cheng74bf17c2007-10-16 23:26:30 -07003318static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003319{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003320 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003321
3322 /*
3323 * A constructor could be added for stable state like the lists,
3324 * but it is probably not worth it because of the cache nature
3325 * of the dcache.
3326 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003327 dentry_cache = KMEM_CACHE(dentry,
3328 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003329
3330 /* Hash may have been set up in dcache_init_early */
3331 if (!hashdist)
3332 return;
3333
3334 dentry_hashtable =
3335 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003336 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003337 dhash_entries,
3338 13,
3339 0,
3340 &d_hash_shift,
3341 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003342 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003343 0);
3344
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003345 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003346 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003347}
3348
3349/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003350struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003351EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003352
Linus Torvalds1da177e2005-04-16 15:20:36 -07003353EXPORT_SYMBOL(d_genocide);
3354
Linus Torvalds1da177e2005-04-16 15:20:36 -07003355void __init vfs_caches_init_early(void)
3356{
3357 dcache_init_early();
3358 inode_init_early();
3359}
3360
3361void __init vfs_caches_init(unsigned long mempages)
3362{
3363 unsigned long reserve;
3364
3365 /* Base hash sizes on available memory, with a reserve equal to
3366 150% of current kernel size */
3367
3368 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
3369 mempages -= reserve;
3370
3371 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003372 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003373
Denis Cheng74bf17c2007-10-16 23:26:30 -07003374 dcache_init();
3375 inode_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003376 files_init(mempages);
Denis Cheng74bf17c2007-10-16 23:26:30 -07003377 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003378 bdev_cache_init();
3379 chrdev_init();
3380}