blob: 42ae01eefc0767902b4827ef4113199fd6e57a1a [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
Miklos Szeredi60942f22014-05-02 15:38:39 -0400799 while (!list_empty(list)) {
800 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100801 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000803 * The dispose list is isolated and dentries are not accounted
804 * to the LRU here, so we can simply remove it from the list
805 * here regardless of whether it is referenced or not.
806 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400807 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000808
809 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000811 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 */
Al Viro41edf272014-05-01 10:30:00 -0400813 if ((int)dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700814 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 continue;
816 }
Nick Piggin77812a12011-01-07 17:49:48 +1100817
Al Viro5c47e6d2014-04-29 16:13:18 -0400818 parent = dentry_kill(dentry, 0);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400819 /*
Al Viro5c47e6d2014-04-29 16:13:18 -0400820 * If dentry_kill returns NULL, we have nothing more to do.
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400821 */
Miklos Szeredi60942f22014-05-02 15:38:39 -0400822 if (!parent)
Al Viro5c47e6d2014-04-29 16:13:18 -0400823 continue;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400824
Al Viro5c47e6d2014-04-29 16:13:18 -0400825 if (unlikely(parent == dentry)) {
826 /*
827 * trylocks have failed and d_lock has been held the
828 * whole time, so it could not have been added to any
829 * other lists. Just add it back to the shrink list.
830 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400831 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000832 spin_unlock(&dentry->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -0400833 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000834 }
Al Viro5c47e6d2014-04-29 16:13:18 -0400835 /*
836 * We need to prune ancestors too. This is necessary to prevent
837 * quadratic behavior of shrink_dcache_parent(), but is also
838 * expected to be beneficial in reducing dentry cache
839 * fragmentation.
840 */
841 dentry = parent;
842 while (dentry && !lockref_put_or_lock(&dentry->d_lockref))
843 dentry = dentry_kill(dentry, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400845}
846
Dave Chinnerf6041562013-08-28 10:18:00 +1000847static enum lru_status
848dentry_lru_isolate(struct list_head *item, spinlock_t *lru_lock, void *arg)
849{
850 struct list_head *freeable = arg;
851 struct dentry *dentry = container_of(item, struct dentry, d_lru);
852
853
854 /*
855 * we are inverting the lru lock/dentry->d_lock here,
856 * so use a trylock. If we fail to get the lock, just skip
857 * it
858 */
859 if (!spin_trylock(&dentry->d_lock))
860 return LRU_SKIP;
861
862 /*
863 * Referenced dentries are still in use. If they have active
864 * counts, just remove them from the LRU. Otherwise give them
865 * another pass through the LRU.
866 */
867 if (dentry->d_lockref.count) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400868 d_lru_isolate(dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +1000869 spin_unlock(&dentry->d_lock);
870 return LRU_REMOVED;
871 }
872
873 if (dentry->d_flags & DCACHE_REFERENCED) {
874 dentry->d_flags &= ~DCACHE_REFERENCED;
875 spin_unlock(&dentry->d_lock);
876
877 /*
878 * The list move itself will be made by the common LRU code. At
879 * this point, we've dropped the dentry->d_lock but keep the
880 * lru lock. This is safe to do, since every list movement is
881 * protected by the lru lock even if both locks are held.
882 *
883 * This is guaranteed by the fact that all LRU management
884 * functions are intermediated by the LRU API calls like
885 * list_lru_add and list_lru_del. List movement in this file
886 * only ever occur through this functions or through callbacks
887 * like this one, that are called from the LRU API.
888 *
889 * The only exceptions to this are functions like
890 * shrink_dentry_list, and code that first checks for the
891 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
892 * operating only with stack provided lists after they are
893 * properly isolated from the main list. It is thus, always a
894 * local access.
895 */
896 return LRU_ROTATE;
897 }
898
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400899 d_lru_shrink_move(dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +1000900 spin_unlock(&dentry->d_lock);
901
902 return LRU_REMOVED;
903}
904
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400905/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000906 * prune_dcache_sb - shrink the dcache
907 * @sb: superblock
Dave Chinnerf6041562013-08-28 10:18:00 +1000908 * @nr_to_scan : number of entries to try to free
Dave Chinner9b17c622013-08-28 10:18:05 +1000909 * @nid: which node to scan for freeable entities
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400910 *
Dave Chinnerf6041562013-08-28 10:18:00 +1000911 * Attempt to shrink the superblock dcache LRU by @nr_to_scan entries. This is
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000912 * done when we need more memory an called from the superblock shrinker
913 * function.
914 *
915 * This function may fail to free any resources if all the dentries are in
916 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400917 */
Dave Chinner9b17c622013-08-28 10:18:05 +1000918long prune_dcache_sb(struct super_block *sb, unsigned long nr_to_scan,
919 int nid)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400920{
Dave Chinnerf6041562013-08-28 10:18:00 +1000921 LIST_HEAD(dispose);
922 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400923
Dave Chinner9b17c622013-08-28 10:18:05 +1000924 freed = list_lru_walk_node(&sb->s_dentry_lru, nid, dentry_lru_isolate,
925 &dispose, &nr_to_scan);
Dave Chinnerf6041562013-08-28 10:18:00 +1000926 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +1000927 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928}
929
Glauber Costa4e717f52013-08-28 10:18:03 +1000930static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
931 spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000932{
Glauber Costa4e717f52013-08-28 10:18:03 +1000933 struct list_head *freeable = arg;
934 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000935
Glauber Costa4e717f52013-08-28 10:18:03 +1000936 /*
937 * we are inverting the lru lock/dentry->d_lock here,
938 * so use a trylock. If we fail to get the lock, just skip
939 * it
940 */
941 if (!spin_trylock(&dentry->d_lock))
942 return LRU_SKIP;
943
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400944 d_lru_shrink_move(dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +1000945 spin_unlock(&dentry->d_lock);
946
947 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000948}
949
Glauber Costa4e717f52013-08-28 10:18:03 +1000950
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700951/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 * shrink_dcache_sb - shrink dcache for a superblock
953 * @sb: superblock
954 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400955 * Shrink the dcache for the specified super block. This is used to free
956 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400958void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959{
Glauber Costa4e717f52013-08-28 10:18:03 +1000960 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400961
Glauber Costa4e717f52013-08-28 10:18:03 +1000962 do {
963 LIST_HEAD(dispose);
964
965 freed = list_lru_walk(&sb->s_dentry_lru,
966 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
967
968 this_cpu_sub(nr_dentry_unused, freed);
969 shrink_dentry_list(&dispose);
970 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700972EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +0200975 * enum d_walk_ret - action to talke during tree walk
976 * @D_WALK_CONTINUE: contrinue walk
977 * @D_WALK_QUIT: quit walk
978 * @D_WALK_NORETRY: quit when retry is needed
979 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +0200981enum d_walk_ret {
982 D_WALK_CONTINUE,
983 D_WALK_QUIT,
984 D_WALK_NORETRY,
985 D_WALK_SKIP,
986};
987
988/**
989 * d_walk - walk the dentry tree
990 * @parent: start of walk
991 * @data: data passed to @enter() and @finish()
992 * @enter: callback when first entering the dentry
993 * @finish: callback when successfully finished the walk
994 *
995 * The @enter() and @finish() callbacks are called with d_lock held.
996 */
997static void d_walk(struct dentry *parent, void *data,
998 enum d_walk_ret (*enter)(void *, struct dentry *),
999 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000{
Nick Piggin949854d2011-01-07 17:49:37 +11001001 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001003 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001004 enum d_walk_ret ret;
1005 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001006
Nick Piggin58db63d2011-01-07 17:49:39 +11001007again:
Al Viro48f5ec22013-09-09 15:22:25 -04001008 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001009 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001010 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001011
1012 ret = enter(data, this_parent);
1013 switch (ret) {
1014 case D_WALK_CONTINUE:
1015 break;
1016 case D_WALK_QUIT:
1017 case D_WALK_SKIP:
1018 goto out_unlock;
1019 case D_WALK_NORETRY:
1020 retry = false;
1021 break;
1022 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023repeat:
1024 next = this_parent->d_subdirs.next;
1025resume:
1026 while (next != &this_parent->d_subdirs) {
1027 struct list_head *tmp = next;
Eric Dumazet5160ee62006-01-08 01:03:32 -08001028 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001030
1031 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001032
1033 ret = enter(data, dentry);
1034 switch (ret) {
1035 case D_WALK_CONTINUE:
1036 break;
1037 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001038 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001039 goto out_unlock;
1040 case D_WALK_NORETRY:
1041 retry = false;
1042 break;
1043 case D_WALK_SKIP:
1044 spin_unlock(&dentry->d_lock);
1045 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001046 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001047
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001049 spin_unlock(&this_parent->d_lock);
1050 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001052 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 goto repeat;
1054 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001055 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 }
1057 /*
1058 * All done at this level ... ascend and resume the search.
1059 */
1060 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001061 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001062 this_parent = child->d_parent;
1063
1064 rcu_read_lock();
1065 spin_unlock(&child->d_lock);
1066 spin_lock(&this_parent->d_lock);
1067
1068 /*
1069 * might go back up the wrong parent if we have had a rename
1070 * or deletion
1071 */
1072 if (this_parent != child->d_parent ||
1073 (child->d_flags & DCACHE_DENTRY_KILLED) ||
1074 need_seqretry(&rename_lock, seq)) {
1075 spin_unlock(&this_parent->d_lock);
1076 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11001077 goto rename_retry;
Al Viro31dec132013-10-25 17:04:27 -04001078 }
1079 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11001080 next = child->d_u.d_child.next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 goto resume;
1082 }
Al Viro48f5ec22013-09-09 15:22:25 -04001083 if (need_seqretry(&rename_lock, seq)) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001084 spin_unlock(&this_parent->d_lock);
1085 goto rename_retry;
1086 }
1087 if (finish)
1088 finish(data);
1089
1090out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001091 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001092 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001093 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001094
1095rename_retry:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001096 if (!retry)
1097 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001098 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001099 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001101
1102/*
1103 * Search for at least 1 mount point in the dentry's subdirs.
1104 * We descend to the next level whenever the d_subdirs
1105 * list is non-empty and continue searching.
1106 */
1107
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001108static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1109{
1110 int *ret = data;
1111 if (d_mountpoint(dentry)) {
1112 *ret = 1;
1113 return D_WALK_QUIT;
1114 }
1115 return D_WALK_CONTINUE;
1116}
1117
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001118/**
1119 * have_submounts - check for mounts over a dentry
1120 * @parent: dentry to check.
1121 *
1122 * Return true if the parent or its subdirectories contain
1123 * a mount point
1124 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001125int have_submounts(struct dentry *parent)
1126{
1127 int ret = 0;
1128
1129 d_walk(parent, &ret, check_mount, NULL);
1130
1131 return ret;
1132}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001133EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134
1135/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001136 * Called by mount code to set a mountpoint and check if the mountpoint is
1137 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1138 * subtree can become unreachable).
1139 *
1140 * Only one of check_submounts_and_drop() and d_set_mounted() must succeed. For
1141 * this reason take rename_lock and d_lock on dentry and ancestors.
1142 */
1143int d_set_mounted(struct dentry *dentry)
1144{
1145 struct dentry *p;
1146 int ret = -ENOENT;
1147 write_seqlock(&rename_lock);
1148 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
1149 /* Need exclusion wrt. check_submounts_and_drop() */
1150 spin_lock(&p->d_lock);
1151 if (unlikely(d_unhashed(p))) {
1152 spin_unlock(&p->d_lock);
1153 goto out;
1154 }
1155 spin_unlock(&p->d_lock);
1156 }
1157 spin_lock(&dentry->d_lock);
1158 if (!d_unlinked(dentry)) {
1159 dentry->d_flags |= DCACHE_MOUNTED;
1160 ret = 0;
1161 }
1162 spin_unlock(&dentry->d_lock);
1163out:
1164 write_sequnlock(&rename_lock);
1165 return ret;
1166}
1167
1168/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001169 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170 * and move any unused dentries to the end of the unused
1171 * list for prune_dcache(). We descend to the next level
1172 * whenever the d_subdirs list is non-empty and continue
1173 * searching.
1174 *
1175 * It returns zero iff there are no unused children,
1176 * otherwise it returns the number of children moved to
1177 * the end of the unused list. This may not be the total
1178 * number of unused children, because select_parent can
1179 * drop the lock and return early due to latency
1180 * constraints.
1181 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001182
1183struct select_data {
1184 struct dentry *start;
1185 struct list_head dispose;
1186 int found;
1187};
1188
1189static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001191 struct select_data *data = _data;
1192 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001194 if (data->start == dentry)
1195 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196
Al Virofe915222014-05-03 00:02:25 -04001197 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001198 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001199 } else {
1200 if (dentry->d_flags & DCACHE_LRU_LIST)
1201 d_lru_del(dentry);
1202 if (!dentry->d_lockref.count) {
1203 d_shrink_add(dentry, &data->dispose);
1204 data->found++;
1205 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 }
1207 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001208 * We can return to the caller if we have found some (this
1209 * ensures forward progress). We'll be coming back to find
1210 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 */
Al Virofe915222014-05-03 00:02:25 -04001212 if (!list_empty(&data->dispose))
1213 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001215 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216}
1217
1218/**
1219 * shrink_dcache_parent - prune dcache
1220 * @parent: parent of entries to prune
1221 *
1222 * Prune the dcache to remove unused children of the parent dentry.
1223 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001224void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001226 for (;;) {
1227 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001229 INIT_LIST_HEAD(&data.dispose);
1230 data.start = parent;
1231 data.found = 0;
1232
1233 d_walk(parent, &data, select_collect, NULL);
1234 if (!data.found)
1235 break;
1236
1237 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001238 cond_resched();
1239 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001241EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242
Al Viro9c8c10e2014-05-02 20:36:10 -04001243static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001244{
Al Viro9c8c10e2014-05-02 20:36:10 -04001245 /* it has busy descendents; complain about those instead */
1246 if (!list_empty(&dentry->d_subdirs))
1247 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001248
Al Viro9c8c10e2014-05-02 20:36:10 -04001249 /* root with refcount 1 is fine */
1250 if (dentry == _data && dentry->d_lockref.count == 1)
1251 return D_WALK_CONTINUE;
1252
1253 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1254 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001255 dentry,
1256 dentry->d_inode ?
1257 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001258 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001259 dentry->d_lockref.count,
1260 dentry->d_sb->s_type->name,
1261 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001262 WARN_ON(1);
1263 return D_WALK_CONTINUE;
1264}
1265
1266static void do_one_tree(struct dentry *dentry)
1267{
1268 shrink_dcache_parent(dentry);
1269 d_walk(dentry, dentry, umount_check, NULL);
1270 d_drop(dentry);
1271 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001272}
1273
1274/*
1275 * destroy the dentries attached to a superblock on unmounting
1276 */
1277void shrink_dcache_for_umount(struct super_block *sb)
1278{
1279 struct dentry *dentry;
1280
Al Viro9c8c10e2014-05-02 20:36:10 -04001281 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001282
1283 dentry = sb->s_root;
1284 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001285 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001286
1287 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001288 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1289 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001290 }
1291}
1292
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001293static enum d_walk_ret check_and_collect(void *_data, struct dentry *dentry)
1294{
1295 struct select_data *data = _data;
1296
1297 if (d_mountpoint(dentry)) {
1298 data->found = -EBUSY;
1299 return D_WALK_QUIT;
1300 }
1301
1302 return select_collect(_data, dentry);
1303}
1304
1305static void check_and_drop(void *_data)
1306{
1307 struct select_data *data = _data;
1308
1309 if (d_mountpoint(data->start))
1310 data->found = -EBUSY;
1311 if (!data->found)
1312 __d_drop(data->start);
1313}
1314
1315/**
1316 * check_submounts_and_drop - prune dcache, check for submounts and drop
1317 *
1318 * All done as a single atomic operation relative to has_unlinked_ancestor().
1319 * Returns 0 if successfully unhashed @parent. If there were submounts then
1320 * return -EBUSY.
1321 *
1322 * @dentry: dentry to prune and drop
1323 */
1324int check_submounts_and_drop(struct dentry *dentry)
1325{
1326 int ret = 0;
1327
1328 /* Negative dentries can be dropped without further checks */
1329 if (!dentry->d_inode) {
1330 d_drop(dentry);
1331 goto out;
1332 }
1333
1334 for (;;) {
1335 struct select_data data;
1336
1337 INIT_LIST_HEAD(&data.dispose);
1338 data.start = dentry;
1339 data.found = 0;
1340
1341 d_walk(dentry, &data, check_and_collect, check_and_drop);
1342 ret = data.found;
1343
1344 if (!list_empty(&data.dispose))
1345 shrink_dentry_list(&data.dispose);
1346
1347 if (ret <= 0)
1348 break;
1349
1350 cond_resched();
1351 }
1352
1353out:
1354 return ret;
1355}
1356EXPORT_SYMBOL(check_submounts_and_drop);
1357
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358/**
Al Viroa4464db2011-07-07 15:03:58 -04001359 * __d_alloc - allocate a dcache entry
1360 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 * @name: qstr of the name
1362 *
1363 * Allocates a dentry. It returns %NULL if there is insufficient memory
1364 * available. On a success the dentry is returned. The name passed in is
1365 * copied and the copy passed in may be reused after this call.
1366 */
1367
Al Viroa4464db2011-07-07 15:03:58 -04001368struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369{
1370 struct dentry *dentry;
1371 char *dname;
1372
Mel Gormane12ba742007-10-16 01:25:52 -07001373 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 if (!dentry)
1375 return NULL;
1376
Linus Torvalds6326c712012-05-21 16:14:04 -07001377 /*
1378 * We guarantee that the inline name is always NUL-terminated.
1379 * This way the memcpy() done by the name switching in rename
1380 * will still always have a NUL at the end, even if we might
1381 * be overwriting an internal NUL character
1382 */
1383 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 if (name->len > DNAME_INLINE_LEN-1) {
1385 dname = kmalloc(name->len + 1, GFP_KERNEL);
1386 if (!dname) {
1387 kmem_cache_free(dentry_cache, dentry);
1388 return NULL;
1389 }
1390 } else {
1391 dname = dentry->d_iname;
1392 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393
1394 dentry->d_name.len = name->len;
1395 dentry->d_name.hash = name->hash;
1396 memcpy(dname, name->name, name->len);
1397 dname[name->len] = 0;
1398
Linus Torvalds6326c712012-05-21 16:14:04 -07001399 /* Make sure we always see the terminating NUL character */
1400 smp_wmb();
1401 dentry->d_name.name = dname;
1402
Waiman Long98474232013-08-28 18:24:59 -07001403 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001404 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001406 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001408 dentry->d_parent = dentry;
1409 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 dentry->d_op = NULL;
1411 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001412 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 INIT_LIST_HEAD(&dentry->d_lru);
1414 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Virob3d9b7a2012-06-09 13:51:19 -04001415 INIT_HLIST_NODE(&dentry->d_alias);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001416 INIT_LIST_HEAD(&dentry->d_u.d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001417 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418
Nick Piggin3e880fb2011-01-07 17:49:19 +11001419 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001420
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 return dentry;
1422}
Al Viroa4464db2011-07-07 15:03:58 -04001423
1424/**
1425 * d_alloc - allocate a dcache entry
1426 * @parent: parent of entry to allocate
1427 * @name: qstr of the name
1428 *
1429 * Allocates a dentry. It returns %NULL if there is insufficient memory
1430 * available. On a success the dentry is returned. The name passed in is
1431 * copied and the copy passed in may be reused after this call.
1432 */
1433struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1434{
1435 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1436 if (!dentry)
1437 return NULL;
1438
1439 spin_lock(&parent->d_lock);
1440 /*
1441 * don't need child lock because it is not subject
1442 * to concurrency here
1443 */
1444 __dget_dlock(parent);
1445 dentry->d_parent = parent;
1446 list_add(&dentry->d_u.d_child, &parent->d_subdirs);
1447 spin_unlock(&parent->d_lock);
1448
1449 return dentry;
1450}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001451EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001453/**
1454 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1455 * @sb: the superblock
1456 * @name: qstr of the name
1457 *
1458 * For a filesystem that just pins its dentries in memory and never
1459 * performs lookups at all, return an unhashed IS_ROOT dentry.
1460 */
Nick Piggin4b936882011-01-07 17:50:07 +11001461struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1462{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001463 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001464}
1465EXPORT_SYMBOL(d_alloc_pseudo);
1466
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1468{
1469 struct qstr q;
1470
1471 q.name = name;
1472 q.len = strlen(name);
1473 q.hash = full_name_hash(q.name, q.len);
1474 return d_alloc(parent, &q);
1475}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001476EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477
Nick Pigginfb045ad2011-01-07 17:49:55 +11001478void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1479{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001480 WARN_ON_ONCE(dentry->d_op);
1481 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001482 DCACHE_OP_COMPARE |
1483 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001484 DCACHE_OP_WEAK_REVALIDATE |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001485 DCACHE_OP_DELETE ));
1486 dentry->d_op = op;
1487 if (!op)
1488 return;
1489 if (op->d_hash)
1490 dentry->d_flags |= DCACHE_OP_HASH;
1491 if (op->d_compare)
1492 dentry->d_flags |= DCACHE_OP_COMPARE;
1493 if (op->d_revalidate)
1494 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001495 if (op->d_weak_revalidate)
1496 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001497 if (op->d_delete)
1498 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001499 if (op->d_prune)
1500 dentry->d_flags |= DCACHE_OP_PRUNE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001501
1502}
1503EXPORT_SYMBOL(d_set_d_op);
1504
David Howellsb18825a2013-09-12 19:22:53 +01001505static unsigned d_flags_for_inode(struct inode *inode)
1506{
1507 unsigned add_flags = DCACHE_FILE_TYPE;
1508
1509 if (!inode)
1510 return DCACHE_MISS_TYPE;
1511
1512 if (S_ISDIR(inode->i_mode)) {
1513 add_flags = DCACHE_DIRECTORY_TYPE;
1514 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1515 if (unlikely(!inode->i_op->lookup))
1516 add_flags = DCACHE_AUTODIR_TYPE;
1517 else
1518 inode->i_opflags |= IOP_LOOKUP;
1519 }
1520 } else if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
1521 if (unlikely(inode->i_op->follow_link))
1522 add_flags = DCACHE_SYMLINK_TYPE;
1523 else
1524 inode->i_opflags |= IOP_NOFOLLOW;
1525 }
1526
1527 if (unlikely(IS_AUTOMOUNT(inode)))
1528 add_flags |= DCACHE_NEED_AUTOMOUNT;
1529 return add_flags;
1530}
1531
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001532static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1533{
David Howellsb18825a2013-09-12 19:22:53 +01001534 unsigned add_flags = d_flags_for_inode(inode);
1535
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001536 spin_lock(&dentry->d_lock);
Al Viro22213312014-04-19 12:30:58 -04001537 __d_set_type(dentry, add_flags);
David Howellsb18825a2013-09-12 19:22:53 +01001538 if (inode)
Al Virob3d9b7a2012-06-09 13:51:19 -04001539 hlist_add_head(&dentry->d_alias, &inode->i_dentry);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001540 dentry->d_inode = inode;
Nick Piggin31e6b012011-01-07 17:49:52 +11001541 dentry_rcuwalk_barrier(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001542 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001543 fsnotify_d_instantiate(dentry, inode);
1544}
1545
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546/**
1547 * d_instantiate - fill in inode information for a dentry
1548 * @entry: dentry to complete
1549 * @inode: inode to attach to this dentry
1550 *
1551 * Fill in inode information in the entry.
1552 *
1553 * This turns negative dentries into productive full members
1554 * of society.
1555 *
1556 * NOTE! This assumes that the inode count has been incremented
1557 * (or otherwise set) by the caller to indicate that it is now
1558 * in use by the dcache.
1559 */
1560
1561void d_instantiate(struct dentry *entry, struct inode * inode)
1562{
Al Virob3d9b7a2012-06-09 13:51:19 -04001563 BUG_ON(!hlist_unhashed(&entry->d_alias));
Nick Piggin873feea2011-01-07 17:50:06 +11001564 if (inode)
1565 spin_lock(&inode->i_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001566 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001567 if (inode)
1568 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 security_d_instantiate(entry, inode);
1570}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001571EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572
1573/**
1574 * d_instantiate_unique - instantiate a non-aliased dentry
1575 * @entry: dentry to instantiate
1576 * @inode: inode to attach to this dentry
1577 *
1578 * Fill in inode information in the entry. On success, it returns NULL.
1579 * If an unhashed alias of "entry" already exists, then we return the
Oleg Drokine866cfa2006-01-09 20:52:51 -08001580 * aliased dentry instead and drop one reference to inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 *
1582 * Note that in order to avoid conflicts with rename() etc, the caller
1583 * had better be holding the parent directory semaphore.
Oleg Drokine866cfa2006-01-09 20:52:51 -08001584 *
1585 * This also assumes that the inode count has been incremented
1586 * (or otherwise set) by the caller to indicate that it is now
1587 * in use by the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 */
David Howells770bfad2006-08-22 20:06:07 -04001589static struct dentry *__d_instantiate_unique(struct dentry *entry,
1590 struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591{
1592 struct dentry *alias;
1593 int len = entry->d_name.len;
1594 const char *name = entry->d_name.name;
1595 unsigned int hash = entry->d_name.hash;
1596
David Howells770bfad2006-08-22 20:06:07 -04001597 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001598 __d_instantiate(entry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001599 return NULL;
1600 }
1601
Sasha Levinb67bfe02013-02-27 17:06:00 -08001602 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Piggin9abca362011-01-07 17:49:36 +11001603 /*
1604 * Don't need alias->d_lock here, because aliases with
1605 * d_parent == entry->d_parent are not subject to name or
1606 * parent changes, because the parent inode i_mutex is held.
1607 */
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001608 if (alias->d_name.hash != hash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 continue;
1610 if (alias->d_parent != entry->d_parent)
1611 continue;
Linus Torvaldsee983e82012-05-10 12:37:10 -07001612 if (alias->d_name.len != len)
1613 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001614 if (dentry_cmp(alias, name, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 continue;
Nick Piggindc0474b2011-01-07 17:49:43 +11001616 __dget(alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 return alias;
1618 }
David Howells770bfad2006-08-22 20:06:07 -04001619
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001620 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 return NULL;
1622}
David Howells770bfad2006-08-22 20:06:07 -04001623
1624struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1625{
1626 struct dentry *result;
1627
Al Virob3d9b7a2012-06-09 13:51:19 -04001628 BUG_ON(!hlist_unhashed(&entry->d_alias));
David Howells770bfad2006-08-22 20:06:07 -04001629
Nick Piggin873feea2011-01-07 17:50:06 +11001630 if (inode)
1631 spin_lock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001632 result = __d_instantiate_unique(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001633 if (inode)
1634 spin_unlock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001635
1636 if (!result) {
1637 security_d_instantiate(entry, inode);
1638 return NULL;
1639 }
1640
1641 BUG_ON(!d_unhashed(result));
1642 iput(inode);
1643 return result;
1644}
1645
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646EXPORT_SYMBOL(d_instantiate_unique);
1647
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001648/**
1649 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1650 * @entry: dentry to complete
1651 * @inode: inode to attach to this dentry
1652 *
1653 * Fill in inode information in the entry. If a directory alias is found, then
1654 * return an error (and drop inode). Together with d_materialise_unique() this
1655 * guarantees that a directory inode may never have more than one alias.
1656 */
1657int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1658{
1659 BUG_ON(!hlist_unhashed(&entry->d_alias));
1660
1661 spin_lock(&inode->i_lock);
1662 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1663 spin_unlock(&inode->i_lock);
1664 iput(inode);
1665 return -EBUSY;
1666 }
1667 __d_instantiate(entry, inode);
1668 spin_unlock(&inode->i_lock);
1669 security_d_instantiate(entry, inode);
1670
1671 return 0;
1672}
1673EXPORT_SYMBOL(d_instantiate_no_diralias);
1674
Al Viroadc0e912012-01-08 16:49:21 -05001675struct dentry *d_make_root(struct inode *root_inode)
1676{
1677 struct dentry *res = NULL;
1678
1679 if (root_inode) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07001680 static const struct qstr name = QSTR_INIT("/", 1);
Al Viroadc0e912012-01-08 16:49:21 -05001681
1682 res = __d_alloc(root_inode->i_sb, &name);
1683 if (res)
1684 d_instantiate(res, root_inode);
1685 else
1686 iput(root_inode);
1687 }
1688 return res;
1689}
1690EXPORT_SYMBOL(d_make_root);
1691
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001692static struct dentry * __d_find_any_alias(struct inode *inode)
1693{
1694 struct dentry *alias;
1695
Al Virob3d9b7a2012-06-09 13:51:19 -04001696 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001697 return NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001698 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001699 __dget(alias);
1700 return alias;
1701}
1702
Sage Weil46f72b32012-01-10 09:04:37 -08001703/**
1704 * d_find_any_alias - find any alias for a given inode
1705 * @inode: inode to find an alias for
1706 *
1707 * If any aliases exist for the given inode, take and return a
1708 * reference for one of them. If no aliases exist, return %NULL.
1709 */
1710struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001711{
1712 struct dentry *de;
1713
1714 spin_lock(&inode->i_lock);
1715 de = __d_find_any_alias(inode);
1716 spin_unlock(&inode->i_lock);
1717 return de;
1718}
Sage Weil46f72b32012-01-10 09:04:37 -08001719EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001720
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721/**
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001722 * d_obtain_alias - find or allocate a dentry for a given inode
1723 * @inode: inode to allocate the dentry for
1724 *
1725 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1726 * similar open by handle operations. The returned dentry may be anonymous,
1727 * or may have a full name (if the inode was already in the cache).
1728 *
1729 * When called on a directory inode, we must ensure that the inode only ever
1730 * has one dentry. If a dentry is found, that is returned instead of
1731 * allocating a new one.
1732 *
1733 * On successful return, the reference to the inode has been transferred
Christoph Hellwig44003722008-08-11 15:49:04 +02001734 * to the dentry. In case of an error the reference on the inode is released.
1735 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1736 * be passed in and will be the error will be propagate to the return value,
1737 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001738 */
1739struct dentry *d_obtain_alias(struct inode *inode)
1740{
NeilBrownb911a6b2012-11-08 16:09:37 -08001741 static const struct qstr anonstring = QSTR_INIT("/", 1);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001742 struct dentry *tmp;
1743 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001744 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001745
1746 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001747 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001748 if (IS_ERR(inode))
1749 return ERR_CAST(inode);
1750
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001751 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001752 if (res)
1753 goto out_iput;
1754
Al Viroa4464db2011-07-07 15:03:58 -04001755 tmp = __d_alloc(inode->i_sb, &anonstring);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001756 if (!tmp) {
1757 res = ERR_PTR(-ENOMEM);
1758 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001759 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001760
Nick Piggin873feea2011-01-07 17:50:06 +11001761 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001762 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001763 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001764 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001765 dput(tmp);
1766 goto out_iput;
1767 }
1768
1769 /* attach a disconnected dentry */
David Howellsb18825a2013-09-12 19:22:53 +01001770 add_flags = d_flags_for_inode(inode) | DCACHE_DISCONNECTED;
1771
Christoph Hellwig9308a612008-08-11 15:49:12 +02001772 spin_lock(&tmp->d_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001773 tmp->d_inode = inode;
David Howellsb18825a2013-09-12 19:22:53 +01001774 tmp->d_flags |= add_flags;
Al Virob3d9b7a2012-06-09 13:51:19 -04001775 hlist_add_head(&tmp->d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001776 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001777 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001778 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001779 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001780 spin_unlock(&inode->i_lock);
Josef Bacik24ff6662010-11-18 20:52:55 -05001781 security_d_instantiate(tmp, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001782
Christoph Hellwig9308a612008-08-11 15:49:12 +02001783 return tmp;
1784
1785 out_iput:
Josef Bacik24ff6662010-11-18 20:52:55 -05001786 if (res && !IS_ERR(res))
1787 security_d_instantiate(res, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001788 iput(inode);
1789 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001790}
Benny Halevyadc48722009-02-27 14:02:59 -08001791EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792
1793/**
1794 * d_splice_alias - splice a disconnected dentry into the tree if one exists
1795 * @inode: the inode which may have a disconnected dentry
1796 * @dentry: a negative dentry which we want to point to the inode.
1797 *
1798 * If inode is a directory and has a 'disconnected' dentry (i.e. IS_ROOT and
1799 * DCACHE_DISCONNECTED), then d_move that in place of the given dentry
1800 * and return it, else simply d_add the inode to the dentry and return NULL.
1801 *
1802 * This is needed in the lookup routine of any filesystem that is exportable
1803 * (via knfsd) so that we can build dcache paths to directories effectively.
1804 *
1805 * If a dentry was found and moved, then it is returned. Otherwise NULL
1806 * is returned. This matches the expected return value of ->lookup.
1807 *
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001808 * Cluster filesystems may call this function with a negative, hashed dentry.
1809 * In that case, we know that the inode will be a regular file, and also this
1810 * will only occur during atomic_open. So we need to check for the dentry
1811 * being already hashed only in the final case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 */
1813struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
1814{
1815 struct dentry *new = NULL;
1816
Al Viroa9049372011-07-08 21:20:11 -04001817 if (IS_ERR(inode))
1818 return ERR_CAST(inode);
1819
NeilBrown21c0d8f2006-10-04 02:16:16 -07001820 if (inode && S_ISDIR(inode->i_mode)) {
Nick Piggin873feea2011-01-07 17:50:06 +11001821 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001822 new = __d_find_alias(inode, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 if (new) {
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001824 BUG_ON(!(new->d_flags & DCACHE_DISCONNECTED));
Nick Piggin873feea2011-01-07 17:50:06 +11001825 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 security_d_instantiate(new, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827 d_move(new, dentry);
1828 iput(inode);
1829 } else {
Nick Piggin873feea2011-01-07 17:50:06 +11001830 /* already taking inode->i_lock, so d_add() by hand */
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001831 __d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001832 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833 security_d_instantiate(dentry, inode);
1834 d_rehash(dentry);
1835 }
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001836 } else {
1837 d_instantiate(dentry, inode);
1838 if (d_unhashed(dentry))
1839 d_rehash(dentry);
1840 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 return new;
1842}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001843EXPORT_SYMBOL(d_splice_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844
Barry Naujok94035402008-05-21 16:50:46 +10001845/**
1846 * d_add_ci - lookup or allocate new dentry with case-exact name
1847 * @inode: the inode case-insensitive lookup has found
1848 * @dentry: the negative dentry that was passed to the parent's lookup func
1849 * @name: the case-exact name to be associated with the returned dentry
1850 *
1851 * This is to avoid filling the dcache with case-insensitive names to the
1852 * same inode, only the actual correct case is stored in the dcache for
1853 * case-insensitive filesystems.
1854 *
1855 * For a case-insensitive lookup match and if the the case-exact dentry
1856 * already exists in in the dcache, use it and return it.
1857 *
1858 * If no entry exists with the exact case name, allocate new dentry with
1859 * the exact case, and return the spliced entry.
1860 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001861struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001862 struct qstr *name)
1863{
Barry Naujok94035402008-05-21 16:50:46 +10001864 struct dentry *found;
1865 struct dentry *new;
1866
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001867 /*
1868 * First check if a dentry matching the name already exists,
1869 * if not go ahead and create it now.
1870 */
Barry Naujok94035402008-05-21 16:50:46 +10001871 found = d_hash_and_lookup(dentry->d_parent, name);
Al Viro4f522a22013-02-11 23:20:37 -05001872 if (unlikely(IS_ERR(found)))
1873 goto err_out;
Barry Naujok94035402008-05-21 16:50:46 +10001874 if (!found) {
1875 new = d_alloc(dentry->d_parent, name);
1876 if (!new) {
Al Viro4f522a22013-02-11 23:20:37 -05001877 found = ERR_PTR(-ENOMEM);
Barry Naujok94035402008-05-21 16:50:46 +10001878 goto err_out;
1879 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001880
Barry Naujok94035402008-05-21 16:50:46 +10001881 found = d_splice_alias(inode, new);
1882 if (found) {
1883 dput(new);
1884 return found;
1885 }
1886 return new;
1887 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001888
1889 /*
1890 * If a matching dentry exists, and it's not negative use it.
1891 *
1892 * Decrement the reference count to balance the iget() done
1893 * earlier on.
1894 */
Barry Naujok94035402008-05-21 16:50:46 +10001895 if (found->d_inode) {
1896 if (unlikely(found->d_inode != inode)) {
1897 /* This can't happen because bad inodes are unhashed. */
1898 BUG_ON(!is_bad_inode(inode));
1899 BUG_ON(!is_bad_inode(found->d_inode));
1900 }
Barry Naujok94035402008-05-21 16:50:46 +10001901 iput(inode);
1902 return found;
1903 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001904
Barry Naujok94035402008-05-21 16:50:46 +10001905 /*
1906 * Negative dentry: instantiate it unless the inode is a directory and
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001907 * already has a dentry.
Barry Naujok94035402008-05-21 16:50:46 +10001908 */
Al Viro4513d892011-07-17 10:52:14 -04001909 new = d_splice_alias(inode, found);
1910 if (new) {
1911 dput(found);
1912 found = new;
Barry Naujok94035402008-05-21 16:50:46 +10001913 }
Al Viro4513d892011-07-17 10:52:14 -04001914 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001915
1916err_out:
1917 iput(inode);
Al Viro4f522a22013-02-11 23:20:37 -05001918 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001919}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001920EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001922/*
1923 * Do the slow-case of the dentry name compare.
1924 *
1925 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07001926 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001927 * filesystem can rely on them, and can use the 'name' and
1928 * 'len' information without worrying about walking off the
1929 * end of memory etc.
1930 *
1931 * Thus the read_seqcount_retry() and the "duplicate" info
1932 * in arguments (the low-level filesystem should not look
1933 * at the dentry inode or name contents directly, since
1934 * rename can change them while we're in RCU mode).
1935 */
1936enum slow_d_compare {
1937 D_COMP_OK,
1938 D_COMP_NOMATCH,
1939 D_COMP_SEQRETRY,
1940};
1941
1942static noinline enum slow_d_compare slow_dentry_cmp(
1943 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001944 struct dentry *dentry,
1945 unsigned int seq,
1946 const struct qstr *name)
1947{
1948 int tlen = dentry->d_name.len;
1949 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001950
1951 if (read_seqcount_retry(&dentry->d_seq, seq)) {
1952 cpu_relax();
1953 return D_COMP_SEQRETRY;
1954 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07001955 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001956 return D_COMP_NOMATCH;
1957 return D_COMP_OK;
1958}
1959
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960/**
Nick Piggin31e6b012011-01-07 17:49:52 +11001961 * __d_lookup_rcu - search for a dentry (racy, store-free)
1962 * @parent: parent dentry
1963 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07001964 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11001965 * Returns: dentry, or NULL
1966 *
1967 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
1968 * resolution (store-free path walking) design described in
1969 * Documentation/filesystems/path-lookup.txt.
1970 *
1971 * This is not to be used outside core vfs.
1972 *
1973 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
1974 * held, and rcu_read_lock held. The returned dentry must not be stored into
1975 * without taking d_lock and checking d_seq sequence count against @seq
1976 * returned here.
1977 *
Linus Torvalds15570082013-09-02 11:38:06 -07001978 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11001979 * function.
1980 *
1981 * Alternatively, __d_lookup_rcu may be called again to look up the child of
1982 * the returned dentry, so long as its parent's seqlock is checked after the
1983 * child is looked up. Thus, an interlocking stepping of sequence lock checks
1984 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001985 *
1986 * NOTE! The caller *has* to check the resulting dentry against the sequence
1987 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11001988 */
Linus Torvalds8966be92012-03-02 14:23:30 -08001989struct dentry *__d_lookup_rcu(const struct dentry *parent,
1990 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07001991 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11001992{
Linus Torvalds26fe5752012-05-10 13:14:12 -07001993 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11001994 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07001995 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001996 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11001997 struct dentry *dentry;
1998
1999 /*
2000 * Note: There is significant duplication with __d_lookup_rcu which is
2001 * required to prevent single threaded performance regressions
2002 * especially on architectures where smp_rmb (in seqcounts) are costly.
2003 * Keep the two functions in sync.
2004 */
2005
2006 /*
2007 * The hash list is protected using RCU.
2008 *
2009 * Carefully use d_seq when comparing a candidate dentry, to avoid
2010 * races with d_move().
2011 *
2012 * It is possible that concurrent renames can mess up our list
2013 * walk here and result in missing our dentry, resulting in the
2014 * false-negative result. d_lookup() protects against concurrent
2015 * renames using rename_lock seqlock.
2016 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002017 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002018 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002019 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002020 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002021
Nick Piggin31e6b012011-01-07 17:49:52 +11002022seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002023 /*
2024 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002025 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002026 *
2027 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002028 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002029 *
2030 * NOTE! We do a "raw" seqcount_begin here. That means that
2031 * we don't wait for the sequence count to stabilize if it
2032 * is in the middle of a sequence change. If we do the slow
2033 * dentry compare, we will do seqretries until it is stable,
2034 * and if we end up with a successful lookup, we actually
2035 * want to exit RCU lookup anyway.
2036 */
2037 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002038 if (dentry->d_parent != parent)
2039 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002040 if (d_unhashed(dentry))
2041 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002042
2043 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002044 if (dentry->d_name.hash != hashlen_hash(hashlen))
2045 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002046 *seqp = seq;
2047 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002048 case D_COMP_OK:
2049 return dentry;
2050 case D_COMP_NOMATCH:
2051 continue;
2052 default:
2053 goto seqretry;
2054 }
2055 }
2056
Linus Torvalds26fe5752012-05-10 13:14:12 -07002057 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002058 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002059 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002060 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002061 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002062 }
2063 return NULL;
2064}
2065
2066/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 * d_lookup - search for a dentry
2068 * @parent: parent dentry
2069 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002070 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002072 * d_lookup searches the children of the parent dentry for the name in
2073 * question. If the dentry is found its reference count is incremented and the
2074 * dentry is returned. The caller must use dput to free the entry when it has
2075 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076 */
Al Viroda2d8452013-01-24 18:29:34 -05002077struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078{
Nick Piggin31e6b012011-01-07 17:49:52 +11002079 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002080 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081
2082 do {
2083 seq = read_seqbegin(&rename_lock);
2084 dentry = __d_lookup(parent, name);
2085 if (dentry)
2086 break;
2087 } while (read_seqretry(&rename_lock, seq));
2088 return dentry;
2089}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002090EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091
Nick Piggin31e6b012011-01-07 17:49:52 +11002092/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002093 * __d_lookup - search for a dentry (racy)
2094 * @parent: parent dentry
2095 * @name: qstr of name we wish to find
2096 * Returns: dentry, or NULL
2097 *
2098 * __d_lookup is like d_lookup, however it may (rarely) return a
2099 * false-negative result due to unrelated rename activity.
2100 *
2101 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2102 * however it must be used carefully, eg. with a following d_lookup in
2103 * the case of failure.
2104 *
2105 * __d_lookup callers must be commented.
2106 */
Al Viroa713ca22013-01-24 18:27:00 -05002107struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108{
2109 unsigned int len = name->len;
2110 unsigned int hash = name->hash;
2111 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002112 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002113 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002114 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002115 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116
Nick Pigginb04f7842010-08-18 04:37:34 +10002117 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002118 * Note: There is significant duplication with __d_lookup_rcu which is
2119 * required to prevent single threaded performance regressions
2120 * especially on architectures where smp_rmb (in seqcounts) are costly.
2121 * Keep the two functions in sync.
2122 */
2123
2124 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002125 * The hash list is protected using RCU.
2126 *
2127 * Take d_lock when comparing a candidate dentry, to avoid races
2128 * with d_move().
2129 *
2130 * It is possible that concurrent renames can mess up our list
2131 * walk here and result in missing our dentry, resulting in the
2132 * false-negative result. d_lookup() protects against concurrent
2133 * renames using rename_lock seqlock.
2134 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002135 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002136 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 rcu_read_lock();
2138
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002139 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 if (dentry->d_name.hash != hash)
2142 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143
2144 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145 if (dentry->d_parent != parent)
2146 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002147 if (d_unhashed(dentry))
2148 goto next;
2149
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 /*
2151 * It is safe to compare names since d_move() cannot
2152 * change the qstr (protected by d_lock).
2153 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002154 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002155 int tlen = dentry->d_name.len;
2156 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002157 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 goto next;
2159 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002160 if (dentry->d_name.len != len)
2161 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002162 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163 goto next;
2164 }
2165
Waiman Long98474232013-08-28 18:24:59 -07002166 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002167 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 spin_unlock(&dentry->d_lock);
2169 break;
2170next:
2171 spin_unlock(&dentry->d_lock);
2172 }
2173 rcu_read_unlock();
2174
2175 return found;
2176}
2177
2178/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002179 * d_hash_and_lookup - hash the qstr then search for a dentry
2180 * @dir: Directory to search in
2181 * @name: qstr of name we wish to find
2182 *
Al Viro4f522a22013-02-11 23:20:37 -05002183 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002184 */
2185struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2186{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002187 /*
2188 * Check for a fs-specific hash function. Note that we must
2189 * calculate the standard hash first, as the d_op->d_hash()
2190 * routine may choose to leave the hash value unchanged.
2191 */
2192 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002193 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002194 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002195 if (unlikely(err < 0))
2196 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002197 }
Al Viro4f522a22013-02-11 23:20:37 -05002198 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002199}
Al Viro4f522a22013-02-11 23:20:37 -05002200EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002201
2202/**
Nick Piggin786a5e12011-01-07 17:49:16 +11002203 * d_validate - verify dentry provided from insecure source (deprecated)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 * @dentry: The dentry alleged to be valid child of @dparent
Randy Dunlapff5fdb62011-01-22 20:16:06 -08002205 * @dparent: The parent dentry (known to be valid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206 *
2207 * An insecure source has sent us a dentry, here we verify it and dget() it.
2208 * This is used by ncpfs in its readdir implementation.
2209 * Zero is returned in the dentry is invalid.
Nick Piggin786a5e12011-01-07 17:49:16 +11002210 *
2211 * This function is slow for big directories, and deprecated, do not use it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 */
Nick Piggind3a23e12011-01-05 20:01:21 +11002213int d_validate(struct dentry *dentry, struct dentry *dparent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214{
Nick Piggin786a5e12011-01-07 17:49:16 +11002215 struct dentry *child;
Nick Piggind3a23e12011-01-05 20:01:21 +11002216
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002217 spin_lock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002218 list_for_each_entry(child, &dparent->d_subdirs, d_u.d_child) {
2219 if (dentry == child) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002220 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Nick Piggindc0474b2011-01-07 17:49:43 +11002221 __dget_dlock(dentry);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002222 spin_unlock(&dentry->d_lock);
2223 spin_unlock(&dparent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 return 1;
2225 }
2226 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002227 spin_unlock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002228
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229 return 0;
2230}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002231EXPORT_SYMBOL(d_validate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232
2233/*
2234 * When a file is deleted, we have two options:
2235 * - turn this dentry into a negative dentry
2236 * - unhash this dentry and free it.
2237 *
2238 * Usually, we want to just turn this into
2239 * a negative dentry, but if anybody else is
2240 * currently using the dentry or the inode
2241 * we can't do that and we fall back on removing
2242 * it from the hash queues and waiting for
2243 * it to be deleted later when it has no users
2244 */
2245
2246/**
2247 * d_delete - delete a dentry
2248 * @dentry: The dentry to delete
2249 *
2250 * Turn the dentry into a negative dentry if possible, otherwise
2251 * remove it from the hash queues so it can be deleted later
2252 */
2253
2254void d_delete(struct dentry * dentry)
2255{
Nick Piggin873feea2011-01-07 17:50:06 +11002256 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002257 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 /*
2259 * Are we the only user?
2260 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002261again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002263 inode = dentry->d_inode;
2264 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002265 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002266 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002267 spin_unlock(&dentry->d_lock);
2268 cpu_relax();
2269 goto again;
2270 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002271 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002272 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002273 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274 return;
2275 }
2276
2277 if (!d_unhashed(dentry))
2278 __d_drop(dentry);
2279
2280 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002281
2282 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002284EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002286static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002288 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002289 hlist_bl_lock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -07002290 entry->d_flags |= DCACHE_RCUACCESS;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002291 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002292 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293}
2294
David Howells770bfad2006-08-22 20:06:07 -04002295static void _d_rehash(struct dentry * entry)
2296{
2297 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2298}
2299
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300/**
2301 * d_rehash - add an entry back to the hash
2302 * @entry: dentry to add to the hash
2303 *
2304 * Adds a dentry to the hash according to its name.
2305 */
2306
2307void d_rehash(struct dentry * entry)
2308{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002310 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002313EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002315/**
2316 * dentry_update_name_case - update case insensitive dentry with a new name
2317 * @dentry: dentry to be updated
2318 * @name: new name
2319 *
2320 * Update a case insensitive dentry with new case of name.
2321 *
2322 * dentry must have been returned by d_lookup with name @name. Old and new
2323 * name lengths must match (ie. no d_compare which allows mismatched name
2324 * lengths).
2325 *
2326 * Parent inode i_mutex must be held over d_lookup and into this call (to
2327 * keep renames and concurrent inserts, and readdir(2) away).
2328 */
2329void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2330{
Linus Torvalds7ebfa572011-04-15 07:34:26 -07002331 BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002332 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2333
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002334 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002335 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002336 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002337 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002338 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002339}
2340EXPORT_SYMBOL(dentry_update_name_case);
2341
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342static void switch_names(struct dentry *dentry, struct dentry *target)
2343{
2344 if (dname_external(target)) {
2345 if (dname_external(dentry)) {
2346 /*
2347 * Both external: swap the pointers
2348 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002349 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350 } else {
2351 /*
2352 * dentry:internal, target:external. Steal target's
2353 * storage and make target internal.
2354 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002355 memcpy(target->d_iname, dentry->d_name.name,
2356 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357 dentry->d_name.name = target->d_name.name;
2358 target->d_name.name = target->d_iname;
2359 }
2360 } else {
2361 if (dname_external(dentry)) {
2362 /*
2363 * dentry:external, target:internal. Give dentry's
2364 * storage to target and make dentry internal
2365 */
2366 memcpy(dentry->d_iname, target->d_name.name,
2367 target->d_name.len + 1);
2368 target->d_name.name = dentry->d_name.name;
2369 dentry->d_name.name = dentry->d_iname;
2370 } else {
2371 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002372 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002374 unsigned int i;
2375 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2376 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2377 swap(((long *) &dentry->d_iname)[i],
2378 ((long *) &target->d_iname)[i]);
2379 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380 }
2381 }
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002382 swap(dentry->d_name.len, target->d_name.len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383}
2384
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002385static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2386{
2387 /*
2388 * XXXX: do we really need to take target->d_lock?
2389 */
2390 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2391 spin_lock(&target->d_parent->d_lock);
2392 else {
2393 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2394 spin_lock(&dentry->d_parent->d_lock);
2395 spin_lock_nested(&target->d_parent->d_lock,
2396 DENTRY_D_LOCK_NESTED);
2397 } else {
2398 spin_lock(&target->d_parent->d_lock);
2399 spin_lock_nested(&dentry->d_parent->d_lock,
2400 DENTRY_D_LOCK_NESTED);
2401 }
2402 }
2403 if (target < dentry) {
2404 spin_lock_nested(&target->d_lock, 2);
2405 spin_lock_nested(&dentry->d_lock, 3);
2406 } else {
2407 spin_lock_nested(&dentry->d_lock, 2);
2408 spin_lock_nested(&target->d_lock, 3);
2409 }
2410}
2411
2412static void dentry_unlock_parents_for_move(struct dentry *dentry,
2413 struct dentry *target)
2414{
2415 if (target->d_parent != dentry->d_parent)
2416 spin_unlock(&dentry->d_parent->d_lock);
2417 if (target->d_parent != target)
2418 spin_unlock(&target->d_parent->d_lock);
2419}
2420
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002422 * When switching names, the actual string doesn't strictly have to
2423 * be preserved in the target - because we're dropping the target
2424 * anyway. As such, we can just do a simple memcpy() to copy over
2425 * the new name before we switch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002426 *
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002427 * Note that we have to be a lot more careful about getting the hash
2428 * switched - we have to switch the hash value properly even if it
2429 * then no longer matches the actual (corrupted) string of the target.
2430 * The hash value has to match the hash queue that the dentry is on..
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002432/*
Al Viro18367502011-07-12 21:42:24 -04002433 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434 * @dentry: entry to move
2435 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002436 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002437 *
2438 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002439 * dcache entries should not be moved in this way. Caller must hold
2440 * rename_lock, the i_mutex of the source and target directories,
2441 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002443static void __d_move(struct dentry *dentry, struct dentry *target,
2444 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446 if (!dentry->d_inode)
2447 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2448
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002449 BUG_ON(d_ancestor(dentry, target));
2450 BUG_ON(d_ancestor(target, dentry));
2451
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002452 dentry_lock_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453
Nick Piggin31e6b012011-01-07 17:49:52 +11002454 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002455 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002456
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002457 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2458
2459 /*
2460 * Move the dentry to the target hash queue. Don't bother checking
2461 * for the same hash queue because of how unlikely it is.
2462 */
2463 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002464 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465
Miklos Szeredida1ce062014-04-01 17:08:43 +02002466 /*
2467 * Unhash the target (d_delete() is not usable here). If exchanging
2468 * the two dentries, then rehash onto the other's hash queue.
2469 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470 __d_drop(target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002471 if (exchange) {
2472 __d_rehash(target,
2473 d_hash(dentry->d_parent, dentry->d_name.hash));
2474 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475
Eric Dumazet5160ee62006-01-08 01:03:32 -08002476 list_del(&dentry->d_u.d_child);
2477 list_del(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478
2479 /* Switch the names.. */
2480 switch_names(dentry, target);
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002481 swap(dentry->d_name.hash, target->d_name.hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482
2483 /* ... and switch the parents */
2484 if (IS_ROOT(dentry)) {
2485 dentry->d_parent = target->d_parent;
2486 target->d_parent = target;
Eric Dumazet5160ee62006-01-08 01:03:32 -08002487 INIT_LIST_HEAD(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488 } else {
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002489 swap(dentry->d_parent, target->d_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490
2491 /* And add them back to the (new) parent lists */
Eric Dumazet5160ee62006-01-08 01:03:32 -08002492 list_add(&target->d_u.d_child, &target->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493 }
2494
Eric Dumazet5160ee62006-01-08 01:03:32 -08002495 list_add(&dentry->d_u.d_child, &dentry->d_parent->d_subdirs);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002496
Nick Piggin31e6b012011-01-07 17:49:52 +11002497 write_seqcount_end(&target->d_seq);
2498 write_seqcount_end(&dentry->d_seq);
2499
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002500 dentry_unlock_parents_for_move(dentry, target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002501 if (exchange)
2502 fsnotify_d_move(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002503 spin_unlock(&target->d_lock);
Nick Pigginc32ccd82006-03-25 03:07:09 -08002504 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002505 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002506}
2507
2508/*
2509 * d_move - move a dentry
2510 * @dentry: entry to move
2511 * @target: new dentry
2512 *
2513 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002514 * dcache entries should not be moved in this way. See the locking
2515 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002516 */
2517void d_move(struct dentry *dentry, struct dentry *target)
2518{
2519 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002520 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002522}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002523EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002524
Miklos Szeredida1ce062014-04-01 17:08:43 +02002525/*
2526 * d_exchange - exchange two dentries
2527 * @dentry1: first dentry
2528 * @dentry2: second dentry
2529 */
2530void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2531{
2532 write_seqlock(&rename_lock);
2533
2534 WARN_ON(!dentry1->d_inode);
2535 WARN_ON(!dentry2->d_inode);
2536 WARN_ON(IS_ROOT(dentry1));
2537 WARN_ON(IS_ROOT(dentry2));
2538
2539 __d_move(dentry1, dentry2, true);
2540
2541 write_sequnlock(&rename_lock);
2542}
2543
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002544/**
2545 * d_ancestor - search for an ancestor
2546 * @p1: ancestor dentry
2547 * @p2: child dentry
2548 *
2549 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2550 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002551 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002552struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002553{
2554 struct dentry *p;
2555
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002556 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002557 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002558 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002559 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002560 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002561}
2562
2563/*
2564 * This helper attempts to cope with remotely renamed directories
2565 *
2566 * It assumes that the caller is already holding
Al Viro18367502011-07-12 21:42:24 -04002567 * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002568 *
2569 * Note: If ever the locking in lock_rename() changes, then please
2570 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002571 */
Nick Piggin873feea2011-01-07 17:50:06 +11002572static struct dentry *__d_unalias(struct inode *inode,
2573 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002574{
2575 struct mutex *m1 = NULL, *m2 = NULL;
Al Viroee3efa92012-06-08 15:59:33 -04002576 struct dentry *ret = ERR_PTR(-EBUSY);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002577
2578 /* If alias and dentry share a parent, then no extra locks required */
2579 if (alias->d_parent == dentry->d_parent)
2580 goto out_unalias;
2581
Trond Myklebust9eaef272006-10-21 10:24:20 -07002582 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002583 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2584 goto out_err;
2585 m1 = &dentry->d_sb->s_vfs_rename_mutex;
2586 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
2587 goto out_err;
2588 m2 = &alias->d_parent->d_inode->i_mutex;
2589out_unalias:
Al Viroee3efa92012-06-08 15:59:33 -04002590 if (likely(!d_mountpoint(alias))) {
Miklos Szeredida1ce062014-04-01 17:08:43 +02002591 __d_move(alias, dentry, false);
Al Viroee3efa92012-06-08 15:59:33 -04002592 ret = alias;
2593 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002594out_err:
Nick Piggin873feea2011-01-07 17:50:06 +11002595 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002596 if (m2)
2597 mutex_unlock(m2);
2598 if (m1)
2599 mutex_unlock(m1);
2600 return ret;
2601}
2602
2603/*
David Howells770bfad2006-08-22 20:06:07 -04002604 * Prepare an anonymous dentry for life in the superblock's dentry tree as a
2605 * named dentry in place of the dentry to be replaced.
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002606 * returns with anon->d_lock held!
David Howells770bfad2006-08-22 20:06:07 -04002607 */
2608static void __d_materialise_dentry(struct dentry *dentry, struct dentry *anon)
2609{
Al Viro740da422013-01-30 10:13:38 -05002610 struct dentry *dparent;
David Howells770bfad2006-08-22 20:06:07 -04002611
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002612 dentry_lock_for_move(anon, dentry);
David Howells770bfad2006-08-22 20:06:07 -04002613
Nick Piggin31e6b012011-01-07 17:49:52 +11002614 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002615 write_seqcount_begin_nested(&anon->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002616
David Howells770bfad2006-08-22 20:06:07 -04002617 dparent = dentry->d_parent;
David Howells770bfad2006-08-22 20:06:07 -04002618
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002619 switch_names(dentry, anon);
2620 swap(dentry->d_name.hash, anon->d_name.hash);
2621
Al Viro740da422013-01-30 10:13:38 -05002622 dentry->d_parent = dentry;
2623 list_del_init(&dentry->d_u.d_child);
2624 anon->d_parent = dparent;
Wei Yongjun9ed53b12013-03-12 00:10:50 +08002625 list_move(&anon->d_u.d_child, &dparent->d_subdirs);
David Howells770bfad2006-08-22 20:06:07 -04002626
Nick Piggin31e6b012011-01-07 17:49:52 +11002627 write_seqcount_end(&dentry->d_seq);
2628 write_seqcount_end(&anon->d_seq);
2629
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002630 dentry_unlock_parents_for_move(anon, dentry);
2631 spin_unlock(&dentry->d_lock);
2632
2633 /* anon->d_lock still locked, returns locked */
David Howells770bfad2006-08-22 20:06:07 -04002634}
2635
2636/**
2637 * d_materialise_unique - introduce an inode into the tree
2638 * @dentry: candidate dentry
2639 * @inode: inode to bind to the dentry, to which aliases may be attached
2640 *
2641 * Introduces an dentry into the tree, substituting an extant disconnected
Jeff Laytonc46c8872011-07-26 13:33:16 -04002642 * root directory alias in its place if there is one. Caller must hold the
2643 * i_mutex of the parent directory.
David Howells770bfad2006-08-22 20:06:07 -04002644 */
2645struct dentry *d_materialise_unique(struct dentry *dentry, struct inode *inode)
2646{
Trond Myklebust9eaef272006-10-21 10:24:20 -07002647 struct dentry *actual;
David Howells770bfad2006-08-22 20:06:07 -04002648
2649 BUG_ON(!d_unhashed(dentry));
2650
David Howells770bfad2006-08-22 20:06:07 -04002651 if (!inode) {
2652 actual = dentry;
OGAWA Hirofumi360da902008-10-16 07:50:28 +09002653 __d_instantiate(dentry, NULL);
Nick Piggin357f8e62011-01-07 17:49:42 +11002654 d_rehash(actual);
2655 goto out_nolock;
David Howells770bfad2006-08-22 20:06:07 -04002656 }
2657
Nick Piggin873feea2011-01-07 17:50:06 +11002658 spin_lock(&inode->i_lock);
Nick Piggin357f8e62011-01-07 17:49:42 +11002659
Trond Myklebust9eaef272006-10-21 10:24:20 -07002660 if (S_ISDIR(inode->i_mode)) {
2661 struct dentry *alias;
David Howells770bfad2006-08-22 20:06:07 -04002662
Trond Myklebust9eaef272006-10-21 10:24:20 -07002663 /* Does an aliased dentry already exist? */
Linus Torvalds32ba9c32012-06-08 10:34:03 -07002664 alias = __d_find_alias(inode, 0);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002665 if (alias) {
2666 actual = alias;
Al Viro18367502011-07-12 21:42:24 -04002667 write_seqlock(&rename_lock);
2668
2669 if (d_ancestor(alias, dentry)) {
2670 /* Check for loops */
2671 actual = ERR_PTR(-ELOOP);
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002672 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002673 } else if (IS_ROOT(alias)) {
2674 /* Is this an anonymous mountpoint that we
2675 * could splice into our tree? */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002676 __d_materialise_dentry(dentry, alias);
Al Viro18367502011-07-12 21:42:24 -04002677 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002678 __d_drop(alias);
2679 goto found;
Al Viro18367502011-07-12 21:42:24 -04002680 } else {
2681 /* Nope, but we must(!) avoid directory
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002682 * aliasing. This drops inode->i_lock */
Al Viro18367502011-07-12 21:42:24 -04002683 actual = __d_unalias(inode, dentry, alias);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002684 }
Al Viro18367502011-07-12 21:42:24 -04002685 write_sequnlock(&rename_lock);
David Howellsdd179942011-08-16 15:31:30 +01002686 if (IS_ERR(actual)) {
2687 if (PTR_ERR(actual) == -ELOOP)
2688 pr_warn_ratelimited(
2689 "VFS: Lookup of '%s' in %s %s"
2690 " would have caused loop\n",
2691 dentry->d_name.name,
2692 inode->i_sb->s_type->name,
2693 inode->i_sb->s_id);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002694 dput(alias);
David Howellsdd179942011-08-16 15:31:30 +01002695 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002696 goto out_nolock;
2697 }
David Howells770bfad2006-08-22 20:06:07 -04002698 }
2699
2700 /* Add a unique reference */
2701 actual = __d_instantiate_unique(dentry, inode);
2702 if (!actual)
2703 actual = dentry;
Nick Piggin357f8e62011-01-07 17:49:42 +11002704 else
2705 BUG_ON(!d_unhashed(actual));
David Howells770bfad2006-08-22 20:06:07 -04002706
David Howells770bfad2006-08-22 20:06:07 -04002707 spin_lock(&actual->d_lock);
2708found:
2709 _d_rehash(actual);
2710 spin_unlock(&actual->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002711 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002712out_nolock:
David Howells770bfad2006-08-22 20:06:07 -04002713 if (actual == dentry) {
2714 security_d_instantiate(dentry, inode);
2715 return NULL;
2716 }
2717
2718 iput(inode);
2719 return actual;
David Howells770bfad2006-08-22 20:06:07 -04002720}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002721EXPORT_SYMBOL_GPL(d_materialise_unique);
David Howells770bfad2006-08-22 20:06:07 -04002722
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002723static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002724{
2725 *buflen -= namelen;
2726 if (*buflen < 0)
2727 return -ENAMETOOLONG;
2728 *buffer -= namelen;
2729 memcpy(*buffer, str, namelen);
2730 return 0;
2731}
2732
Waiman Long232d2d62013-09-09 12:18:13 -04002733/**
2734 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04002735 * @buffer: buffer pointer
2736 * @buflen: allocated length of the buffer
2737 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04002738 *
2739 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
2740 * make sure that either the old or the new name pointer and length are
2741 * fetched. However, there may be mismatch between length and pointer.
2742 * The length cannot be trusted, we need to copy it byte-by-byte until
2743 * the length is reached or a null byte is found. It also prepends "/" at
2744 * the beginning of the name. The sequence number check at the caller will
2745 * retry it again when a d_move() does happen. So any garbage in the buffer
2746 * due to mismatched pointer and length will be discarded.
2747 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002748static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2749{
Waiman Long232d2d62013-09-09 12:18:13 -04002750 const char *dname = ACCESS_ONCE(name->name);
2751 u32 dlen = ACCESS_ONCE(name->len);
2752 char *p;
2753
Waiman Long232d2d62013-09-09 12:18:13 -04002754 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04002755 if (*buflen < 0)
2756 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04002757 p = *buffer -= dlen + 1;
2758 *p++ = '/';
2759 while (dlen--) {
2760 char c = *dname++;
2761 if (!c)
2762 break;
2763 *p++ = c;
2764 }
2765 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002766}
2767
Linus Torvalds1da177e2005-04-16 15:20:36 -07002768/**
Randy Dunlap208898c2010-11-18 15:02:49 -08002769 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002770 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002771 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002772 * @buffer: pointer to the end of the buffer
2773 * @buflen: pointer to buffer length
2774 *
Waiman Long18129972013-09-12 10:55:35 -04002775 * The function will first try to write out the pathname without taking any
2776 * lock other than the RCU read lock to make sure that dentries won't go away.
2777 * It only checks the sequence number of the global rename_lock as any change
2778 * in the dentry's d_seq will be preceded by changes in the rename_lock
2779 * sequence number. If the sequence number had been changed, it will restart
2780 * the whole pathname back-tracing sequence again by taking the rename_lock.
2781 * In this case, there is no need to take the RCU read lock as the recursive
2782 * parent pointer references will keep the dentry chain alive as long as no
2783 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002784 */
Al Viro02125a82011-12-05 08:43:34 -05002785static int prepend_path(const struct path *path,
2786 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002787 char **buffer, int *buflen)
2788{
Al Viroede4ceb2013-11-13 07:45:40 -05002789 struct dentry *dentry;
2790 struct vfsmount *vfsmnt;
2791 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002792 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04002793 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04002794 char *bptr;
2795 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002796
Al Viro48f5ec22013-09-09 15:22:25 -04002797 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04002798restart_mnt:
2799 read_seqbegin_or_lock(&mount_lock, &m_seq);
2800 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002801 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002802restart:
2803 bptr = *buffer;
2804 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04002805 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05002806 dentry = path->dentry;
2807 vfsmnt = path->mnt;
2808 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04002809 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002810 while (dentry != root->dentry || vfsmnt != root->mnt) {
2811 struct dentry * parent;
2812
2813 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04002814 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002815 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04002816 if (mnt != parent) {
2817 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
2818 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04002819 vfsmnt = &mnt->mnt;
2820 continue;
2821 }
2822 /*
2823 * Filesystems needing to implement special "root names"
2824 * should do so with ->d_dname()
2825 */
2826 if (IS_ROOT(dentry) &&
2827 (dentry->d_name.len != 1 ||
2828 dentry->d_name.name[0] != '/')) {
2829 WARN(1, "Root dentry has weird name <%.*s>\n",
2830 (int) dentry->d_name.len,
2831 dentry->d_name.name);
2832 }
2833 if (!error)
2834 error = is_mounted(vfsmnt) ? 1 : 2;
2835 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002836 }
2837 parent = dentry->d_parent;
2838 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002839 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002840 if (error)
2841 break;
2842
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002843 dentry = parent;
2844 }
Al Viro48f5ec22013-09-09 15:22:25 -04002845 if (!(seq & 1))
2846 rcu_read_unlock();
2847 if (need_seqretry(&rename_lock, seq)) {
2848 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04002849 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002850 }
Al Viro48f5ec22013-09-09 15:22:25 -04002851 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002852
2853 if (!(m_seq & 1))
2854 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04002855 if (need_seqretry(&mount_lock, m_seq)) {
2856 m_seq = 1;
2857 goto restart_mnt;
2858 }
2859 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002860
Waiman Long232d2d62013-09-09 12:18:13 -04002861 if (error >= 0 && bptr == *buffer) {
2862 if (--blen < 0)
2863 error = -ENAMETOOLONG;
2864 else
2865 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002866 }
Waiman Long232d2d62013-09-09 12:18:13 -04002867 *buffer = bptr;
2868 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04002869 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002870}
2871
2872/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002873 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002874 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002875 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07002876 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07002877 * @buflen: buffer length
2878 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002879 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002881 * Returns a pointer into the buffer or an error code if the
2882 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08002883 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04002884 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002885 *
Al Viro02125a82011-12-05 08:43:34 -05002886 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002887 */
Al Viro02125a82011-12-05 08:43:34 -05002888char *__d_path(const struct path *path,
2889 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002890 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002892 char *res = buf + buflen;
2893 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002894
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002895 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002896 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002897
Al Viro02125a82011-12-05 08:43:34 -05002898 if (error < 0)
2899 return ERR_PTR(error);
2900 if (error > 0)
2901 return NULL;
2902 return res;
2903}
2904
2905char *d_absolute_path(const struct path *path,
2906 char *buf, int buflen)
2907{
2908 struct path root = {};
2909 char *res = buf + buflen;
2910 int error;
2911
2912 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05002913 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05002914
2915 if (error > 1)
2916 error = -EINVAL;
2917 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002918 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002919 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002920}
2921
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002922/*
2923 * same as __d_path but appends "(deleted)" for unlinked files.
2924 */
Al Viro02125a82011-12-05 08:43:34 -05002925static int path_with_deleted(const struct path *path,
2926 const struct path *root,
2927 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002928{
2929 prepend(buf, buflen, "\0", 1);
2930 if (d_unlinked(path->dentry)) {
2931 int error = prepend(buf, buflen, " (deleted)", 10);
2932 if (error)
2933 return error;
2934 }
2935
2936 return prepend_path(path, root, buf, buflen);
2937}
2938
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002939static int prepend_unreachable(char **buffer, int *buflen)
2940{
2941 return prepend(buffer, buflen, "(unreachable)", 13);
2942}
2943
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07002944static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
2945{
2946 unsigned seq;
2947
2948 do {
2949 seq = read_seqcount_begin(&fs->seq);
2950 *root = fs->root;
2951 } while (read_seqcount_retry(&fs->seq, seq));
2952}
2953
Jan Bluncka03a8a702008-02-14 19:38:32 -08002954/**
2955 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08002956 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08002957 * @buf: buffer to return value in
2958 * @buflen: buffer length
2959 *
2960 * Convert a dentry into an ASCII path name. If the entry has been deleted
2961 * the string " (deleted)" is appended. Note that this is ambiguous.
2962 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002963 * Returns a pointer into the buffer or an error code if the path was
2964 * too long. Note: Callers should use the returned pointer, not the passed
2965 * in buffer, to use the name! The implementation often starts at an offset
2966 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002967 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002968 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002969 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07002970char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002971{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002972 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08002973 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002974 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002975
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002976 /*
2977 * We have various synthetic filesystems that never get mounted. On
2978 * these filesystems dentries are never used for lookup purposes, and
2979 * thus don't need to be hashed. They also don't need a name until a
2980 * user wants to identify the object in /proc/pid/fd/. The little hack
2981 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08002982 *
2983 * Some pseudo inodes are mountable. When they are mounted
2984 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
2985 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002986 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08002987 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
2988 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08002989 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002990
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07002991 rcu_read_lock();
2992 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05002993 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07002994 rcu_read_unlock();
2995
Al Viro02125a82011-12-05 08:43:34 -05002996 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002997 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002998 return res;
2999}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003000EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003001
3002/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003003 * Helper function for dentry_operations.d_dname() members
3004 */
3005char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3006 const char *fmt, ...)
3007{
3008 va_list args;
3009 char temp[64];
3010 int sz;
3011
3012 va_start(args, fmt);
3013 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3014 va_end(args);
3015
3016 if (sz > sizeof(temp) || sz > buflen)
3017 return ERR_PTR(-ENAMETOOLONG);
3018
3019 buffer += buflen - sz;
3020 return memcpy(buffer, temp, sz);
3021}
3022
Al Viro118b2302013-08-24 12:08:17 -04003023char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3024{
3025 char *end = buffer + buflen;
3026 /* these dentries are never renamed, so d_lock is not needed */
3027 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003028 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003029 prepend(&end, &buflen, "/", 1))
3030 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003031 return end;
Al Viro118b2302013-08-24 12:08:17 -04003032}
David Herrmann31bbe162014-01-03 14:09:47 +01003033EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003034
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003035/*
Ram Pai6092d042008-03-27 13:06:20 +01003036 * Write full pathname from the root of the filesystem into the buffer.
3037 */
Al Virof6500802014-01-26 12:37:55 -05003038static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003039{
Al Virof6500802014-01-26 12:37:55 -05003040 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003041 char *end, *retval;
3042 int len, seq = 0;
3043 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003044
Al Virof6500802014-01-26 12:37:55 -05003045 if (buflen < 2)
3046 goto Elong;
3047
Al Viro48f5ec22013-09-09 15:22:25 -04003048 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003049restart:
Al Virof6500802014-01-26 12:37:55 -05003050 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003051 end = buf + buflen;
3052 len = buflen;
3053 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003054 /* Get '/' right */
3055 retval = end-1;
3056 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003057 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003058 while (!IS_ROOT(dentry)) {
3059 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003060
Ram Pai6092d042008-03-27 13:06:20 +01003061 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003062 error = prepend_name(&end, &len, &dentry->d_name);
3063 if (error)
3064 break;
Ram Pai6092d042008-03-27 13:06:20 +01003065
3066 retval = end;
3067 dentry = parent;
3068 }
Al Viro48f5ec22013-09-09 15:22:25 -04003069 if (!(seq & 1))
3070 rcu_read_unlock();
3071 if (need_seqretry(&rename_lock, seq)) {
3072 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003073 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003074 }
3075 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003076 if (error)
3077 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003078 return retval;
3079Elong:
3080 return ERR_PTR(-ENAMETOOLONG);
3081}
Nick Pigginec2447c2011-01-07 17:49:29 +11003082
3083char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3084{
Waiman Long232d2d62013-09-09 12:18:13 -04003085 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003086}
3087EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003088
3089char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3090{
3091 char *p = NULL;
3092 char *retval;
3093
Al Viroc1031352010-06-06 22:31:14 -04003094 if (d_unlinked(dentry)) {
3095 p = buf + buflen;
3096 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3097 goto Elong;
3098 buflen++;
3099 }
3100 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003101 if (!IS_ERR(retval) && p)
3102 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003103 return retval;
3104Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003105 return ERR_PTR(-ENAMETOOLONG);
3106}
3107
Linus Torvalds8b19e342013-09-12 10:35:47 -07003108static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3109 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003110{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003111 unsigned seq;
3112
3113 do {
3114 seq = read_seqcount_begin(&fs->seq);
3115 *root = fs->root;
3116 *pwd = fs->pwd;
3117 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003118}
3119
Ram Pai6092d042008-03-27 13:06:20 +01003120/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003121 * NOTE! The user-level library version returns a
3122 * character pointer. The kernel system call just
3123 * returns the length of the buffer filled (which
3124 * includes the ending '\0' character), or a negative
3125 * error value. So libc would do something like
3126 *
3127 * char *getcwd(char * buf, size_t size)
3128 * {
3129 * int retval;
3130 *
3131 * retval = sys_getcwd(buf, size);
3132 * if (retval >= 0)
3133 * return buf;
3134 * errno = -retval;
3135 * return NULL;
3136 * }
3137 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003138SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003139{
Linus Torvalds552ce542007-02-13 12:08:18 -08003140 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003141 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003142 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003143
3144 if (!page)
3145 return -ENOMEM;
3146
Linus Torvalds8b19e342013-09-12 10:35:47 -07003147 rcu_read_lock();
3148 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003149
Linus Torvalds552ce542007-02-13 12:08:18 -08003150 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003151 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003152 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003153 char *cwd = page + PATH_MAX;
3154 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003155
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003156 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003157 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003158 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003159
Al Viro02125a82011-12-05 08:43:34 -05003160 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003161 goto out;
3162
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003163 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003164 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003165 error = prepend_unreachable(&cwd, &buflen);
3166 if (error)
3167 goto out;
3168 }
3169
Linus Torvalds552ce542007-02-13 12:08:18 -08003170 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003171 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003172 if (len <= size) {
3173 error = len;
3174 if (copy_to_user(buf, cwd, len))
3175 error = -EFAULT;
3176 }
Nick Piggin949854d2011-01-07 17:49:37 +11003177 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003178 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003179 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003180
3181out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003182 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003183 return error;
3184}
3185
3186/*
3187 * Test whether new_dentry is a subdirectory of old_dentry.
3188 *
3189 * Trivially implemented using the dcache structure
3190 */
3191
3192/**
3193 * is_subdir - is new dentry a subdirectory of old_dentry
3194 * @new_dentry: new dentry
3195 * @old_dentry: old dentry
3196 *
3197 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
3198 * Returns 0 otherwise.
3199 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3200 */
3201
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003202int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003203{
3204 int result;
Nick Piggin949854d2011-01-07 17:49:37 +11003205 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003206
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003207 if (new_dentry == old_dentry)
3208 return 1;
3209
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003210 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003211 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003212 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003213 /*
3214 * Need rcu_readlock to protect against the d_parent trashing
3215 * due to d_move
3216 */
3217 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003218 if (d_ancestor(old_dentry, new_dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003219 result = 1;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003220 else
3221 result = 0;
Nick Piggin949854d2011-01-07 17:49:37 +11003222 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003223 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003224
3225 return result;
3226}
3227
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003228static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003229{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003230 struct dentry *root = data;
3231 if (dentry != root) {
3232 if (d_unhashed(dentry) || !dentry->d_inode)
3233 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003234
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003235 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3236 dentry->d_flags |= DCACHE_GENOCIDE;
3237 dentry->d_lockref.count--;
3238 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003239 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003240 return D_WALK_CONTINUE;
3241}
Nick Piggin58db63d2011-01-07 17:49:39 +11003242
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003243void d_genocide(struct dentry *parent)
3244{
3245 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003246}
3247
Al Viro60545d02013-06-07 01:20:27 -04003248void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003249{
Al Viro60545d02013-06-07 01:20:27 -04003250 inode_dec_link_count(inode);
3251 BUG_ON(dentry->d_name.name != dentry->d_iname ||
3252 !hlist_unhashed(&dentry->d_alias) ||
3253 !d_unlinked(dentry));
3254 spin_lock(&dentry->d_parent->d_lock);
3255 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3256 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3257 (unsigned long long)inode->i_ino);
3258 spin_unlock(&dentry->d_lock);
3259 spin_unlock(&dentry->d_parent->d_lock);
3260 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003261}
Al Viro60545d02013-06-07 01:20:27 -04003262EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003263
3264static __initdata unsigned long dhash_entries;
3265static int __init set_dhash_entries(char *str)
3266{
3267 if (!str)
3268 return 0;
3269 dhash_entries = simple_strtoul(str, &str, 0);
3270 return 1;
3271}
3272__setup("dhash_entries=", set_dhash_entries);
3273
3274static void __init dcache_init_early(void)
3275{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003276 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003277
3278 /* If hashes are distributed across NUMA nodes, defer
3279 * hash allocation until vmalloc space is available.
3280 */
3281 if (hashdist)
3282 return;
3283
3284 dentry_hashtable =
3285 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003286 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003287 dhash_entries,
3288 13,
3289 HASH_EARLY,
3290 &d_hash_shift,
3291 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003292 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003293 0);
3294
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003295 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003296 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003297}
3298
Denis Cheng74bf17c2007-10-16 23:26:30 -07003299static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003300{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003301 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003302
3303 /*
3304 * A constructor could be added for stable state like the lists,
3305 * but it is probably not worth it because of the cache nature
3306 * of the dcache.
3307 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003308 dentry_cache = KMEM_CACHE(dentry,
3309 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003310
3311 /* Hash may have been set up in dcache_init_early */
3312 if (!hashdist)
3313 return;
3314
3315 dentry_hashtable =
3316 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003317 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003318 dhash_entries,
3319 13,
3320 0,
3321 &d_hash_shift,
3322 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003323 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003324 0);
3325
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003326 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003327 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003328}
3329
3330/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003331struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003332EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003333
Linus Torvalds1da177e2005-04-16 15:20:36 -07003334EXPORT_SYMBOL(d_genocide);
3335
Linus Torvalds1da177e2005-04-16 15:20:36 -07003336void __init vfs_caches_init_early(void)
3337{
3338 dcache_init_early();
3339 inode_init_early();
3340}
3341
3342void __init vfs_caches_init(unsigned long mempages)
3343{
3344 unsigned long reserve;
3345
3346 /* Base hash sizes on available memory, with a reserve equal to
3347 150% of current kernel size */
3348
3349 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
3350 mempages -= reserve;
3351
3352 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003353 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003354
Denis Cheng74bf17c2007-10-16 23:26:30 -07003355 dcache_init();
3356 inode_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003357 files_init(mempages);
Denis Cheng74bf17c2007-10-16 23:26:30 -07003358 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003359 bdev_cache_init();
3360 chrdev_init();
3361}