blob: 7d34f04ec7aa9fed7030d455a118f56ab47fe2e4 [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>
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -080041#include <linux/kasan.h>
42
David Howells07f3f05c2006-09-30 20:52:18 +020043#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050044#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Nick Piggin789680d2011-01-07 17:49:30 +110046/*
47 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110048 * dcache->d_inode->i_lock protects:
Al Viro946e51f2014-10-26 19:19:16 -040049 * - i_dentry, d_u.d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110050 * dcache_hash_bucket lock protects:
51 * - the dcache hash table
52 * s_anon bl list spinlock protects:
53 * - the s_anon list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100054 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110055 * - the dcache lru lists and counters
56 * d_lock protects:
57 * - d_flags
58 * - d_name
59 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110060 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110061 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110062 * - d_parent and d_subdirs
63 * - childrens' d_child and d_parent
Al Viro946e51f2014-10-26 19:19:16 -040064 * - d_u.d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110065 *
66 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110067 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110068 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100069 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110070 * dcache_hash_bucket lock
71 * s_anon lock
Nick Piggin789680d2011-01-07 17:49:30 +110072 *
Nick Pigginda502952011-01-07 17:49:33 +110073 * If there is an ancestor relationship:
74 * dentry->d_parent->...->d_parent->d_lock
75 * ...
76 * dentry->d_parent->d_lock
77 * dentry->d_lock
78 *
79 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110080 * if (dentry1 < dentry2)
81 * dentry1->d_lock
82 * dentry2->d_lock
83 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080084int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
86
Al Viro74c3cbe2007-07-22 08:04:18 -040087__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Nick Piggin949854d2011-01-07 17:49:37 +110089EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Christoph Lametere18b8902006-12-06 20:33:20 -080091static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Linus Torvalds1da177e2005-04-16 15:20:36 -070093/*
94 * This is the single most critical data structure when it comes
95 * to the dcache: the hashtable for lookups. Somebody should try
96 * to make this good - I've just made it work.
97 *
98 * This hash-function tries to avoid losing too many bits of hash
99 * information, yet avoid using a prime hash-size or similar.
100 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800102static unsigned int d_hash_mask __read_mostly;
103static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100104
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700105static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100106
Linus Torvalds8966be92012-03-02 14:23:30 -0800107static inline struct hlist_bl_head *d_hash(const struct dentry *parent,
Linus Torvalds6d7d1a02012-03-19 16:19:53 -0700108 unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100109{
Linus Torvalds6d7d1a02012-03-19 16:19:53 -0700110 hash += (unsigned long) parent / L1_CACHE_BYTES;
Linus Torvalds99d263d2014-09-13 11:30:10 -0700111 return dentry_hashtable + hash_32(hash, d_hash_shift);
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100112}
113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114/* Statistics gathering. */
115struct dentry_stat_t dentry_stat = {
116 .age_limit = 45,
117};
118
Glauber Costa3942c072013-08-28 10:17:53 +1000119static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000120static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400121
122#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000123
124/*
125 * Here we resort to our own counters instead of using generic per-cpu counters
126 * for consistency with what the vfs inode code does. We are expected to harvest
127 * better code and performance by having our own specialized counters.
128 *
129 * Please note that the loop is done over all possible CPUs, not over all online
130 * CPUs. The reason for this is that we don't want to play games with CPUs going
131 * on and off. If one of them goes off, we will just keep their counters.
132 *
133 * glommer: See cffbc8a for details, and if you ever intend to change this,
134 * please update all vfs counters to match.
135 */
Glauber Costa3942c072013-08-28 10:17:53 +1000136static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100137{
138 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000139 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100140 for_each_possible_cpu(i)
141 sum += per_cpu(nr_dentry, i);
142 return sum < 0 ? 0 : sum;
143}
144
Dave Chinner62d36c72013-08-28 10:17:54 +1000145static long get_nr_dentry_unused(void)
146{
147 int i;
148 long sum = 0;
149 for_each_possible_cpu(i)
150 sum += per_cpu(nr_dentry_unused, i);
151 return sum < 0 ? 0 : sum;
152}
153
Joe Perches1f7e0612014-06-06 14:38:05 -0700154int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400155 size_t *lenp, loff_t *ppos)
156{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100157 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000158 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000159 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400160}
161#endif
162
Linus Torvalds5483f182012-03-04 15:51:42 -0800163/*
164 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
165 * The strings are both count bytes long, and count is non-zero.
166 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700167#ifdef CONFIG_DCACHE_WORD_ACCESS
168
169#include <asm/word-at-a-time.h>
170/*
171 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
172 * aligned allocation for this particular component. We don't
173 * strictly need the load_unaligned_zeropad() safety, but it
174 * doesn't hurt either.
175 *
176 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
177 * need the careful unaligned handling.
178 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700179static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800180{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800181 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800182
183 for (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700184 a = *(unsigned long *)cs;
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700185 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800186 if (tcount < sizeof(unsigned long))
187 break;
188 if (unlikely(a != b))
189 return 1;
190 cs += sizeof(unsigned long);
191 ct += sizeof(unsigned long);
192 tcount -= sizeof(unsigned long);
193 if (!tcount)
194 return 0;
195 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000196 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800197 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700198}
199
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800200#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700201
Linus Torvalds94753db52012-05-10 12:19:19 -0700202static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700203{
Linus Torvalds5483f182012-03-04 15:51:42 -0800204 do {
205 if (*cs != *ct)
206 return 1;
207 cs++;
208 ct++;
209 tcount--;
210 } while (tcount);
211 return 0;
212}
213
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700214#endif
215
Linus Torvalds94753db52012-05-10 12:19:19 -0700216static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
217{
Linus Torvalds6326c712012-05-21 16:14:04 -0700218 const unsigned char *cs;
Linus Torvalds94753db52012-05-10 12:19:19 -0700219 /*
220 * Be careful about RCU walk racing with rename:
221 * use ACCESS_ONCE to fetch the name pointer.
222 *
223 * NOTE! Even if a rename will mean that the length
224 * was not loaded atomically, we don't care. The
225 * RCU walk will check the sequence count eventually,
226 * and catch it. And we won't overrun the buffer,
227 * because we're reading the name pointer atomically,
228 * and a dentry name is guaranteed to be properly
229 * terminated with a NUL byte.
230 *
231 * End result: even if 'len' is wrong, we'll exit
232 * early because the data cannot match (there can
233 * be no NUL in the ct/tcount data)
234 */
Linus Torvalds6326c712012-05-21 16:14:04 -0700235 cs = ACCESS_ONCE(dentry->d_name.name);
236 smp_read_barrier_depends();
237 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700238}
239
Al Viro8d85b482014-09-29 14:54:27 -0400240struct external_name {
241 union {
242 atomic_t count;
243 struct rcu_head head;
244 } u;
245 unsigned char name[];
246};
247
248static inline struct external_name *external_name(struct dentry *dentry)
249{
250 return container_of(dentry->d_name.name, struct external_name, name[0]);
251}
252
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400253static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400255 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
256
Al Viro8d85b482014-09-29 14:54:27 -0400257 kmem_cache_free(dentry_cache, dentry);
258}
259
260static void __d_free_external(struct rcu_head *head)
261{
262 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Al Viro8d85b482014-09-29 14:54:27 -0400263 kfree(external_name(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 kmem_cache_free(dentry_cache, dentry);
265}
266
Al Viro810bb172014-10-12 12:45:37 -0400267static inline int dname_external(const struct dentry *dentry)
268{
269 return dentry->d_name.name != dentry->d_iname;
270}
271
Al Virob4f03542014-04-29 23:40:14 -0400272static void dentry_free(struct dentry *dentry)
273{
Al Viro946e51f2014-10-26 19:19:16 -0400274 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400275 if (unlikely(dname_external(dentry))) {
276 struct external_name *p = external_name(dentry);
277 if (likely(atomic_dec_and_test(&p->u.count))) {
278 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
279 return;
280 }
281 }
Al Virob4f03542014-04-29 23:40:14 -0400282 /* if dentry was never visible to RCU, immediate free is OK */
283 if (!(dentry->d_flags & DCACHE_RCUACCESS))
284 __d_free(&dentry->d_u.d_rcu);
285 else
286 call_rcu(&dentry->d_u.d_rcu, __d_free);
287}
288
Nick Piggin31e6b012011-01-07 17:49:52 +1100289/**
290 * dentry_rcuwalk_barrier - invalidate in-progress rcu-walk lookups
Randy Dunlapff5fdb62011-01-22 20:16:06 -0800291 * @dentry: the target dentry
Nick Piggin31e6b012011-01-07 17:49:52 +1100292 * After this call, in-progress rcu-walk path lookup will fail. This
293 * should be called after unhashing, and after changing d_inode (if
294 * the dentry has not already been unhashed).
295 */
296static inline void dentry_rcuwalk_barrier(struct dentry *dentry)
297{
298 assert_spin_locked(&dentry->d_lock);
299 /* Go through a barrier */
300 write_seqcount_barrier(&dentry->d_seq);
301}
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303/*
304 * Release the dentry's inode, using the filesystem
Nick Piggin31e6b012011-01-07 17:49:52 +1100305 * d_iput() operation if defined. Dentry has no refcount
306 * and is unhashed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 */
Arjan van de Ven858119e2006-01-14 13:20:43 -0800308static void dentry_iput(struct dentry * dentry)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200309 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100310 __releases(dentry->d_inode->i_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311{
312 struct inode *inode = dentry->d_inode;
313 if (inode) {
314 dentry->d_inode = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400315 hlist_del_init(&dentry->d_u.d_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100317 spin_unlock(&inode->i_lock);
Linus Torvaldsf805fbd2005-09-19 19:54:29 -0700318 if (!inode->i_nlink)
319 fsnotify_inoderemove(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 if (dentry->d_op && dentry->d_op->d_iput)
321 dentry->d_op->d_iput(dentry, inode);
322 else
323 iput(inode);
324 } else {
325 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 }
327}
328
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700329/*
Nick Piggin31e6b012011-01-07 17:49:52 +1100330 * Release the dentry's inode, using the filesystem
331 * d_iput() operation if defined. dentry remains in-use.
332 */
333static void dentry_unlink_inode(struct dentry * dentry)
334 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100335 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100336{
337 struct inode *inode = dentry->d_inode;
David Howellsb18825a2013-09-12 19:22:53 +0100338 __d_clear_type(dentry);
Nick Piggin31e6b012011-01-07 17:49:52 +1100339 dentry->d_inode = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400340 hlist_del_init(&dentry->d_u.d_alias);
Nick Piggin31e6b012011-01-07 17:49:52 +1100341 dentry_rcuwalk_barrier(dentry);
342 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100343 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100344 if (!inode->i_nlink)
345 fsnotify_inoderemove(inode);
346 if (dentry->d_op && dentry->d_op->d_iput)
347 dentry->d_op->d_iput(dentry, inode);
348 else
349 iput(inode);
350}
351
352/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400353 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
354 * is in use - which includes both the "real" per-superblock
355 * LRU list _and_ the DCACHE_SHRINK_LIST use.
356 *
357 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
358 * on the shrink list (ie not on the superblock LRU list).
359 *
360 * The per-cpu "nr_dentry_unused" counters are updated with
361 * the DCACHE_LRU_LIST bit.
362 *
363 * These helper functions make sure we always follow the
364 * rules. d_lock must be held by the caller.
365 */
366#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
367static void d_lru_add(struct dentry *dentry)
368{
369 D_FLAG_VERIFY(dentry, 0);
370 dentry->d_flags |= DCACHE_LRU_LIST;
371 this_cpu_inc(nr_dentry_unused);
372 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
373}
374
375static void d_lru_del(struct dentry *dentry)
376{
377 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
378 dentry->d_flags &= ~DCACHE_LRU_LIST;
379 this_cpu_dec(nr_dentry_unused);
380 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
381}
382
383static void d_shrink_del(struct dentry *dentry)
384{
385 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
386 list_del_init(&dentry->d_lru);
387 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
388 this_cpu_dec(nr_dentry_unused);
389}
390
391static void d_shrink_add(struct dentry *dentry, struct list_head *list)
392{
393 D_FLAG_VERIFY(dentry, 0);
394 list_add(&dentry->d_lru, list);
395 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
396 this_cpu_inc(nr_dentry_unused);
397}
398
399/*
400 * These can only be called under the global LRU lock, ie during the
401 * callback for freeing the LRU list. "isolate" removes it from the
402 * LRU lists entirely, while shrink_move moves it to the indicated
403 * private list.
404 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800405static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400406{
407 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
408 dentry->d_flags &= ~DCACHE_LRU_LIST;
409 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800410 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400411}
412
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800413static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
414 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400415{
416 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
417 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800418 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400419}
420
421/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000422 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700423 */
424static void dentry_lru_add(struct dentry *dentry)
425{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400426 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
427 d_lru_add(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700428}
429
Miklos Szeredid52b9082007-05-08 00:23:46 -0700430/**
Nick Piggin789680d2011-01-07 17:49:30 +1100431 * d_drop - drop a dentry
432 * @dentry: dentry to drop
433 *
434 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
435 * be found through a VFS lookup any more. Note that this is different from
436 * deleting the dentry - d_delete will try to mark the dentry negative if
437 * possible, giving a successful _negative_ lookup, while d_drop will
438 * just make the cache lookup fail.
439 *
440 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
441 * reason (NFS timeouts or autofs deletes).
442 *
443 * __d_drop requires dentry->d_lock.
444 */
445void __d_drop(struct dentry *dentry)
446{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700447 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400448 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400449 /*
450 * Hashed dentries are normally on the dentry hashtable,
451 * with the exception of those newly allocated by
452 * d_obtain_alias, which are always IS_ROOT:
453 */
454 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400455 b = &dentry->d_sb->s_anon;
456 else
457 b = d_hash(dentry->d_parent, dentry->d_name.hash);
458
459 hlist_bl_lock(b);
460 __hlist_bl_del(&dentry->d_hash);
461 dentry->d_hash.pprev = NULL;
462 hlist_bl_unlock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -0700463 dentry_rcuwalk_barrier(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +1100464 }
465}
466EXPORT_SYMBOL(__d_drop);
467
468void d_drop(struct dentry *dentry)
469{
Nick Piggin789680d2011-01-07 17:49:30 +1100470 spin_lock(&dentry->d_lock);
471 __d_drop(dentry);
472 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100473}
474EXPORT_SYMBOL(d_drop);
475
Al Viroe55fd012014-05-28 13:51:12 -0400476static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100477{
Al Viro41edf272014-05-01 10:30:00 -0400478 struct dentry *parent = NULL;
479 bool can_free = true;
Al Viro41edf272014-05-01 10:30:00 -0400480 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100481 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100482
Linus Torvalds0d984392013-09-08 13:46:52 -0700483 /*
484 * The dentry is now unrecoverably dead to the world.
485 */
486 lockref_mark_dead(&dentry->d_lockref);
487
Sage Weilf0023bc2011-10-28 10:02:42 -0700488 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700489 * inform the fs via d_prune that this dentry is about to be
490 * unhashed and destroyed.
491 */
Al Viro29266202014-05-30 11:39:02 -0400492 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800493 dentry->d_op->d_prune(dentry);
494
Al Viro01b60352014-04-29 23:42:52 -0400495 if (dentry->d_flags & DCACHE_LRU_LIST) {
496 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
497 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400498 }
Nick Piggin77812a12011-01-07 17:49:48 +1100499 /* if it was on the hash then remove it */
500 __d_drop(dentry);
Al Viroca5358e2014-10-26 19:31:10 -0400501 __list_del_entry(&dentry->d_child);
Al Viro03b3b882014-04-29 15:45:28 -0400502 /*
503 * Inform d_walk() that we are no longer attached to the
504 * dentry tree
505 */
506 dentry->d_flags |= DCACHE_DENTRY_KILLED;
507 if (parent)
508 spin_unlock(&parent->d_lock);
509 dentry_iput(dentry);
510 /*
511 * dentry_iput drops the locks, at which point nobody (except
512 * transient RCU lookups) can reach this dentry.
513 */
514 BUG_ON((int)dentry->d_lockref.count > 0);
515 this_cpu_dec(nr_dentry);
516 if (dentry->d_op && dentry->d_op->d_release)
517 dentry->d_op->d_release(dentry);
518
Al Viro41edf272014-05-01 10:30:00 -0400519 spin_lock(&dentry->d_lock);
520 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
521 dentry->d_flags |= DCACHE_MAY_FREE;
522 can_free = false;
523 }
524 spin_unlock(&dentry->d_lock);
Al Viro41edf272014-05-01 10:30:00 -0400525 if (likely(can_free))
526 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400527}
528
529/*
530 * Finish off a dentry we've decided to kill.
531 * dentry->d_lock must be held, returns with it unlocked.
532 * If ref is non-zero, then decrement the refcount too.
533 * Returns dentry requiring refcount drop, or NULL if we're done.
534 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400535static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400536 __releases(dentry->d_lock)
537{
538 struct inode *inode = dentry->d_inode;
539 struct dentry *parent = NULL;
540
541 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
542 goto failed;
543
544 if (!IS_ROOT(dentry)) {
545 parent = dentry->d_parent;
546 if (unlikely(!spin_trylock(&parent->d_lock))) {
547 if (inode)
548 spin_unlock(&inode->i_lock);
549 goto failed;
550 }
551 }
552
553 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400554 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400555
556failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400557 spin_unlock(&dentry->d_lock);
558 cpu_relax();
Al Viroe55fd012014-05-28 13:51:12 -0400559 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100560}
561
Al Viro046b9612014-05-29 08:54:52 -0400562static inline struct dentry *lock_parent(struct dentry *dentry)
563{
564 struct dentry *parent = dentry->d_parent;
565 if (IS_ROOT(dentry))
566 return NULL;
Al Viroc2338f22014-06-12 00:29:13 -0400567 if (unlikely((int)dentry->d_lockref.count < 0))
568 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400569 if (likely(spin_trylock(&parent->d_lock)))
570 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400571 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400572 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400573again:
574 parent = ACCESS_ONCE(dentry->d_parent);
575 spin_lock(&parent->d_lock);
576 /*
577 * We can't blindly lock dentry until we are sure
578 * that we won't violate the locking order.
579 * Any changes of dentry->d_parent must have
580 * been done with parent->d_lock held, so
581 * spin_lock() above is enough of a barrier
582 * for checking if it's still our child.
583 */
584 if (unlikely(parent != dentry->d_parent)) {
585 spin_unlock(&parent->d_lock);
586 goto again;
587 }
588 rcu_read_unlock();
589 if (parent != dentry)
Linus Torvalds9f126002014-05-31 09:13:21 -0700590 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro046b9612014-05-29 08:54:52 -0400591 else
592 parent = NULL;
593 return parent;
594}
595
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596/*
597 * This is dput
598 *
599 * This is complicated by the fact that we do not want to put
600 * dentries that are no longer on any hash chain on the unused
601 * list: we'd much rather just get rid of them immediately.
602 *
603 * However, that implies that we have to traverse the dentry
604 * tree upwards to the parents which might _also_ now be
605 * scheduled for deletion (it may have been only waiting for
606 * its last child to go away).
607 *
608 * This tail recursion is done by hand as we don't want to depend
609 * on the compiler to always get this right (gcc generally doesn't).
610 * Real recursion would eat up our stack space.
611 */
612
613/*
614 * dput - release a dentry
615 * @dentry: dentry to release
616 *
617 * Release a dentry. This will drop the usage count and if appropriate
618 * call the dentry unlink method as well as removing it from the queues and
619 * releasing its resources. If the parent dentries were scheduled for release
620 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622void dput(struct dentry *dentry)
623{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700624 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 return;
626
627repeat:
Waiman Long98474232013-08-28 18:24:59 -0700628 if (lockref_put_or_lock(&dentry->d_lockref))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700631 /* Unreachable? Get rid of it */
632 if (unlikely(d_unhashed(dentry)))
633 goto kill_it;
634
635 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100637 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 }
Nick Piggin265ac902010-10-10 05:36:24 -0400639
Linus Torvalds358eec12013-10-31 15:43:02 -0700640 if (!(dentry->d_flags & DCACHE_REFERENCED))
641 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400642 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400643
Waiman Long98474232013-08-28 18:24:59 -0700644 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100645 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 return;
647
Miklos Szeredid52b9082007-05-08 00:23:46 -0700648kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400649 dentry = dentry_kill(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700650 if (dentry)
651 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700653EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100656/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100657static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658{
Waiman Long98474232013-08-28 18:24:59 -0700659 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660}
661
Nick Piggindc0474b2011-01-07 17:49:43 +1100662static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100663{
Waiman Long98474232013-08-28 18:24:59 -0700664 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100665}
666
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100667struct dentry *dget_parent(struct dentry *dentry)
668{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700669 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100670 struct dentry *ret;
671
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700672 /*
673 * Do optimistic parent lookup without any
674 * locking.
675 */
676 rcu_read_lock();
677 ret = ACCESS_ONCE(dentry->d_parent);
678 gotref = lockref_get_not_zero(&ret->d_lockref);
679 rcu_read_unlock();
680 if (likely(gotref)) {
681 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
682 return ret;
683 dput(ret);
684 }
685
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100686repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100687 /*
688 * Don't need rcu_dereference because we re-check it was correct under
689 * the lock.
690 */
691 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100692 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100693 spin_lock(&ret->d_lock);
694 if (unlikely(ret != dentry->d_parent)) {
695 spin_unlock(&ret->d_lock);
696 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100697 goto repeat;
698 }
Nick Piggina734eb42011-01-07 17:49:44 +1100699 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700700 BUG_ON(!ret->d_lockref.count);
701 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100702 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100703 return ret;
704}
705EXPORT_SYMBOL(dget_parent);
706
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707/**
708 * d_find_alias - grab a hashed alias of inode
709 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 *
711 * If inode has a hashed alias, or is a directory and has any alias,
712 * acquire the reference to alias and return it. Otherwise return NULL.
713 * Notice that if inode is a directory there can be only one alias and
714 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800715 * of a filesystem, or if the directory was renamed and d_revalidate
716 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700718 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500719 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500721static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722{
Nick Pigginda502952011-01-07 17:49:33 +1100723 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724
Nick Pigginda502952011-01-07 17:49:33 +1100725again:
726 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400727 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100728 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700730 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100731 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500733 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100734 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100735 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 return alias;
737 }
738 }
Nick Pigginda502952011-01-07 17:49:33 +1100739 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 }
Nick Pigginda502952011-01-07 17:49:33 +1100741 if (discon_alias) {
742 alias = discon_alias;
743 spin_lock(&alias->d_lock);
744 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500745 __dget_dlock(alias);
746 spin_unlock(&alias->d_lock);
747 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100748 }
749 spin_unlock(&alias->d_lock);
750 goto again;
751 }
752 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753}
754
Nick Pigginda502952011-01-07 17:49:33 +1100755struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756{
David Howells214fda12006-03-25 03:06:36 -0800757 struct dentry *de = NULL;
758
Al Virob3d9b7a2012-06-09 13:51:19 -0400759 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100760 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500761 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100762 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800763 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 return de;
765}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700766EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767
768/*
769 * Try to kill dentries associated with this inode.
770 * WARNING: you must own a reference to inode.
771 */
772void d_prune_aliases(struct inode *inode)
773{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700774 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100776 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400777 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700779 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400780 struct dentry *parent = lock_parent(dentry);
781 if (likely(!dentry->d_lockref.count)) {
782 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800783 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400784 goto restart;
785 }
786 if (parent)
787 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 }
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)) {
Al Viroff2fde92014-05-28 13:59:13 -0400800 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400801 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100802 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400803 parent = lock_parent(dentry);
804
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000806 * The dispose list is isolated and dentries are not accounted
807 * to the LRU here, so we can simply remove it from the list
808 * here regardless of whether it is referenced or not.
809 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400810 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000811
812 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000814 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 */
Al Viro41edf272014-05-01 10:30:00 -0400816 if ((int)dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700817 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400818 if (parent)
819 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 continue;
821 }
Nick Piggin77812a12011-01-07 17:49:48 +1100822
Al Viro64fd72e2014-05-28 09:48:44 -0400823
824 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
825 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
826 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400827 if (parent)
828 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -0400829 if (can_free)
830 dentry_free(dentry);
831 continue;
832 }
833
Al Viroff2fde92014-05-28 13:59:13 -0400834 inode = dentry->d_inode;
835 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400836 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000837 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400838 if (parent)
839 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -0400840 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000841 }
Al Viroff2fde92014-05-28 13:59:13 -0400842
Al Viroff2fde92014-05-28 13:59:13 -0400843 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -0400844
Al Viro5c47e6d2014-04-29 16:13:18 -0400845 /*
846 * We need to prune ancestors too. This is necessary to prevent
847 * quadratic behavior of shrink_dcache_parent(), but is also
848 * expected to be beneficial in reducing dentry cache
849 * fragmentation.
850 */
851 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -0400852 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
853 parent = lock_parent(dentry);
854 if (dentry->d_lockref.count != 1) {
855 dentry->d_lockref.count--;
856 spin_unlock(&dentry->d_lock);
857 if (parent)
858 spin_unlock(&parent->d_lock);
859 break;
860 }
861 inode = dentry->d_inode; /* can't be NULL */
862 if (unlikely(!spin_trylock(&inode->i_lock))) {
863 spin_unlock(&dentry->d_lock);
864 if (parent)
865 spin_unlock(&parent->d_lock);
866 cpu_relax();
867 continue;
868 }
869 __dentry_kill(dentry);
870 dentry = parent;
871 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400873}
874
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800875static enum lru_status dentry_lru_isolate(struct list_head *item,
876 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +1000877{
878 struct list_head *freeable = arg;
879 struct dentry *dentry = container_of(item, struct dentry, d_lru);
880
881
882 /*
883 * we are inverting the lru lock/dentry->d_lock here,
884 * so use a trylock. If we fail to get the lock, just skip
885 * it
886 */
887 if (!spin_trylock(&dentry->d_lock))
888 return LRU_SKIP;
889
890 /*
891 * Referenced dentries are still in use. If they have active
892 * counts, just remove them from the LRU. Otherwise give them
893 * another pass through the LRU.
894 */
895 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800896 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +1000897 spin_unlock(&dentry->d_lock);
898 return LRU_REMOVED;
899 }
900
901 if (dentry->d_flags & DCACHE_REFERENCED) {
902 dentry->d_flags &= ~DCACHE_REFERENCED;
903 spin_unlock(&dentry->d_lock);
904
905 /*
906 * The list move itself will be made by the common LRU code. At
907 * this point, we've dropped the dentry->d_lock but keep the
908 * lru lock. This is safe to do, since every list movement is
909 * protected by the lru lock even if both locks are held.
910 *
911 * This is guaranteed by the fact that all LRU management
912 * functions are intermediated by the LRU API calls like
913 * list_lru_add and list_lru_del. List movement in this file
914 * only ever occur through this functions or through callbacks
915 * like this one, that are called from the LRU API.
916 *
917 * The only exceptions to this are functions like
918 * shrink_dentry_list, and code that first checks for the
919 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
920 * operating only with stack provided lists after they are
921 * properly isolated from the main list. It is thus, always a
922 * local access.
923 */
924 return LRU_ROTATE;
925 }
926
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800927 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +1000928 spin_unlock(&dentry->d_lock);
929
930 return LRU_REMOVED;
931}
932
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400933/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000934 * prune_dcache_sb - shrink the dcache
935 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -0800936 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400937 *
Vladimir Davydov503c3582015-02-12 14:58:47 -0800938 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
939 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000940 * function.
941 *
942 * This function may fail to free any resources if all the dentries are in
943 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400944 */
Vladimir Davydov503c3582015-02-12 14:58:47 -0800945long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400946{
Dave Chinnerf6041562013-08-28 10:18:00 +1000947 LIST_HEAD(dispose);
948 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400949
Vladimir Davydov503c3582015-02-12 14:58:47 -0800950 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
951 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +1000952 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +1000953 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954}
955
Glauber Costa4e717f52013-08-28 10:18:03 +1000956static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800957 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000958{
Glauber Costa4e717f52013-08-28 10:18:03 +1000959 struct list_head *freeable = arg;
960 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000961
Glauber Costa4e717f52013-08-28 10:18:03 +1000962 /*
963 * we are inverting the lru lock/dentry->d_lock here,
964 * so use a trylock. If we fail to get the lock, just skip
965 * it
966 */
967 if (!spin_trylock(&dentry->d_lock))
968 return LRU_SKIP;
969
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800970 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +1000971 spin_unlock(&dentry->d_lock);
972
973 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000974}
975
Glauber Costa4e717f52013-08-28 10:18:03 +1000976
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700977/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 * shrink_dcache_sb - shrink dcache for a superblock
979 * @sb: superblock
980 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400981 * Shrink the dcache for the specified super block. This is used to free
982 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400984void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985{
Glauber Costa4e717f52013-08-28 10:18:03 +1000986 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400987
Glauber Costa4e717f52013-08-28 10:18:03 +1000988 do {
989 LIST_HEAD(dispose);
990
991 freed = list_lru_walk(&sb->s_dentry_lru,
992 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
993
994 this_cpu_sub(nr_dentry_unused, freed);
995 shrink_dentry_list(&dispose);
996 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700998EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001001 * enum d_walk_ret - action to talke during tree walk
1002 * @D_WALK_CONTINUE: contrinue walk
1003 * @D_WALK_QUIT: quit walk
1004 * @D_WALK_NORETRY: quit when retry is needed
1005 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001007enum d_walk_ret {
1008 D_WALK_CONTINUE,
1009 D_WALK_QUIT,
1010 D_WALK_NORETRY,
1011 D_WALK_SKIP,
1012};
1013
1014/**
1015 * d_walk - walk the dentry tree
1016 * @parent: start of walk
1017 * @data: data passed to @enter() and @finish()
1018 * @enter: callback when first entering the dentry
1019 * @finish: callback when successfully finished the walk
1020 *
1021 * The @enter() and @finish() callbacks are called with d_lock held.
1022 */
1023static void d_walk(struct dentry *parent, void *data,
1024 enum d_walk_ret (*enter)(void *, struct dentry *),
1025 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026{
Nick Piggin949854d2011-01-07 17:49:37 +11001027 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001029 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001030 enum d_walk_ret ret;
1031 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001032
Nick Piggin58db63d2011-01-07 17:49:39 +11001033again:
Al Viro48f5ec22013-09-09 15:22:25 -04001034 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001035 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001036 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001037
1038 ret = enter(data, this_parent);
1039 switch (ret) {
1040 case D_WALK_CONTINUE:
1041 break;
1042 case D_WALK_QUIT:
1043 case D_WALK_SKIP:
1044 goto out_unlock;
1045 case D_WALK_NORETRY:
1046 retry = false;
1047 break;
1048 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049repeat:
1050 next = this_parent->d_subdirs.next;
1051resume:
1052 while (next != &this_parent->d_subdirs) {
1053 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001054 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001056
1057 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001058
1059 ret = enter(data, dentry);
1060 switch (ret) {
1061 case D_WALK_CONTINUE:
1062 break;
1063 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001064 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001065 goto out_unlock;
1066 case D_WALK_NORETRY:
1067 retry = false;
1068 break;
1069 case D_WALK_SKIP:
1070 spin_unlock(&dentry->d_lock);
1071 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001072 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001073
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001075 spin_unlock(&this_parent->d_lock);
1076 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001078 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 goto repeat;
1080 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001081 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 }
1083 /*
1084 * All done at this level ... ascend and resume the search.
1085 */
Al Viroca5358e2014-10-26 19:31:10 -04001086 rcu_read_lock();
1087ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001089 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001090 this_parent = child->d_parent;
1091
Al Viro31dec132013-10-25 17:04:27 -04001092 spin_unlock(&child->d_lock);
1093 spin_lock(&this_parent->d_lock);
1094
Al Viroca5358e2014-10-26 19:31:10 -04001095 /* might go back up the wrong parent if we have had a rename. */
1096 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001097 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001098 next = child->d_child.next;
1099 while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED)) {
1100 if (next == &this_parent->d_subdirs)
1101 goto ascend;
1102 child = list_entry(next, struct dentry, d_child);
1103 next = next->next;
Al Viro31dec132013-10-25 17:04:27 -04001104 }
1105 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106 goto resume;
1107 }
Al Viroca5358e2014-10-26 19:31:10 -04001108 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001109 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001110 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001111 if (finish)
1112 finish(data);
1113
1114out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001115 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001116 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001117 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001118
1119rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001120 spin_unlock(&this_parent->d_lock);
1121 rcu_read_unlock();
1122 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001123 if (!retry)
1124 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001125 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001126 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001128
1129/*
1130 * Search for at least 1 mount point in the dentry's subdirs.
1131 * We descend to the next level whenever the d_subdirs
1132 * list is non-empty and continue searching.
1133 */
1134
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001135static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1136{
1137 int *ret = data;
1138 if (d_mountpoint(dentry)) {
1139 *ret = 1;
1140 return D_WALK_QUIT;
1141 }
1142 return D_WALK_CONTINUE;
1143}
1144
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001145/**
1146 * have_submounts - check for mounts over a dentry
1147 * @parent: dentry to check.
1148 *
1149 * Return true if the parent or its subdirectories contain
1150 * a mount point
1151 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001152int have_submounts(struct dentry *parent)
1153{
1154 int ret = 0;
1155
1156 d_walk(parent, &ret, check_mount, NULL);
1157
1158 return ret;
1159}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001160EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161
1162/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001163 * Called by mount code to set a mountpoint and check if the mountpoint is
1164 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1165 * subtree can become unreachable).
1166 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001167 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001168 * this reason take rename_lock and d_lock on dentry and ancestors.
1169 */
1170int d_set_mounted(struct dentry *dentry)
1171{
1172 struct dentry *p;
1173 int ret = -ENOENT;
1174 write_seqlock(&rename_lock);
1175 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001176 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001177 spin_lock(&p->d_lock);
1178 if (unlikely(d_unhashed(p))) {
1179 spin_unlock(&p->d_lock);
1180 goto out;
1181 }
1182 spin_unlock(&p->d_lock);
1183 }
1184 spin_lock(&dentry->d_lock);
1185 if (!d_unlinked(dentry)) {
1186 dentry->d_flags |= DCACHE_MOUNTED;
1187 ret = 0;
1188 }
1189 spin_unlock(&dentry->d_lock);
1190out:
1191 write_sequnlock(&rename_lock);
1192 return ret;
1193}
1194
1195/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001196 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 * and move any unused dentries to the end of the unused
1198 * list for prune_dcache(). We descend to the next level
1199 * whenever the d_subdirs list is non-empty and continue
1200 * searching.
1201 *
1202 * It returns zero iff there are no unused children,
1203 * otherwise it returns the number of children moved to
1204 * the end of the unused list. This may not be the total
1205 * number of unused children, because select_parent can
1206 * drop the lock and return early due to latency
1207 * constraints.
1208 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001209
1210struct select_data {
1211 struct dentry *start;
1212 struct list_head dispose;
1213 int found;
1214};
1215
1216static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001218 struct select_data *data = _data;
1219 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001221 if (data->start == dentry)
1222 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223
Al Virofe915222014-05-03 00:02:25 -04001224 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001225 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001226 } else {
1227 if (dentry->d_flags & DCACHE_LRU_LIST)
1228 d_lru_del(dentry);
1229 if (!dentry->d_lockref.count) {
1230 d_shrink_add(dentry, &data->dispose);
1231 data->found++;
1232 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 }
1234 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001235 * We can return to the caller if we have found some (this
1236 * ensures forward progress). We'll be coming back to find
1237 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 */
Al Virofe915222014-05-03 00:02:25 -04001239 if (!list_empty(&data->dispose))
1240 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001242 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243}
1244
1245/**
1246 * shrink_dcache_parent - prune dcache
1247 * @parent: parent of entries to prune
1248 *
1249 * Prune the dcache to remove unused children of the parent dentry.
1250 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001251void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001253 for (;;) {
1254 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001256 INIT_LIST_HEAD(&data.dispose);
1257 data.start = parent;
1258 data.found = 0;
1259
1260 d_walk(parent, &data, select_collect, NULL);
1261 if (!data.found)
1262 break;
1263
1264 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001265 cond_resched();
1266 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001268EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269
Al Viro9c8c10e2014-05-02 20:36:10 -04001270static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001271{
Al Viro9c8c10e2014-05-02 20:36:10 -04001272 /* it has busy descendents; complain about those instead */
1273 if (!list_empty(&dentry->d_subdirs))
1274 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001275
Al Viro9c8c10e2014-05-02 20:36:10 -04001276 /* root with refcount 1 is fine */
1277 if (dentry == _data && dentry->d_lockref.count == 1)
1278 return D_WALK_CONTINUE;
1279
1280 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1281 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001282 dentry,
1283 dentry->d_inode ?
1284 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001285 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001286 dentry->d_lockref.count,
1287 dentry->d_sb->s_type->name,
1288 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001289 WARN_ON(1);
1290 return D_WALK_CONTINUE;
1291}
1292
1293static void do_one_tree(struct dentry *dentry)
1294{
1295 shrink_dcache_parent(dentry);
1296 d_walk(dentry, dentry, umount_check, NULL);
1297 d_drop(dentry);
1298 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001299}
1300
1301/*
1302 * destroy the dentries attached to a superblock on unmounting
1303 */
1304void shrink_dcache_for_umount(struct super_block *sb)
1305{
1306 struct dentry *dentry;
1307
Al Viro9c8c10e2014-05-02 20:36:10 -04001308 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001309
1310 dentry = sb->s_root;
1311 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001312 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001313
1314 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001315 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1316 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001317 }
1318}
1319
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001320struct detach_data {
1321 struct select_data select;
1322 struct dentry *mountpoint;
1323};
1324static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001325{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001326 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001327
1328 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001329 __dget_dlock(dentry);
1330 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001331 return D_WALK_QUIT;
1332 }
1333
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001334 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001335}
1336
1337static void check_and_drop(void *_data)
1338{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001339 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001340
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001341 if (!data->mountpoint && !data->select.found)
1342 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001343}
1344
1345/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001346 * d_invalidate - detach submounts, prune dcache, and drop
1347 * @dentry: dentry to invalidate (aka detach, prune and drop)
1348 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001349 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001350 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001351 * The final d_drop is done as an atomic operation relative to
1352 * rename_lock ensuring there are no races with d_set_mounted. This
1353 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001354 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001355void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001356{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001357 /*
1358 * If it's already been dropped, return OK.
1359 */
1360 spin_lock(&dentry->d_lock);
1361 if (d_unhashed(dentry)) {
1362 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001363 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001364 }
1365 spin_unlock(&dentry->d_lock);
1366
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001367 /* Negative dentries can be dropped without further checks */
1368 if (!dentry->d_inode) {
1369 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001370 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001371 }
1372
1373 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001374 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001375
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001376 data.mountpoint = NULL;
1377 INIT_LIST_HEAD(&data.select.dispose);
1378 data.select.start = dentry;
1379 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001380
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001381 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001382
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001383 if (data.select.found)
1384 shrink_dentry_list(&data.select.dispose);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001385
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001386 if (data.mountpoint) {
1387 detach_mounts(data.mountpoint);
1388 dput(data.mountpoint);
1389 }
1390
1391 if (!data.mountpoint && !data.select.found)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001392 break;
1393
1394 cond_resched();
1395 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001396}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001397EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001398
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399/**
Al Viroa4464db2011-07-07 15:03:58 -04001400 * __d_alloc - allocate a dcache entry
1401 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 * @name: qstr of the name
1403 *
1404 * Allocates a dentry. It returns %NULL if there is insufficient memory
1405 * available. On a success the dentry is returned. The name passed in is
1406 * copied and the copy passed in may be reused after this call.
1407 */
1408
Al Viroa4464db2011-07-07 15:03:58 -04001409struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410{
1411 struct dentry *dentry;
1412 char *dname;
1413
Mel Gormane12ba742007-10-16 01:25:52 -07001414 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415 if (!dentry)
1416 return NULL;
1417
Linus Torvalds6326c712012-05-21 16:14:04 -07001418 /*
1419 * We guarantee that the inline name is always NUL-terminated.
1420 * This way the memcpy() done by the name switching in rename
1421 * will still always have a NUL at the end, even if we might
1422 * be overwriting an internal NUL character
1423 */
1424 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001426 size_t size = offsetof(struct external_name, name[1]);
1427 struct external_name *p = kmalloc(size + name->len, GFP_KERNEL);
1428 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 kmem_cache_free(dentry_cache, dentry);
1430 return NULL;
1431 }
Al Viro8d85b482014-09-29 14:54:27 -04001432 atomic_set(&p->u.count, 1);
1433 dname = p->name;
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -08001434 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1435 kasan_unpoison_shadow(dname,
1436 round_up(name->len + 1, sizeof(unsigned long)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 } else {
1438 dname = dentry->d_iname;
1439 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
1441 dentry->d_name.len = name->len;
1442 dentry->d_name.hash = name->hash;
1443 memcpy(dname, name->name, name->len);
1444 dname[name->len] = 0;
1445
Linus Torvalds6326c712012-05-21 16:14:04 -07001446 /* Make sure we always see the terminating NUL character */
1447 smp_wmb();
1448 dentry->d_name.name = dname;
1449
Waiman Long98474232013-08-28 18:24:59 -07001450 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001451 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001453 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001455 dentry->d_parent = dentry;
1456 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 dentry->d_op = NULL;
1458 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001459 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460 INIT_LIST_HEAD(&dentry->d_lru);
1461 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001462 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1463 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001464 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465
Nick Piggin3e880fb2011-01-07 17:49:19 +11001466 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001467
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 return dentry;
1469}
Al Viroa4464db2011-07-07 15:03:58 -04001470
1471/**
1472 * d_alloc - allocate a dcache entry
1473 * @parent: parent of entry to allocate
1474 * @name: qstr of the name
1475 *
1476 * Allocates a dentry. It returns %NULL if there is insufficient memory
1477 * available. On a success the dentry is returned. The name passed in is
1478 * copied and the copy passed in may be reused after this call.
1479 */
1480struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1481{
1482 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1483 if (!dentry)
1484 return NULL;
1485
1486 spin_lock(&parent->d_lock);
1487 /*
1488 * don't need child lock because it is not subject
1489 * to concurrency here
1490 */
1491 __dget_dlock(parent);
1492 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001493 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001494 spin_unlock(&parent->d_lock);
1495
1496 return dentry;
1497}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001498EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001500/**
1501 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1502 * @sb: the superblock
1503 * @name: qstr of the name
1504 *
1505 * For a filesystem that just pins its dentries in memory and never
1506 * performs lookups at all, return an unhashed IS_ROOT dentry.
1507 */
Nick Piggin4b936882011-01-07 17:50:07 +11001508struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1509{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001510 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001511}
1512EXPORT_SYMBOL(d_alloc_pseudo);
1513
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1515{
1516 struct qstr q;
1517
1518 q.name = name;
1519 q.len = strlen(name);
1520 q.hash = full_name_hash(q.name, q.len);
1521 return d_alloc(parent, &q);
1522}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001523EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524
Nick Pigginfb045ad2011-01-07 17:49:55 +11001525void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1526{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001527 WARN_ON_ONCE(dentry->d_op);
1528 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001529 DCACHE_OP_COMPARE |
1530 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001531 DCACHE_OP_WEAK_REVALIDATE |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001532 DCACHE_OP_DELETE ));
1533 dentry->d_op = op;
1534 if (!op)
1535 return;
1536 if (op->d_hash)
1537 dentry->d_flags |= DCACHE_OP_HASH;
1538 if (op->d_compare)
1539 dentry->d_flags |= DCACHE_OP_COMPARE;
1540 if (op->d_revalidate)
1541 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001542 if (op->d_weak_revalidate)
1543 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001544 if (op->d_delete)
1545 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001546 if (op->d_prune)
1547 dentry->d_flags |= DCACHE_OP_PRUNE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001548
1549}
1550EXPORT_SYMBOL(d_set_d_op);
1551
David Howellsb18825a2013-09-12 19:22:53 +01001552static unsigned d_flags_for_inode(struct inode *inode)
1553{
1554 unsigned add_flags = DCACHE_FILE_TYPE;
1555
1556 if (!inode)
1557 return DCACHE_MISS_TYPE;
1558
1559 if (S_ISDIR(inode->i_mode)) {
1560 add_flags = DCACHE_DIRECTORY_TYPE;
1561 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1562 if (unlikely(!inode->i_op->lookup))
1563 add_flags = DCACHE_AUTODIR_TYPE;
1564 else
1565 inode->i_opflags |= IOP_LOOKUP;
1566 }
1567 } else if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
1568 if (unlikely(inode->i_op->follow_link))
1569 add_flags = DCACHE_SYMLINK_TYPE;
1570 else
1571 inode->i_opflags |= IOP_NOFOLLOW;
1572 }
1573
1574 if (unlikely(IS_AUTOMOUNT(inode)))
1575 add_flags |= DCACHE_NEED_AUTOMOUNT;
1576 return add_flags;
1577}
1578
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001579static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1580{
David Howellsb18825a2013-09-12 19:22:53 +01001581 unsigned add_flags = d_flags_for_inode(inode);
1582
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001583 spin_lock(&dentry->d_lock);
Al Viro22213312014-04-19 12:30:58 -04001584 __d_set_type(dentry, add_flags);
David Howellsb18825a2013-09-12 19:22:53 +01001585 if (inode)
Al Viro946e51f2014-10-26 19:19:16 -04001586 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001587 dentry->d_inode = inode;
Nick Piggin31e6b012011-01-07 17:49:52 +11001588 dentry_rcuwalk_barrier(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001589 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001590 fsnotify_d_instantiate(dentry, inode);
1591}
1592
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593/**
1594 * d_instantiate - fill in inode information for a dentry
1595 * @entry: dentry to complete
1596 * @inode: inode to attach to this dentry
1597 *
1598 * Fill in inode information in the entry.
1599 *
1600 * This turns negative dentries into productive full members
1601 * of society.
1602 *
1603 * NOTE! This assumes that the inode count has been incremented
1604 * (or otherwise set) by the caller to indicate that it is now
1605 * in use by the dcache.
1606 */
1607
1608void d_instantiate(struct dentry *entry, struct inode * inode)
1609{
Al Viro946e51f2014-10-26 19:19:16 -04001610 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Nick Piggin873feea2011-01-07 17:50:06 +11001611 if (inode)
1612 spin_lock(&inode->i_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001613 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001614 if (inode)
1615 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616 security_d_instantiate(entry, inode);
1617}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001618EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619
1620/**
1621 * d_instantiate_unique - instantiate a non-aliased dentry
1622 * @entry: dentry to instantiate
1623 * @inode: inode to attach to this dentry
1624 *
1625 * Fill in inode information in the entry. On success, it returns NULL.
1626 * If an unhashed alias of "entry" already exists, then we return the
Oleg Drokine866cfa2006-01-09 20:52:51 -08001627 * aliased dentry instead and drop one reference to inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 *
1629 * Note that in order to avoid conflicts with rename() etc, the caller
1630 * had better be holding the parent directory semaphore.
Oleg Drokine866cfa2006-01-09 20:52:51 -08001631 *
1632 * This also assumes that the inode count has been incremented
1633 * (or otherwise set) by the caller to indicate that it is now
1634 * in use by the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 */
David Howells770bfad2006-08-22 20:06:07 -04001636static struct dentry *__d_instantiate_unique(struct dentry *entry,
1637 struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638{
1639 struct dentry *alias;
1640 int len = entry->d_name.len;
1641 const char *name = entry->d_name.name;
1642 unsigned int hash = entry->d_name.hash;
1643
David Howells770bfad2006-08-22 20:06:07 -04001644 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001645 __d_instantiate(entry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001646 return NULL;
1647 }
1648
Al Viro946e51f2014-10-26 19:19:16 -04001649 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Piggin9abca362011-01-07 17:49:36 +11001650 /*
1651 * Don't need alias->d_lock here, because aliases with
1652 * d_parent == entry->d_parent are not subject to name or
1653 * parent changes, because the parent inode i_mutex is held.
1654 */
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001655 if (alias->d_name.hash != hash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656 continue;
1657 if (alias->d_parent != entry->d_parent)
1658 continue;
Linus Torvaldsee983e82012-05-10 12:37:10 -07001659 if (alias->d_name.len != len)
1660 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001661 if (dentry_cmp(alias, name, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 continue;
Nick Piggindc0474b2011-01-07 17:49:43 +11001663 __dget(alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 return alias;
1665 }
David Howells770bfad2006-08-22 20:06:07 -04001666
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001667 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 return NULL;
1669}
David Howells770bfad2006-08-22 20:06:07 -04001670
1671struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1672{
1673 struct dentry *result;
1674
Al Viro946e51f2014-10-26 19:19:16 -04001675 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
David Howells770bfad2006-08-22 20:06:07 -04001676
Nick Piggin873feea2011-01-07 17:50:06 +11001677 if (inode)
1678 spin_lock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001679 result = __d_instantiate_unique(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001680 if (inode)
1681 spin_unlock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001682
1683 if (!result) {
1684 security_d_instantiate(entry, inode);
1685 return NULL;
1686 }
1687
1688 BUG_ON(!d_unhashed(result));
1689 iput(inode);
1690 return result;
1691}
1692
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693EXPORT_SYMBOL(d_instantiate_unique);
1694
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001695/**
1696 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1697 * @entry: dentry to complete
1698 * @inode: inode to attach to this dentry
1699 *
1700 * Fill in inode information in the entry. If a directory alias is found, then
1701 * return an error (and drop inode). Together with d_materialise_unique() this
1702 * guarantees that a directory inode may never have more than one alias.
1703 */
1704int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1705{
Al Viro946e51f2014-10-26 19:19:16 -04001706 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001707
1708 spin_lock(&inode->i_lock);
1709 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1710 spin_unlock(&inode->i_lock);
1711 iput(inode);
1712 return -EBUSY;
1713 }
1714 __d_instantiate(entry, inode);
1715 spin_unlock(&inode->i_lock);
1716 security_d_instantiate(entry, inode);
1717
1718 return 0;
1719}
1720EXPORT_SYMBOL(d_instantiate_no_diralias);
1721
Al Viroadc0e912012-01-08 16:49:21 -05001722struct dentry *d_make_root(struct inode *root_inode)
1723{
1724 struct dentry *res = NULL;
1725
1726 if (root_inode) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07001727 static const struct qstr name = QSTR_INIT("/", 1);
Al Viroadc0e912012-01-08 16:49:21 -05001728
1729 res = __d_alloc(root_inode->i_sb, &name);
1730 if (res)
1731 d_instantiate(res, root_inode);
1732 else
1733 iput(root_inode);
1734 }
1735 return res;
1736}
1737EXPORT_SYMBOL(d_make_root);
1738
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001739static struct dentry * __d_find_any_alias(struct inode *inode)
1740{
1741 struct dentry *alias;
1742
Al Virob3d9b7a2012-06-09 13:51:19 -04001743 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001744 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001745 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001746 __dget(alias);
1747 return alias;
1748}
1749
Sage Weil46f72b32012-01-10 09:04:37 -08001750/**
1751 * d_find_any_alias - find any alias for a given inode
1752 * @inode: inode to find an alias for
1753 *
1754 * If any aliases exist for the given inode, take and return a
1755 * reference for one of them. If no aliases exist, return %NULL.
1756 */
1757struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001758{
1759 struct dentry *de;
1760
1761 spin_lock(&inode->i_lock);
1762 de = __d_find_any_alias(inode);
1763 spin_unlock(&inode->i_lock);
1764 return de;
1765}
Sage Weil46f72b32012-01-10 09:04:37 -08001766EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001767
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001768static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001769{
NeilBrownb911a6b2012-11-08 16:09:37 -08001770 static const struct qstr anonstring = QSTR_INIT("/", 1);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001771 struct dentry *tmp;
1772 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001773 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001774
1775 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001776 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001777 if (IS_ERR(inode))
1778 return ERR_CAST(inode);
1779
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001780 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001781 if (res)
1782 goto out_iput;
1783
Al Viroa4464db2011-07-07 15:03:58 -04001784 tmp = __d_alloc(inode->i_sb, &anonstring);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001785 if (!tmp) {
1786 res = ERR_PTR(-ENOMEM);
1787 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001788 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001789
Nick Piggin873feea2011-01-07 17:50:06 +11001790 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001791 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001792 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001793 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001794 dput(tmp);
1795 goto out_iput;
1796 }
1797
1798 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001799 add_flags = d_flags_for_inode(inode);
1800
1801 if (disconnected)
1802 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001803
Christoph Hellwig9308a612008-08-11 15:49:12 +02001804 spin_lock(&tmp->d_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001805 tmp->d_inode = inode;
David Howellsb18825a2013-09-12 19:22:53 +01001806 tmp->d_flags |= add_flags;
Al Viro946e51f2014-10-26 19:19:16 -04001807 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001808 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001809 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001810 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001811 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001812 spin_unlock(&inode->i_lock);
Josef Bacik24ff6662010-11-18 20:52:55 -05001813 security_d_instantiate(tmp, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001814
Christoph Hellwig9308a612008-08-11 15:49:12 +02001815 return tmp;
1816
1817 out_iput:
Josef Bacik24ff6662010-11-18 20:52:55 -05001818 if (res && !IS_ERR(res))
1819 security_d_instantiate(res, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001820 iput(inode);
1821 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001822}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001823
1824/**
1825 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1826 * @inode: inode to allocate the dentry for
1827 *
1828 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1829 * similar open by handle operations. The returned dentry may be anonymous,
1830 * or may have a full name (if the inode was already in the cache).
1831 *
1832 * When called on a directory inode, we must ensure that the inode only ever
1833 * has one dentry. If a dentry is found, that is returned instead of
1834 * allocating a new one.
1835 *
1836 * On successful return, the reference to the inode has been transferred
1837 * to the dentry. In case of an error the reference on the inode is released.
1838 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1839 * be passed in and the error will be propagated to the return value,
1840 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1841 */
1842struct dentry *d_obtain_alias(struct inode *inode)
1843{
1844 return __d_obtain_alias(inode, 1);
1845}
Benny Halevyadc48722009-02-27 14:02:59 -08001846EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847
1848/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001849 * d_obtain_root - find or allocate a dentry for a given inode
1850 * @inode: inode to allocate the dentry for
1851 *
1852 * Obtain an IS_ROOT dentry for the root of a filesystem.
1853 *
1854 * We must ensure that directory inodes only ever have one dentry. If a
1855 * dentry is found, that is returned instead of allocating a new one.
1856 *
1857 * On successful return, the reference to the inode has been transferred
1858 * to the dentry. In case of an error the reference on the inode is
1859 * released. A %NULL or IS_ERR inode may be passed in and will be the
1860 * error will be propagate to the return value, with a %NULL @inode
1861 * replaced by ERR_PTR(-ESTALE).
1862 */
1863struct dentry *d_obtain_root(struct inode *inode)
1864{
1865 return __d_obtain_alias(inode, 0);
1866}
1867EXPORT_SYMBOL(d_obtain_root);
1868
1869/**
Barry Naujok94035402008-05-21 16:50:46 +10001870 * d_add_ci - lookup or allocate new dentry with case-exact name
1871 * @inode: the inode case-insensitive lookup has found
1872 * @dentry: the negative dentry that was passed to the parent's lookup func
1873 * @name: the case-exact name to be associated with the returned dentry
1874 *
1875 * This is to avoid filling the dcache with case-insensitive names to the
1876 * same inode, only the actual correct case is stored in the dcache for
1877 * case-insensitive filesystems.
1878 *
1879 * For a case-insensitive lookup match and if the the case-exact dentry
1880 * already exists in in the dcache, use it and return it.
1881 *
1882 * If no entry exists with the exact case name, allocate new dentry with
1883 * the exact case, and return the spliced entry.
1884 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001885struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001886 struct qstr *name)
1887{
Barry Naujok94035402008-05-21 16:50:46 +10001888 struct dentry *found;
1889 struct dentry *new;
1890
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001891 /*
1892 * First check if a dentry matching the name already exists,
1893 * if not go ahead and create it now.
1894 */
Barry Naujok94035402008-05-21 16:50:46 +10001895 found = d_hash_and_lookup(dentry->d_parent, name);
Barry Naujok94035402008-05-21 16:50:46 +10001896 if (!found) {
1897 new = d_alloc(dentry->d_parent, name);
1898 if (!new) {
Al Viro4f522a22013-02-11 23:20:37 -05001899 found = ERR_PTR(-ENOMEM);
Al Viro427c77d2014-10-12 18:46:26 -04001900 } else {
1901 found = d_splice_alias(inode, new);
1902 if (found) {
1903 dput(new);
1904 return found;
1905 }
1906 return new;
Barry Naujok94035402008-05-21 16:50:46 +10001907 }
Barry Naujok94035402008-05-21 16:50:46 +10001908 }
Barry Naujok94035402008-05-21 16:50:46 +10001909 iput(inode);
Al Viro4f522a22013-02-11 23:20:37 -05001910 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001911}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001912EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001914/*
1915 * Do the slow-case of the dentry name compare.
1916 *
1917 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07001918 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001919 * filesystem can rely on them, and can use the 'name' and
1920 * 'len' information without worrying about walking off the
1921 * end of memory etc.
1922 *
1923 * Thus the read_seqcount_retry() and the "duplicate" info
1924 * in arguments (the low-level filesystem should not look
1925 * at the dentry inode or name contents directly, since
1926 * rename can change them while we're in RCU mode).
1927 */
1928enum slow_d_compare {
1929 D_COMP_OK,
1930 D_COMP_NOMATCH,
1931 D_COMP_SEQRETRY,
1932};
1933
1934static noinline enum slow_d_compare slow_dentry_cmp(
1935 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001936 struct dentry *dentry,
1937 unsigned int seq,
1938 const struct qstr *name)
1939{
1940 int tlen = dentry->d_name.len;
1941 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001942
1943 if (read_seqcount_retry(&dentry->d_seq, seq)) {
1944 cpu_relax();
1945 return D_COMP_SEQRETRY;
1946 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07001947 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001948 return D_COMP_NOMATCH;
1949 return D_COMP_OK;
1950}
1951
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952/**
Nick Piggin31e6b012011-01-07 17:49:52 +11001953 * __d_lookup_rcu - search for a dentry (racy, store-free)
1954 * @parent: parent dentry
1955 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07001956 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11001957 * Returns: dentry, or NULL
1958 *
1959 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
1960 * resolution (store-free path walking) design described in
1961 * Documentation/filesystems/path-lookup.txt.
1962 *
1963 * This is not to be used outside core vfs.
1964 *
1965 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
1966 * held, and rcu_read_lock held. The returned dentry must not be stored into
1967 * without taking d_lock and checking d_seq sequence count against @seq
1968 * returned here.
1969 *
Linus Torvalds15570082013-09-02 11:38:06 -07001970 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11001971 * function.
1972 *
1973 * Alternatively, __d_lookup_rcu may be called again to look up the child of
1974 * the returned dentry, so long as its parent's seqlock is checked after the
1975 * child is looked up. Thus, an interlocking stepping of sequence lock checks
1976 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001977 *
1978 * NOTE! The caller *has* to check the resulting dentry against the sequence
1979 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11001980 */
Linus Torvalds8966be92012-03-02 14:23:30 -08001981struct dentry *__d_lookup_rcu(const struct dentry *parent,
1982 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07001983 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11001984{
Linus Torvalds26fe5752012-05-10 13:14:12 -07001985 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11001986 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07001987 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001988 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11001989 struct dentry *dentry;
1990
1991 /*
1992 * Note: There is significant duplication with __d_lookup_rcu which is
1993 * required to prevent single threaded performance regressions
1994 * especially on architectures where smp_rmb (in seqcounts) are costly.
1995 * Keep the two functions in sync.
1996 */
1997
1998 /*
1999 * The hash list is protected using RCU.
2000 *
2001 * Carefully use d_seq when comparing a candidate dentry, to avoid
2002 * races with d_move().
2003 *
2004 * It is possible that concurrent renames can mess up our list
2005 * walk here and result in missing our dentry, resulting in the
2006 * false-negative result. d_lookup() protects against concurrent
2007 * renames using rename_lock seqlock.
2008 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002009 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002010 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002011 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002012 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002013
Nick Piggin31e6b012011-01-07 17:49:52 +11002014seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002015 /*
2016 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002017 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002018 *
2019 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002020 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002021 *
2022 * NOTE! We do a "raw" seqcount_begin here. That means that
2023 * we don't wait for the sequence count to stabilize if it
2024 * is in the middle of a sequence change. If we do the slow
2025 * dentry compare, we will do seqretries until it is stable,
2026 * and if we end up with a successful lookup, we actually
2027 * want to exit RCU lookup anyway.
2028 */
2029 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002030 if (dentry->d_parent != parent)
2031 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002032 if (d_unhashed(dentry))
2033 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002034
2035 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002036 if (dentry->d_name.hash != hashlen_hash(hashlen))
2037 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002038 *seqp = seq;
2039 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002040 case D_COMP_OK:
2041 return dentry;
2042 case D_COMP_NOMATCH:
2043 continue;
2044 default:
2045 goto seqretry;
2046 }
2047 }
2048
Linus Torvalds26fe5752012-05-10 13:14:12 -07002049 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002050 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002051 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002052 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002053 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002054 }
2055 return NULL;
2056}
2057
2058/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059 * d_lookup - search for a dentry
2060 * @parent: parent dentry
2061 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002062 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002064 * d_lookup searches the children of the parent dentry for the name in
2065 * question. If the dentry is found its reference count is incremented and the
2066 * dentry is returned. The caller must use dput to free the entry when it has
2067 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 */
Al Viroda2d8452013-01-24 18:29:34 -05002069struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070{
Nick Piggin31e6b012011-01-07 17:49:52 +11002071 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002072 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073
Daeseok Younb8314f92014-08-11 11:46:53 +09002074 do {
2075 seq = read_seqbegin(&rename_lock);
2076 dentry = __d_lookup(parent, name);
2077 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 break;
2079 } while (read_seqretry(&rename_lock, seq));
2080 return dentry;
2081}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002082EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083
Nick Piggin31e6b012011-01-07 17:49:52 +11002084/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002085 * __d_lookup - search for a dentry (racy)
2086 * @parent: parent dentry
2087 * @name: qstr of name we wish to find
2088 * Returns: dentry, or NULL
2089 *
2090 * __d_lookup is like d_lookup, however it may (rarely) return a
2091 * false-negative result due to unrelated rename activity.
2092 *
2093 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2094 * however it must be used carefully, eg. with a following d_lookup in
2095 * the case of failure.
2096 *
2097 * __d_lookup callers must be commented.
2098 */
Al Viroa713ca22013-01-24 18:27:00 -05002099struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100{
2101 unsigned int len = name->len;
2102 unsigned int hash = name->hash;
2103 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002104 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002105 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002106 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002107 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108
Nick Pigginb04f7842010-08-18 04:37:34 +10002109 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002110 * Note: There is significant duplication with __d_lookup_rcu which is
2111 * required to prevent single threaded performance regressions
2112 * especially on architectures where smp_rmb (in seqcounts) are costly.
2113 * Keep the two functions in sync.
2114 */
2115
2116 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002117 * The hash list is protected using RCU.
2118 *
2119 * Take d_lock when comparing a candidate dentry, to avoid races
2120 * with d_move().
2121 *
2122 * It is possible that concurrent renames can mess up our list
2123 * walk here and result in missing our dentry, resulting in the
2124 * false-negative result. d_lookup() protects against concurrent
2125 * renames using rename_lock seqlock.
2126 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002127 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002128 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 rcu_read_lock();
2130
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002131 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 if (dentry->d_name.hash != hash)
2134 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135
2136 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 if (dentry->d_parent != parent)
2138 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002139 if (d_unhashed(dentry))
2140 goto next;
2141
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 /*
2143 * It is safe to compare names since d_move() cannot
2144 * change the qstr (protected by d_lock).
2145 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002146 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002147 int tlen = dentry->d_name.len;
2148 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002149 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 goto next;
2151 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002152 if (dentry->d_name.len != len)
2153 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002154 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155 goto next;
2156 }
2157
Waiman Long98474232013-08-28 18:24:59 -07002158 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002159 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 spin_unlock(&dentry->d_lock);
2161 break;
2162next:
2163 spin_unlock(&dentry->d_lock);
2164 }
2165 rcu_read_unlock();
2166
2167 return found;
2168}
2169
2170/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002171 * d_hash_and_lookup - hash the qstr then search for a dentry
2172 * @dir: Directory to search in
2173 * @name: qstr of name we wish to find
2174 *
Al Viro4f522a22013-02-11 23:20:37 -05002175 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002176 */
2177struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2178{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002179 /*
2180 * Check for a fs-specific hash function. Note that we must
2181 * calculate the standard hash first, as the d_op->d_hash()
2182 * routine may choose to leave the hash value unchanged.
2183 */
2184 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002185 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002186 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002187 if (unlikely(err < 0))
2188 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002189 }
Al Viro4f522a22013-02-11 23:20:37 -05002190 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002191}
Al Viro4f522a22013-02-11 23:20:37 -05002192EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002193
2194/**
Nick Piggin786a5e12011-01-07 17:49:16 +11002195 * d_validate - verify dentry provided from insecure source (deprecated)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196 * @dentry: The dentry alleged to be valid child of @dparent
Randy Dunlapff5fdb62011-01-22 20:16:06 -08002197 * @dparent: The parent dentry (known to be valid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 *
2199 * An insecure source has sent us a dentry, here we verify it and dget() it.
2200 * This is used by ncpfs in its readdir implementation.
2201 * Zero is returned in the dentry is invalid.
Nick Piggin786a5e12011-01-07 17:49:16 +11002202 *
2203 * This function is slow for big directories, and deprecated, do not use it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 */
Nick Piggind3a23e12011-01-05 20:01:21 +11002205int d_validate(struct dentry *dentry, struct dentry *dparent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206{
Nick Piggin786a5e12011-01-07 17:49:16 +11002207 struct dentry *child;
Nick Piggind3a23e12011-01-05 20:01:21 +11002208
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002209 spin_lock(&dparent->d_lock);
Al Viro946e51f2014-10-26 19:19:16 -04002210 list_for_each_entry(child, &dparent->d_subdirs, d_child) {
Nick Piggin786a5e12011-01-07 17:49:16 +11002211 if (dentry == child) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002212 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Nick Piggindc0474b2011-01-07 17:49:43 +11002213 __dget_dlock(dentry);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002214 spin_unlock(&dentry->d_lock);
2215 spin_unlock(&dparent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 return 1;
2217 }
2218 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002219 spin_unlock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002220
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 return 0;
2222}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002223EXPORT_SYMBOL(d_validate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224
2225/*
2226 * When a file is deleted, we have two options:
2227 * - turn this dentry into a negative dentry
2228 * - unhash this dentry and free it.
2229 *
2230 * Usually, we want to just turn this into
2231 * a negative dentry, but if anybody else is
2232 * currently using the dentry or the inode
2233 * we can't do that and we fall back on removing
2234 * it from the hash queues and waiting for
2235 * it to be deleted later when it has no users
2236 */
2237
2238/**
2239 * d_delete - delete a dentry
2240 * @dentry: The dentry to delete
2241 *
2242 * Turn the dentry into a negative dentry if possible, otherwise
2243 * remove it from the hash queues so it can be deleted later
2244 */
2245
2246void d_delete(struct dentry * dentry)
2247{
Nick Piggin873feea2011-01-07 17:50:06 +11002248 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002249 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 /*
2251 * Are we the only user?
2252 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002253again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002255 inode = dentry->d_inode;
2256 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002257 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002258 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002259 spin_unlock(&dentry->d_lock);
2260 cpu_relax();
2261 goto again;
2262 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002263 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002264 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002265 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 return;
2267 }
2268
2269 if (!d_unhashed(dentry))
2270 __d_drop(dentry);
2271
2272 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002273
2274 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002276EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002278static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002280 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002281 hlist_bl_lock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -07002282 entry->d_flags |= DCACHE_RCUACCESS;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002283 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002284 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285}
2286
David Howells770bfad2006-08-22 20:06:07 -04002287static void _d_rehash(struct dentry * entry)
2288{
2289 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2290}
2291
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292/**
2293 * d_rehash - add an entry back to the hash
2294 * @entry: dentry to add to the hash
2295 *
2296 * Adds a dentry to the hash according to its name.
2297 */
2298
2299void d_rehash(struct dentry * entry)
2300{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002302 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002305EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002307/**
2308 * dentry_update_name_case - update case insensitive dentry with a new name
2309 * @dentry: dentry to be updated
2310 * @name: new name
2311 *
2312 * Update a case insensitive dentry with new case of name.
2313 *
2314 * dentry must have been returned by d_lookup with name @name. Old and new
2315 * name lengths must match (ie. no d_compare which allows mismatched name
2316 * lengths).
2317 *
2318 * Parent inode i_mutex must be held over d_lookup and into this call (to
2319 * keep renames and concurrent inserts, and readdir(2) away).
2320 */
2321void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2322{
Linus Torvalds7ebfa572011-04-15 07:34:26 -07002323 BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002324 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2325
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002326 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002327 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002328 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002329 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002330 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002331}
2332EXPORT_SYMBOL(dentry_update_name_case);
2333
Al Viro8d85b482014-09-29 14:54:27 -04002334static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335{
Al Viro8d85b482014-09-29 14:54:27 -04002336 if (unlikely(dname_external(target))) {
2337 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338 /*
2339 * Both external: swap the pointers
2340 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002341 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342 } else {
2343 /*
2344 * dentry:internal, target:external. Steal target's
2345 * storage and make target internal.
2346 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002347 memcpy(target->d_iname, dentry->d_name.name,
2348 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 dentry->d_name.name = target->d_name.name;
2350 target->d_name.name = target->d_iname;
2351 }
2352 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002353 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354 /*
2355 * dentry:external, target:internal. Give dentry's
2356 * storage to target and make dentry internal
2357 */
2358 memcpy(dentry->d_iname, target->d_name.name,
2359 target->d_name.len + 1);
2360 target->d_name.name = dentry->d_name.name;
2361 dentry->d_name.name = dentry->d_iname;
2362 } else {
2363 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002364 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002366 unsigned int i;
2367 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
Mikulas Patocka08d4f772014-09-05 12:16:01 -04002368 kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
2369 kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002370 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2371 swap(((long *) &dentry->d_iname)[i],
2372 ((long *) &target->d_iname)[i]);
2373 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 }
2375 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002376 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377}
2378
Al Viro8d85b482014-09-29 14:54:27 -04002379static void copy_name(struct dentry *dentry, struct dentry *target)
2380{
2381 struct external_name *old_name = NULL;
2382 if (unlikely(dname_external(dentry)))
2383 old_name = external_name(dentry);
2384 if (unlikely(dname_external(target))) {
2385 atomic_inc(&external_name(target)->u.count);
2386 dentry->d_name = target->d_name;
2387 } else {
2388 memcpy(dentry->d_iname, target->d_name.name,
2389 target->d_name.len + 1);
2390 dentry->d_name.name = dentry->d_iname;
2391 dentry->d_name.hash_len = target->d_name.hash_len;
2392 }
2393 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2394 kfree_rcu(old_name, u.head);
2395}
2396
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002397static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2398{
2399 /*
2400 * XXXX: do we really need to take target->d_lock?
2401 */
2402 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2403 spin_lock(&target->d_parent->d_lock);
2404 else {
2405 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2406 spin_lock(&dentry->d_parent->d_lock);
2407 spin_lock_nested(&target->d_parent->d_lock,
2408 DENTRY_D_LOCK_NESTED);
2409 } else {
2410 spin_lock(&target->d_parent->d_lock);
2411 spin_lock_nested(&dentry->d_parent->d_lock,
2412 DENTRY_D_LOCK_NESTED);
2413 }
2414 }
2415 if (target < dentry) {
2416 spin_lock_nested(&target->d_lock, 2);
2417 spin_lock_nested(&dentry->d_lock, 3);
2418 } else {
2419 spin_lock_nested(&dentry->d_lock, 2);
2420 spin_lock_nested(&target->d_lock, 3);
2421 }
2422}
2423
Al Viro986c0192014-09-26 23:11:15 -04002424static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002425{
2426 if (target->d_parent != dentry->d_parent)
2427 spin_unlock(&dentry->d_parent->d_lock);
2428 if (target->d_parent != target)
2429 spin_unlock(&target->d_parent->d_lock);
Al Viro986c0192014-09-26 23:11:15 -04002430 spin_unlock(&target->d_lock);
2431 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002432}
2433
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002435 * When switching names, the actual string doesn't strictly have to
2436 * be preserved in the target - because we're dropping the target
2437 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002438 * the new name before we switch, unless we are going to rehash
2439 * it. Note that if we *do* unhash the target, we are not allowed
2440 * to rehash it without giving it a new name/hash key - whether
2441 * we swap or overwrite the names here, resulting name won't match
2442 * the reality in filesystem; it's only there for d_path() purposes.
2443 * Note that all of this is happening under rename_lock, so the
2444 * any hash lookup seeing it in the middle of manipulations will
2445 * be discarded anyway. So we do not care what happens to the hash
2446 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002448/*
Al Viro18367502011-07-12 21:42:24 -04002449 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450 * @dentry: entry to move
2451 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002452 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453 *
2454 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002455 * dcache entries should not be moved in this way. Caller must hold
2456 * rename_lock, the i_mutex of the source and target directories,
2457 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002458 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002459static void __d_move(struct dentry *dentry, struct dentry *target,
2460 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462 if (!dentry->d_inode)
2463 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2464
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002465 BUG_ON(d_ancestor(dentry, target));
2466 BUG_ON(d_ancestor(target, dentry));
2467
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002468 dentry_lock_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469
Nick Piggin31e6b012011-01-07 17:49:52 +11002470 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002471 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002472
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002473 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2474
2475 /*
2476 * Move the dentry to the target hash queue. Don't bother checking
2477 * for the same hash queue because of how unlikely it is.
2478 */
2479 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002480 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481
Miklos Szeredida1ce062014-04-01 17:08:43 +02002482 /*
2483 * Unhash the target (d_delete() is not usable here). If exchanging
2484 * the two dentries, then rehash onto the other's hash queue.
2485 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486 __d_drop(target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002487 if (exchange) {
2488 __d_rehash(target,
2489 d_hash(dentry->d_parent, dentry->d_name.hash));
2490 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002493 if (exchange)
2494 swap_names(dentry, target);
2495 else
2496 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497
Al Viro63cf4272014-09-26 23:06:14 -04002498 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002499 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002500 /* splicing a tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501 dentry->d_parent = target->d_parent;
2502 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002503 list_del_init(&target->d_child);
2504 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002505 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002506 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002507 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002508 list_move(&target->d_child, &target->d_parent->d_subdirs);
2509 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002510 if (exchange)
2511 fsnotify_d_move(target);
2512 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002513 }
2514
Nick Piggin31e6b012011-01-07 17:49:52 +11002515 write_seqcount_end(&target->d_seq);
2516 write_seqcount_end(&dentry->d_seq);
2517
Al Viro986c0192014-09-26 23:11:15 -04002518 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002519}
2520
2521/*
2522 * d_move - move a dentry
2523 * @dentry: entry to move
2524 * @target: new dentry
2525 *
2526 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002527 * dcache entries should not be moved in this way. See the locking
2528 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002529 */
2530void d_move(struct dentry *dentry, struct dentry *target)
2531{
2532 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002533 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002535}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002536EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537
Miklos Szeredida1ce062014-04-01 17:08:43 +02002538/*
2539 * d_exchange - exchange two dentries
2540 * @dentry1: first dentry
2541 * @dentry2: second dentry
2542 */
2543void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2544{
2545 write_seqlock(&rename_lock);
2546
2547 WARN_ON(!dentry1->d_inode);
2548 WARN_ON(!dentry2->d_inode);
2549 WARN_ON(IS_ROOT(dentry1));
2550 WARN_ON(IS_ROOT(dentry2));
2551
2552 __d_move(dentry1, dentry2, true);
2553
2554 write_sequnlock(&rename_lock);
2555}
2556
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002557/**
2558 * d_ancestor - search for an ancestor
2559 * @p1: ancestor dentry
2560 * @p2: child dentry
2561 *
2562 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2563 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002564 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002565struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002566{
2567 struct dentry *p;
2568
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002569 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002570 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002571 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002572 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002573 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002574}
2575
2576/*
2577 * This helper attempts to cope with remotely renamed directories
2578 *
2579 * It assumes that the caller is already holding
Al Viro18367502011-07-12 21:42:24 -04002580 * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002581 *
2582 * Note: If ever the locking in lock_rename() changes, then please
2583 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002584 */
Al Virob5ae6b12014-10-12 22:16:02 -04002585static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002586 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002587{
2588 struct mutex *m1 = NULL, *m2 = NULL;
Al Virob5ae6b12014-10-12 22:16:02 -04002589 int ret = -EBUSY;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002590
2591 /* If alias and dentry share a parent, then no extra locks required */
2592 if (alias->d_parent == dentry->d_parent)
2593 goto out_unalias;
2594
Trond Myklebust9eaef272006-10-21 10:24:20 -07002595 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002596 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2597 goto out_err;
2598 m1 = &dentry->d_sb->s_vfs_rename_mutex;
2599 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
2600 goto out_err;
2601 m2 = &alias->d_parent->d_inode->i_mutex;
2602out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002603 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002604 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002605out_err:
Nick Piggin873feea2011-01-07 17:50:06 +11002606 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002607 if (m2)
2608 mutex_unlock(m2);
2609 if (m1)
2610 mutex_unlock(m1);
2611 return ret;
2612}
2613
David Howells770bfad2006-08-22 20:06:07 -04002614/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002615 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2616 * @inode: the inode which may have a disconnected dentry
2617 * @dentry: a negative dentry which we want to point to the inode.
2618 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002619 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2620 * place of the given dentry and return it, else simply d_add the inode
2621 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002622 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002623 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2624 * we should error out: directories can't have multiple aliases.
2625 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002626 * This is needed in the lookup routine of any filesystem that is exportable
2627 * (via knfsd) so that we can build dcache paths to directories effectively.
2628 *
2629 * If a dentry was found and moved, then it is returned. Otherwise NULL
2630 * is returned. This matches the expected return value of ->lookup.
2631 *
2632 * Cluster filesystems may call this function with a negative, hashed dentry.
2633 * In that case, we know that the inode will be a regular file, and also this
2634 * will only occur during atomic_open. So we need to check for the dentry
2635 * being already hashed only in the final case.
2636 */
2637struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2638{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002639 if (IS_ERR(inode))
2640 return ERR_CAST(inode);
2641
David Howells770bfad2006-08-22 20:06:07 -04002642 BUG_ON(!d_unhashed(dentry));
2643
David Howells770bfad2006-08-22 20:06:07 -04002644 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09002645 __d_instantiate(dentry, NULL);
Al Virob5ae6b12014-10-12 22:16:02 -04002646 goto out;
David Howells770bfad2006-08-22 20:06:07 -04002647 }
Nick Piggin873feea2011-01-07 17:50:06 +11002648 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002649 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04002650 struct dentry *new = __d_find_any_alias(inode);
2651 if (unlikely(new)) {
Al Viro18367502011-07-12 21:42:24 -04002652 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002653 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04002654 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002655 spin_unlock(&inode->i_lock);
2656 dput(new);
2657 new = ERR_PTR(-ELOOP);
2658 pr_warn_ratelimited(
2659 "VFS: Lookup of '%s' in %s %s"
2660 " would have caused loop\n",
2661 dentry->d_name.name,
2662 inode->i_sb->s_type->name,
2663 inode->i_sb->s_id);
2664 } else if (!IS_ROOT(new)) {
2665 int err = __d_unalias(inode, dentry, new);
2666 write_sequnlock(&rename_lock);
2667 if (err) {
2668 dput(new);
2669 new = ERR_PTR(err);
2670 }
Al Viro18367502011-07-12 21:42:24 -04002671 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04002672 __d_move(new, dentry, false);
2673 write_sequnlock(&rename_lock);
2674 spin_unlock(&inode->i_lock);
2675 security_d_instantiate(new, inode);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002676 }
Al Virob5ae6b12014-10-12 22:16:02 -04002677 iput(inode);
2678 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002679 }
David Howells770bfad2006-08-22 20:06:07 -04002680 }
Al Virob5ae6b12014-10-12 22:16:02 -04002681 /* already taking inode->i_lock, so d_add() by hand */
2682 __d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002683 spin_unlock(&inode->i_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002684out:
2685 security_d_instantiate(dentry, inode);
2686 d_rehash(dentry);
2687 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04002688}
Al Virob5ae6b12014-10-12 22:16:02 -04002689EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04002690
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002691static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002692{
2693 *buflen -= namelen;
2694 if (*buflen < 0)
2695 return -ENAMETOOLONG;
2696 *buffer -= namelen;
2697 memcpy(*buffer, str, namelen);
2698 return 0;
2699}
2700
Waiman Long232d2d62013-09-09 12:18:13 -04002701/**
2702 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04002703 * @buffer: buffer pointer
2704 * @buflen: allocated length of the buffer
2705 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04002706 *
2707 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
2708 * make sure that either the old or the new name pointer and length are
2709 * fetched. However, there may be mismatch between length and pointer.
2710 * The length cannot be trusted, we need to copy it byte-by-byte until
2711 * the length is reached or a null byte is found. It also prepends "/" at
2712 * the beginning of the name. The sequence number check at the caller will
2713 * retry it again when a d_move() does happen. So any garbage in the buffer
2714 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04002715 *
2716 * Data dependency barrier is needed to make sure that we see that terminating
2717 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04002718 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002719static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2720{
Waiman Long232d2d62013-09-09 12:18:13 -04002721 const char *dname = ACCESS_ONCE(name->name);
2722 u32 dlen = ACCESS_ONCE(name->len);
2723 char *p;
2724
Al Viro6d13f692014-09-29 14:46:30 -04002725 smp_read_barrier_depends();
2726
Waiman Long232d2d62013-09-09 12:18:13 -04002727 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04002728 if (*buflen < 0)
2729 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04002730 p = *buffer -= dlen + 1;
2731 *p++ = '/';
2732 while (dlen--) {
2733 char c = *dname++;
2734 if (!c)
2735 break;
2736 *p++ = c;
2737 }
2738 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002739}
2740
Linus Torvalds1da177e2005-04-16 15:20:36 -07002741/**
Randy Dunlap208898c2010-11-18 15:02:49 -08002742 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002743 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002744 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002745 * @buffer: pointer to the end of the buffer
2746 * @buflen: pointer to buffer length
2747 *
Waiman Long18129972013-09-12 10:55:35 -04002748 * The function will first try to write out the pathname without taking any
2749 * lock other than the RCU read lock to make sure that dentries won't go away.
2750 * It only checks the sequence number of the global rename_lock as any change
2751 * in the dentry's d_seq will be preceded by changes in the rename_lock
2752 * sequence number. If the sequence number had been changed, it will restart
2753 * the whole pathname back-tracing sequence again by taking the rename_lock.
2754 * In this case, there is no need to take the RCU read lock as the recursive
2755 * parent pointer references will keep the dentry chain alive as long as no
2756 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002757 */
Al Viro02125a82011-12-05 08:43:34 -05002758static int prepend_path(const struct path *path,
2759 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002760 char **buffer, int *buflen)
2761{
Al Viroede4ceb2013-11-13 07:45:40 -05002762 struct dentry *dentry;
2763 struct vfsmount *vfsmnt;
2764 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002765 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04002766 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04002767 char *bptr;
2768 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002769
Al Viro48f5ec22013-09-09 15:22:25 -04002770 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04002771restart_mnt:
2772 read_seqbegin_or_lock(&mount_lock, &m_seq);
2773 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002774 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002775restart:
2776 bptr = *buffer;
2777 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04002778 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05002779 dentry = path->dentry;
2780 vfsmnt = path->mnt;
2781 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04002782 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002783 while (dentry != root->dentry || vfsmnt != root->mnt) {
2784 struct dentry * parent;
2785
2786 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04002787 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002788 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04002789 if (mnt != parent) {
2790 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
2791 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04002792 vfsmnt = &mnt->mnt;
2793 continue;
2794 }
2795 /*
2796 * Filesystems needing to implement special "root names"
2797 * should do so with ->d_dname()
2798 */
2799 if (IS_ROOT(dentry) &&
2800 (dentry->d_name.len != 1 ||
2801 dentry->d_name.name[0] != '/')) {
2802 WARN(1, "Root dentry has weird name <%.*s>\n",
2803 (int) dentry->d_name.len,
2804 dentry->d_name.name);
2805 }
2806 if (!error)
2807 error = is_mounted(vfsmnt) ? 1 : 2;
2808 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002809 }
2810 parent = dentry->d_parent;
2811 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002812 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002813 if (error)
2814 break;
2815
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002816 dentry = parent;
2817 }
Al Viro48f5ec22013-09-09 15:22:25 -04002818 if (!(seq & 1))
2819 rcu_read_unlock();
2820 if (need_seqretry(&rename_lock, seq)) {
2821 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04002822 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002823 }
Al Viro48f5ec22013-09-09 15:22:25 -04002824 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002825
2826 if (!(m_seq & 1))
2827 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04002828 if (need_seqretry(&mount_lock, m_seq)) {
2829 m_seq = 1;
2830 goto restart_mnt;
2831 }
2832 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002833
Waiman Long232d2d62013-09-09 12:18:13 -04002834 if (error >= 0 && bptr == *buffer) {
2835 if (--blen < 0)
2836 error = -ENAMETOOLONG;
2837 else
2838 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002839 }
Waiman Long232d2d62013-09-09 12:18:13 -04002840 *buffer = bptr;
2841 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04002842 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002843}
2844
2845/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002846 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002847 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002848 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07002849 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07002850 * @buflen: buffer length
2851 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002852 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002853 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002854 * Returns a pointer into the buffer or an error code if the
2855 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08002856 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04002857 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002858 *
Al Viro02125a82011-12-05 08:43:34 -05002859 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002860 */
Al Viro02125a82011-12-05 08:43:34 -05002861char *__d_path(const struct path *path,
2862 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002863 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002864{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002865 char *res = buf + buflen;
2866 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002867
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002868 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002869 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002870
Al Viro02125a82011-12-05 08:43:34 -05002871 if (error < 0)
2872 return ERR_PTR(error);
2873 if (error > 0)
2874 return NULL;
2875 return res;
2876}
2877
2878char *d_absolute_path(const struct path *path,
2879 char *buf, int buflen)
2880{
2881 struct path root = {};
2882 char *res = buf + buflen;
2883 int error;
2884
2885 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05002886 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05002887
2888 if (error > 1)
2889 error = -EINVAL;
2890 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002891 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002892 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002893}
2894
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002895/*
2896 * same as __d_path but appends "(deleted)" for unlinked files.
2897 */
Al Viro02125a82011-12-05 08:43:34 -05002898static int path_with_deleted(const struct path *path,
2899 const struct path *root,
2900 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002901{
2902 prepend(buf, buflen, "\0", 1);
2903 if (d_unlinked(path->dentry)) {
2904 int error = prepend(buf, buflen, " (deleted)", 10);
2905 if (error)
2906 return error;
2907 }
2908
2909 return prepend_path(path, root, buf, buflen);
2910}
2911
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002912static int prepend_unreachable(char **buffer, int *buflen)
2913{
2914 return prepend(buffer, buflen, "(unreachable)", 13);
2915}
2916
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07002917static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
2918{
2919 unsigned seq;
2920
2921 do {
2922 seq = read_seqcount_begin(&fs->seq);
2923 *root = fs->root;
2924 } while (read_seqcount_retry(&fs->seq, seq));
2925}
2926
Jan Bluncka03a8a702008-02-14 19:38:32 -08002927/**
2928 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08002929 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08002930 * @buf: buffer to return value in
2931 * @buflen: buffer length
2932 *
2933 * Convert a dentry into an ASCII path name. If the entry has been deleted
2934 * the string " (deleted)" is appended. Note that this is ambiguous.
2935 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002936 * Returns a pointer into the buffer or an error code if the path was
2937 * too long. Note: Callers should use the returned pointer, not the passed
2938 * in buffer, to use the name! The implementation often starts at an offset
2939 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002940 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002941 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002942 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07002943char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002944{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002945 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08002946 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002947 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002948
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002949 /*
2950 * We have various synthetic filesystems that never get mounted. On
2951 * these filesystems dentries are never used for lookup purposes, and
2952 * thus don't need to be hashed. They also don't need a name until a
2953 * user wants to identify the object in /proc/pid/fd/. The little hack
2954 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08002955 *
2956 * Some pseudo inodes are mountable. When they are mounted
2957 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
2958 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002959 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08002960 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
2961 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08002962 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002963
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07002964 rcu_read_lock();
2965 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05002966 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07002967 rcu_read_unlock();
2968
Al Viro02125a82011-12-05 08:43:34 -05002969 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002970 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002971 return res;
2972}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002973EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002974
2975/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002976 * Helper function for dentry_operations.d_dname() members
2977 */
2978char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
2979 const char *fmt, ...)
2980{
2981 va_list args;
2982 char temp[64];
2983 int sz;
2984
2985 va_start(args, fmt);
2986 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
2987 va_end(args);
2988
2989 if (sz > sizeof(temp) || sz > buflen)
2990 return ERR_PTR(-ENAMETOOLONG);
2991
2992 buffer += buflen - sz;
2993 return memcpy(buffer, temp, sz);
2994}
2995
Al Viro118b2302013-08-24 12:08:17 -04002996char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
2997{
2998 char *end = buffer + buflen;
2999 /* these dentries are never renamed, so d_lock is not needed */
3000 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003001 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003002 prepend(&end, &buflen, "/", 1))
3003 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003004 return end;
Al Viro118b2302013-08-24 12:08:17 -04003005}
David Herrmann31bbe162014-01-03 14:09:47 +01003006EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003007
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003008/*
Ram Pai6092d042008-03-27 13:06:20 +01003009 * Write full pathname from the root of the filesystem into the buffer.
3010 */
Al Virof6500802014-01-26 12:37:55 -05003011static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003012{
Al Virof6500802014-01-26 12:37:55 -05003013 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003014 char *end, *retval;
3015 int len, seq = 0;
3016 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003017
Al Virof6500802014-01-26 12:37:55 -05003018 if (buflen < 2)
3019 goto Elong;
3020
Al Viro48f5ec22013-09-09 15:22:25 -04003021 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003022restart:
Al Virof6500802014-01-26 12:37:55 -05003023 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003024 end = buf + buflen;
3025 len = buflen;
3026 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003027 /* Get '/' right */
3028 retval = end-1;
3029 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003030 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003031 while (!IS_ROOT(dentry)) {
3032 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003033
Ram Pai6092d042008-03-27 13:06:20 +01003034 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003035 error = prepend_name(&end, &len, &dentry->d_name);
3036 if (error)
3037 break;
Ram Pai6092d042008-03-27 13:06:20 +01003038
3039 retval = end;
3040 dentry = parent;
3041 }
Al Viro48f5ec22013-09-09 15:22:25 -04003042 if (!(seq & 1))
3043 rcu_read_unlock();
3044 if (need_seqretry(&rename_lock, seq)) {
3045 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003046 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003047 }
3048 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003049 if (error)
3050 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003051 return retval;
3052Elong:
3053 return ERR_PTR(-ENAMETOOLONG);
3054}
Nick Pigginec2447c2011-01-07 17:49:29 +11003055
3056char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3057{
Waiman Long232d2d62013-09-09 12:18:13 -04003058 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003059}
3060EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003061
3062char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3063{
3064 char *p = NULL;
3065 char *retval;
3066
Al Viroc1031352010-06-06 22:31:14 -04003067 if (d_unlinked(dentry)) {
3068 p = buf + buflen;
3069 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3070 goto Elong;
3071 buflen++;
3072 }
3073 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003074 if (!IS_ERR(retval) && p)
3075 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003076 return retval;
3077Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003078 return ERR_PTR(-ENAMETOOLONG);
3079}
3080
Linus Torvalds8b19e342013-09-12 10:35:47 -07003081static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3082 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003083{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003084 unsigned seq;
3085
3086 do {
3087 seq = read_seqcount_begin(&fs->seq);
3088 *root = fs->root;
3089 *pwd = fs->pwd;
3090 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003091}
3092
Ram Pai6092d042008-03-27 13:06:20 +01003093/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003094 * NOTE! The user-level library version returns a
3095 * character pointer. The kernel system call just
3096 * returns the length of the buffer filled (which
3097 * includes the ending '\0' character), or a negative
3098 * error value. So libc would do something like
3099 *
3100 * char *getcwd(char * buf, size_t size)
3101 * {
3102 * int retval;
3103 *
3104 * retval = sys_getcwd(buf, size);
3105 * if (retval >= 0)
3106 * return buf;
3107 * errno = -retval;
3108 * return NULL;
3109 * }
3110 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003111SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003112{
Linus Torvalds552ce542007-02-13 12:08:18 -08003113 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003114 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003115 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003116
3117 if (!page)
3118 return -ENOMEM;
3119
Linus Torvalds8b19e342013-09-12 10:35:47 -07003120 rcu_read_lock();
3121 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003122
Linus Torvalds552ce542007-02-13 12:08:18 -08003123 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003124 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003125 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003126 char *cwd = page + PATH_MAX;
3127 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003128
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003129 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003130 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003131 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003132
Al Viro02125a82011-12-05 08:43:34 -05003133 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003134 goto out;
3135
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003136 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003137 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003138 error = prepend_unreachable(&cwd, &buflen);
3139 if (error)
3140 goto out;
3141 }
3142
Linus Torvalds552ce542007-02-13 12:08:18 -08003143 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003144 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003145 if (len <= size) {
3146 error = len;
3147 if (copy_to_user(buf, cwd, len))
3148 error = -EFAULT;
3149 }
Nick Piggin949854d2011-01-07 17:49:37 +11003150 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003151 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003152 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003153
3154out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003155 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003156 return error;
3157}
3158
3159/*
3160 * Test whether new_dentry is a subdirectory of old_dentry.
3161 *
3162 * Trivially implemented using the dcache structure
3163 */
3164
3165/**
3166 * is_subdir - is new dentry a subdirectory of old_dentry
3167 * @new_dentry: new dentry
3168 * @old_dentry: old dentry
3169 *
3170 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
3171 * Returns 0 otherwise.
3172 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3173 */
3174
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003175int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003176{
3177 int result;
Nick Piggin949854d2011-01-07 17:49:37 +11003178 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003179
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003180 if (new_dentry == old_dentry)
3181 return 1;
3182
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003183 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003184 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003185 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003186 /*
3187 * Need rcu_readlock to protect against the d_parent trashing
3188 * due to d_move
3189 */
3190 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003191 if (d_ancestor(old_dentry, new_dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003192 result = 1;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003193 else
3194 result = 0;
Nick Piggin949854d2011-01-07 17:49:37 +11003195 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003196 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003197
3198 return result;
3199}
3200
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003201static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003202{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003203 struct dentry *root = data;
3204 if (dentry != root) {
3205 if (d_unhashed(dentry) || !dentry->d_inode)
3206 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003207
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003208 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3209 dentry->d_flags |= DCACHE_GENOCIDE;
3210 dentry->d_lockref.count--;
3211 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003212 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003213 return D_WALK_CONTINUE;
3214}
Nick Piggin58db63d2011-01-07 17:49:39 +11003215
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003216void d_genocide(struct dentry *parent)
3217{
3218 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003219}
3220
Al Viro60545d02013-06-07 01:20:27 -04003221void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003222{
Al Viro60545d02013-06-07 01:20:27 -04003223 inode_dec_link_count(inode);
3224 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003225 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003226 !d_unlinked(dentry));
3227 spin_lock(&dentry->d_parent->d_lock);
3228 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3229 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3230 (unsigned long long)inode->i_ino);
3231 spin_unlock(&dentry->d_lock);
3232 spin_unlock(&dentry->d_parent->d_lock);
3233 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003234}
Al Viro60545d02013-06-07 01:20:27 -04003235EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003236
3237static __initdata unsigned long dhash_entries;
3238static int __init set_dhash_entries(char *str)
3239{
3240 if (!str)
3241 return 0;
3242 dhash_entries = simple_strtoul(str, &str, 0);
3243 return 1;
3244}
3245__setup("dhash_entries=", set_dhash_entries);
3246
3247static void __init dcache_init_early(void)
3248{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003249 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003250
3251 /* If hashes are distributed across NUMA nodes, defer
3252 * hash allocation until vmalloc space is available.
3253 */
3254 if (hashdist)
3255 return;
3256
3257 dentry_hashtable =
3258 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003259 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003260 dhash_entries,
3261 13,
3262 HASH_EARLY,
3263 &d_hash_shift,
3264 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003265 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003266 0);
3267
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003268 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003269 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003270}
3271
Denis Cheng74bf17c2007-10-16 23:26:30 -07003272static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003273{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003274 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003275
3276 /*
3277 * A constructor could be added for stable state like the lists,
3278 * but it is probably not worth it because of the cache nature
3279 * of the dcache.
3280 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003281 dentry_cache = KMEM_CACHE(dentry,
3282 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003283
3284 /* Hash may have been set up in dcache_init_early */
3285 if (!hashdist)
3286 return;
3287
3288 dentry_hashtable =
3289 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003290 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003291 dhash_entries,
3292 13,
3293 0,
3294 &d_hash_shift,
3295 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003296 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003297 0);
3298
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003299 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003300 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003301}
3302
3303/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003304struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003305EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003306
Linus Torvalds1da177e2005-04-16 15:20:36 -07003307EXPORT_SYMBOL(d_genocide);
3308
Linus Torvalds1da177e2005-04-16 15:20:36 -07003309void __init vfs_caches_init_early(void)
3310{
3311 dcache_init_early();
3312 inode_init_early();
3313}
3314
3315void __init vfs_caches_init(unsigned long mempages)
3316{
3317 unsigned long reserve;
3318
3319 /* Base hash sizes on available memory, with a reserve equal to
3320 150% of current kernel size */
3321
3322 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
3323 mempages -= reserve;
3324
3325 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003326 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003327
Denis Cheng74bf17c2007-10-16 23:26:30 -07003328 dcache_init();
3329 inode_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003330 files_init(mempages);
Denis Cheng74bf17c2007-10-16 23:26:30 -07003331 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003332 bdev_cache_init();
3333 chrdev_init();
3334}