blob: 769903dbc19df53199b4aca2e79607145e179c98 [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>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080029#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#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 Torvalds8387ff22016-06-10 07:51:30 -0700107static inline struct hlist_bl_head *d_hash(unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100108{
George Spelvin703b5fa2016-06-10 00:22:12 -0400109 return dentry_hashtable + (hash >> (32 - d_hash_shift));
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100110}
111
Al Viro94bdd652016-04-15 02:42:04 -0400112#define IN_LOOKUP_SHIFT 10
113static struct hlist_bl_head in_lookup_hashtable[1 << IN_LOOKUP_SHIFT];
114
115static inline struct hlist_bl_head *in_lookup_hash(const struct dentry *parent,
116 unsigned int hash)
117{
118 hash += (unsigned long) parent / L1_CACHE_BYTES;
119 return in_lookup_hashtable + hash_32(hash, IN_LOOKUP_SHIFT);
120}
121
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123/* Statistics gathering. */
124struct dentry_stat_t dentry_stat = {
125 .age_limit = 45,
126};
127
Glauber Costa3942c072013-08-28 10:17:53 +1000128static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000129static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400130
131#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000132
133/*
134 * Here we resort to our own counters instead of using generic per-cpu counters
135 * for consistency with what the vfs inode code does. We are expected to harvest
136 * better code and performance by having our own specialized counters.
137 *
138 * Please note that the loop is done over all possible CPUs, not over all online
139 * CPUs. The reason for this is that we don't want to play games with CPUs going
140 * on and off. If one of them goes off, we will just keep their counters.
141 *
142 * glommer: See cffbc8a for details, and if you ever intend to change this,
143 * please update all vfs counters to match.
144 */
Glauber Costa3942c072013-08-28 10:17:53 +1000145static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100146{
147 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000148 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100149 for_each_possible_cpu(i)
150 sum += per_cpu(nr_dentry, i);
151 return sum < 0 ? 0 : sum;
152}
153
Dave Chinner62d36c72013-08-28 10:17:54 +1000154static long get_nr_dentry_unused(void)
155{
156 int i;
157 long sum = 0;
158 for_each_possible_cpu(i)
159 sum += per_cpu(nr_dentry_unused, i);
160 return sum < 0 ? 0 : sum;
161}
162
Joe Perches1f7e0612014-06-06 14:38:05 -0700163int proc_nr_dentry(struct ctl_table *table, int write, void __user *buffer,
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400164 size_t *lenp, loff_t *ppos)
165{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100166 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000167 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000168 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400169}
170#endif
171
Linus Torvalds5483f182012-03-04 15:51:42 -0800172/*
173 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
174 * The strings are both count bytes long, and count is non-zero.
175 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700176#ifdef CONFIG_DCACHE_WORD_ACCESS
177
178#include <asm/word-at-a-time.h>
179/*
180 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
181 * aligned allocation for this particular component. We don't
182 * strictly need the load_unaligned_zeropad() safety, but it
183 * doesn't hurt either.
184 *
185 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
186 * need the careful unaligned handling.
187 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700188static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800189{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800190 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800191
192 for (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700193 a = *(unsigned long *)cs;
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700194 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800195 if (tcount < sizeof(unsigned long))
196 break;
197 if (unlikely(a != b))
198 return 1;
199 cs += sizeof(unsigned long);
200 ct += sizeof(unsigned long);
201 tcount -= sizeof(unsigned long);
202 if (!tcount)
203 return 0;
204 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000205 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800206 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700207}
208
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800209#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700210
Linus Torvalds94753db52012-05-10 12:19:19 -0700211static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700212{
Linus Torvalds5483f182012-03-04 15:51:42 -0800213 do {
214 if (*cs != *ct)
215 return 1;
216 cs++;
217 ct++;
218 tcount--;
219 } while (tcount);
220 return 0;
221}
222
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700223#endif
224
Linus Torvalds94753db52012-05-10 12:19:19 -0700225static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
226{
Linus Torvalds94753db52012-05-10 12:19:19 -0700227 /*
228 * Be careful about RCU walk racing with rename:
He Kuangae0a8432016-03-26 09:12:10 +0000229 * use 'lockless_dereference' to fetch the name pointer.
Linus Torvalds94753db52012-05-10 12:19:19 -0700230 *
231 * NOTE! Even if a rename will mean that the length
232 * was not loaded atomically, we don't care. The
233 * RCU walk will check the sequence count eventually,
234 * and catch it. And we won't overrun the buffer,
235 * because we're reading the name pointer atomically,
236 * and a dentry name is guaranteed to be properly
237 * terminated with a NUL byte.
238 *
239 * End result: even if 'len' is wrong, we'll exit
240 * early because the data cannot match (there can
241 * be no NUL in the ct/tcount data)
242 */
He Kuangae0a8432016-03-26 09:12:10 +0000243 const unsigned char *cs = lockless_dereference(dentry->d_name.name);
244
Linus Torvalds6326c712012-05-21 16:14:04 -0700245 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700246}
247
Al Viro8d85b482014-09-29 14:54:27 -0400248struct external_name {
249 union {
250 atomic_t count;
251 struct rcu_head head;
252 } u;
253 unsigned char name[];
254};
255
256static inline struct external_name *external_name(struct dentry *dentry)
257{
258 return container_of(dentry->d_name.name, struct external_name, name[0]);
259}
260
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400261static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400263 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
264
Al Viro8d85b482014-09-29 14:54:27 -0400265 kmem_cache_free(dentry_cache, dentry);
266}
267
268static void __d_free_external(struct rcu_head *head)
269{
270 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
Al Viro8d85b482014-09-29 14:54:27 -0400271 kfree(external_name(dentry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 kmem_cache_free(dentry_cache, dentry);
273}
274
Al Viro810bb172014-10-12 12:45:37 -0400275static inline int dname_external(const struct dentry *dentry)
276{
277 return dentry->d_name.name != dentry->d_iname;
278}
279
David Howells4bf46a22015-03-05 14:09:22 +0000280static inline void __d_set_inode_and_type(struct dentry *dentry,
281 struct inode *inode,
282 unsigned type_flags)
283{
284 unsigned flags;
285
286 dentry->d_inode = inode;
David Howells4bf46a22015-03-05 14:09:22 +0000287 flags = READ_ONCE(dentry->d_flags);
288 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
289 flags |= type_flags;
290 WRITE_ONCE(dentry->d_flags, flags);
291}
292
David Howells4bf46a22015-03-05 14:09:22 +0000293static inline void __d_clear_type_and_inode(struct dentry *dentry)
294{
295 unsigned flags = READ_ONCE(dentry->d_flags);
296
297 flags &= ~(DCACHE_ENTRY_TYPE | DCACHE_FALLTHRU);
298 WRITE_ONCE(dentry->d_flags, flags);
David Howells4bf46a22015-03-05 14:09:22 +0000299 dentry->d_inode = NULL;
300}
301
Al Virob4f03542014-04-29 23:40:14 -0400302static void dentry_free(struct dentry *dentry)
303{
Al Viro946e51f2014-10-26 19:19:16 -0400304 WARN_ON(!hlist_unhashed(&dentry->d_u.d_alias));
Al Viro8d85b482014-09-29 14:54:27 -0400305 if (unlikely(dname_external(dentry))) {
306 struct external_name *p = external_name(dentry);
307 if (likely(atomic_dec_and_test(&p->u.count))) {
308 call_rcu(&dentry->d_u.d_rcu, __d_free_external);
309 return;
310 }
311 }
Al Virob4f03542014-04-29 23:40:14 -0400312 /* if dentry was never visible to RCU, immediate free is OK */
313 if (!(dentry->d_flags & DCACHE_RCUACCESS))
314 __d_free(&dentry->d_u.d_rcu);
315 else
316 call_rcu(&dentry->d_u.d_rcu, __d_free);
317}
318
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319/*
320 * Release the dentry's inode, using the filesystem
Al Viro550dce02016-05-29 20:13:30 -0400321 * d_iput() operation if defined.
Nick Piggin31e6b012011-01-07 17:49:52 +1100322 */
323static void dentry_unlink_inode(struct dentry * dentry)
324 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100325 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100326{
327 struct inode *inode = dentry->d_inode;
Al Viro550dce02016-05-29 20:13:30 -0400328 bool hashed = !d_unhashed(dentry);
Al Viroa528aca2016-02-29 12:12:46 -0500329
Al Viro550dce02016-05-29 20:13:30 -0400330 if (hashed)
331 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +0000332 __d_clear_type_and_inode(dentry);
Al Viro946e51f2014-10-26 19:19:16 -0400333 hlist_del_init(&dentry->d_u.d_alias);
Al Viro550dce02016-05-29 20:13:30 -0400334 if (hashed)
335 raw_write_seqcount_end(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +1100336 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100337 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100338 if (!inode->i_nlink)
339 fsnotify_inoderemove(inode);
340 if (dentry->d_op && dentry->d_op->d_iput)
341 dentry->d_op->d_iput(dentry, inode);
342 else
343 iput(inode);
344}
345
346/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400347 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
348 * is in use - which includes both the "real" per-superblock
349 * LRU list _and_ the DCACHE_SHRINK_LIST use.
350 *
351 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
352 * on the shrink list (ie not on the superblock LRU list).
353 *
354 * The per-cpu "nr_dentry_unused" counters are updated with
355 * the DCACHE_LRU_LIST bit.
356 *
357 * These helper functions make sure we always follow the
358 * rules. d_lock must be held by the caller.
359 */
360#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
361static void d_lru_add(struct dentry *dentry)
362{
363 D_FLAG_VERIFY(dentry, 0);
364 dentry->d_flags |= DCACHE_LRU_LIST;
365 this_cpu_inc(nr_dentry_unused);
366 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
367}
368
369static void d_lru_del(struct dentry *dentry)
370{
371 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
372 dentry->d_flags &= ~DCACHE_LRU_LIST;
373 this_cpu_dec(nr_dentry_unused);
374 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
375}
376
377static void d_shrink_del(struct dentry *dentry)
378{
379 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
380 list_del_init(&dentry->d_lru);
381 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
382 this_cpu_dec(nr_dentry_unused);
383}
384
385static void d_shrink_add(struct dentry *dentry, struct list_head *list)
386{
387 D_FLAG_VERIFY(dentry, 0);
388 list_add(&dentry->d_lru, list);
389 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
390 this_cpu_inc(nr_dentry_unused);
391}
392
393/*
394 * These can only be called under the global LRU lock, ie during the
395 * callback for freeing the LRU list. "isolate" removes it from the
396 * LRU lists entirely, while shrink_move moves it to the indicated
397 * private list.
398 */
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800399static void d_lru_isolate(struct list_lru_one *lru, struct dentry *dentry)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400400{
401 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
402 dentry->d_flags &= ~DCACHE_LRU_LIST;
403 this_cpu_dec(nr_dentry_unused);
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800404 list_lru_isolate(lru, &dentry->d_lru);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400405}
406
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800407static void d_lru_shrink_move(struct list_lru_one *lru, struct dentry *dentry,
408 struct list_head *list)
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400409{
410 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
411 dentry->d_flags |= DCACHE_SHRINK_LIST;
Vladimir Davydov3f97b162015-02-12 14:59:35 -0800412 list_lru_isolate_move(lru, &dentry->d_lru, list);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400413}
414
415/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000416 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700417 */
418static void dentry_lru_add(struct dentry *dentry)
419{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400420 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
421 d_lru_add(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700422}
423
Miklos Szeredid52b9082007-05-08 00:23:46 -0700424/**
Nick Piggin789680d2011-01-07 17:49:30 +1100425 * d_drop - drop a dentry
426 * @dentry: dentry to drop
427 *
428 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
429 * be found through a VFS lookup any more. Note that this is different from
430 * deleting the dentry - d_delete will try to mark the dentry negative if
431 * possible, giving a successful _negative_ lookup, while d_drop will
432 * just make the cache lookup fail.
433 *
434 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
435 * reason (NFS timeouts or autofs deletes).
436 *
437 * __d_drop requires dentry->d_lock.
438 */
439void __d_drop(struct dentry *dentry)
440{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700441 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400442 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400443 /*
444 * Hashed dentries are normally on the dentry hashtable,
445 * with the exception of those newly allocated by
446 * d_obtain_alias, which are always IS_ROOT:
447 */
448 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400449 b = &dentry->d_sb->s_anon;
450 else
Linus Torvalds8387ff22016-06-10 07:51:30 -0700451 b = d_hash(dentry->d_name.hash);
Al Virob61625d2013-10-04 11:09:01 -0400452
453 hlist_bl_lock(b);
454 __hlist_bl_del(&dentry->d_hash);
455 dentry->d_hash.pprev = NULL;
456 hlist_bl_unlock(b);
Al Virod6141462016-07-28 13:05:50 -0400457 /* After this call, in-progress rcu-walk path lookup will fail. */
458 write_seqcount_invalidate(&dentry->d_seq);
Nick Piggin789680d2011-01-07 17:49:30 +1100459 }
460}
461EXPORT_SYMBOL(__d_drop);
462
463void d_drop(struct dentry *dentry)
464{
Nick Piggin789680d2011-01-07 17:49:30 +1100465 spin_lock(&dentry->d_lock);
466 __d_drop(dentry);
467 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100468}
469EXPORT_SYMBOL(d_drop);
470
Al Viroba65dc52016-06-10 11:32:47 -0400471static inline void dentry_unlist(struct dentry *dentry, struct dentry *parent)
472{
473 struct dentry *next;
474 /*
475 * Inform d_walk() and shrink_dentry_list() that we are no longer
476 * attached to the dentry tree
477 */
478 dentry->d_flags |= DCACHE_DENTRY_KILLED;
479 if (unlikely(list_empty(&dentry->d_child)))
480 return;
481 __list_del_entry(&dentry->d_child);
482 /*
483 * Cursors can move around the list of children. While we'd been
484 * a normal list member, it didn't matter - ->d_child.next would've
485 * been updated. However, from now on it won't be and for the
486 * things like d_walk() it might end up with a nasty surprise.
487 * Normally d_walk() doesn't care about cursors moving around -
488 * ->d_lock on parent prevents that and since a cursor has no children
489 * of its own, we get through it without ever unlocking the parent.
490 * There is one exception, though - if we ascend from a child that
491 * gets killed as soon as we unlock it, the next sibling is found
492 * using the value left in its ->d_child.next. And if _that_
493 * pointed to a cursor, and cursor got moved (e.g. by lseek())
494 * before d_walk() regains parent->d_lock, we'll end up skipping
495 * everything the cursor had been moved past.
496 *
497 * Solution: make sure that the pointer left behind in ->d_child.next
498 * points to something that won't be moving around. I.e. skip the
499 * cursors.
500 */
501 while (dentry->d_child.next != &parent->d_subdirs) {
502 next = list_entry(dentry->d_child.next, struct dentry, d_child);
503 if (likely(!(next->d_flags & DCACHE_DENTRY_CURSOR)))
504 break;
505 dentry->d_child.next = next->d_child.next;
506 }
507}
508
Al Viroe55fd012014-05-28 13:51:12 -0400509static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100510{
Al Viro41edf272014-05-01 10:30:00 -0400511 struct dentry *parent = NULL;
512 bool can_free = true;
Al Viro41edf272014-05-01 10:30:00 -0400513 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100514 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100515
Linus Torvalds0d984392013-09-08 13:46:52 -0700516 /*
517 * The dentry is now unrecoverably dead to the world.
518 */
519 lockref_mark_dead(&dentry->d_lockref);
520
Sage Weilf0023bc2011-10-28 10:02:42 -0700521 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700522 * inform the fs via d_prune that this dentry is about to be
523 * unhashed and destroyed.
524 */
Al Viro29266202014-05-30 11:39:02 -0400525 if (dentry->d_flags & DCACHE_OP_PRUNE)
Yan, Zheng61572bb2013-04-15 14:13:21 +0800526 dentry->d_op->d_prune(dentry);
527
Al Viro01b60352014-04-29 23:42:52 -0400528 if (dentry->d_flags & DCACHE_LRU_LIST) {
529 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
530 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400531 }
Nick Piggin77812a12011-01-07 17:49:48 +1100532 /* if it was on the hash then remove it */
533 __d_drop(dentry);
Al Viroba65dc52016-06-10 11:32:47 -0400534 dentry_unlist(dentry, parent);
Al Viro03b3b882014-04-29 15:45:28 -0400535 if (parent)
536 spin_unlock(&parent->d_lock);
Al Viro550dce02016-05-29 20:13:30 -0400537 if (dentry->d_inode)
538 dentry_unlink_inode(dentry);
539 else
540 spin_unlock(&dentry->d_lock);
Al Viro03b3b882014-04-29 15:45:28 -0400541 this_cpu_dec(nr_dentry);
542 if (dentry->d_op && dentry->d_op->d_release)
543 dentry->d_op->d_release(dentry);
544
Al Viro41edf272014-05-01 10:30:00 -0400545 spin_lock(&dentry->d_lock);
546 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
547 dentry->d_flags |= DCACHE_MAY_FREE;
548 can_free = false;
549 }
550 spin_unlock(&dentry->d_lock);
Al Viro41edf272014-05-01 10:30:00 -0400551 if (likely(can_free))
552 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400553}
554
555/*
556 * Finish off a dentry we've decided to kill.
557 * dentry->d_lock must be held, returns with it unlocked.
558 * If ref is non-zero, then decrement the refcount too.
559 * Returns dentry requiring refcount drop, or NULL if we're done.
560 */
Al Viro8cbf74d2014-05-29 09:18:26 -0400561static struct dentry *dentry_kill(struct dentry *dentry)
Al Viroe55fd012014-05-28 13:51:12 -0400562 __releases(dentry->d_lock)
563{
564 struct inode *inode = dentry->d_inode;
565 struct dentry *parent = NULL;
566
567 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
568 goto failed;
569
570 if (!IS_ROOT(dentry)) {
571 parent = dentry->d_parent;
572 if (unlikely(!spin_trylock(&parent->d_lock))) {
573 if (inode)
574 spin_unlock(&inode->i_lock);
575 goto failed;
576 }
577 }
578
579 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400580 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400581
582failed:
Al Viro8cbf74d2014-05-29 09:18:26 -0400583 spin_unlock(&dentry->d_lock);
Al Viroe55fd012014-05-28 13:51:12 -0400584 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100585}
586
Al Viro046b9612014-05-29 08:54:52 -0400587static inline struct dentry *lock_parent(struct dentry *dentry)
588{
589 struct dentry *parent = dentry->d_parent;
590 if (IS_ROOT(dentry))
591 return NULL;
Linus Torvalds360f5472015-01-09 15:19:03 -0800592 if (unlikely(dentry->d_lockref.count < 0))
Al Viroc2338f22014-06-12 00:29:13 -0400593 return NULL;
Al Viro046b9612014-05-29 08:54:52 -0400594 if (likely(spin_trylock(&parent->d_lock)))
595 return parent;
Al Viro046b9612014-05-29 08:54:52 -0400596 rcu_read_lock();
Al Viroc2338f22014-06-12 00:29:13 -0400597 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400598again:
599 parent = ACCESS_ONCE(dentry->d_parent);
600 spin_lock(&parent->d_lock);
601 /*
602 * We can't blindly lock dentry until we are sure
603 * that we won't violate the locking order.
604 * Any changes of dentry->d_parent must have
605 * been done with parent->d_lock held, so
606 * spin_lock() above is enough of a barrier
607 * for checking if it's still our child.
608 */
609 if (unlikely(parent != dentry->d_parent)) {
610 spin_unlock(&parent->d_lock);
611 goto again;
612 }
613 rcu_read_unlock();
614 if (parent != dentry)
Linus Torvalds9f126002014-05-31 09:13:21 -0700615 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Al Viro046b9612014-05-29 08:54:52 -0400616 else
617 parent = NULL;
618 return parent;
619}
620
Linus Torvalds360f5472015-01-09 15:19:03 -0800621/*
622 * Try to do a lockless dput(), and return whether that was successful.
623 *
624 * If unsuccessful, we return false, having already taken the dentry lock.
625 *
626 * The caller needs to hold the RCU read lock, so that the dentry is
627 * guaranteed to stay around even if the refcount goes down to zero!
628 */
629static inline bool fast_dput(struct dentry *dentry)
630{
631 int ret;
632 unsigned int d_flags;
633
634 /*
635 * If we have a d_op->d_delete() operation, we sould not
Al Viro75a6f822015-07-08 02:42:38 +0100636 * let the dentry count go to zero, so use "put_or_lock".
Linus Torvalds360f5472015-01-09 15:19:03 -0800637 */
638 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE))
639 return lockref_put_or_lock(&dentry->d_lockref);
640
641 /*
642 * .. otherwise, we can try to just decrement the
643 * lockref optimistically.
644 */
645 ret = lockref_put_return(&dentry->d_lockref);
646
647 /*
648 * If the lockref_put_return() failed due to the lock being held
649 * by somebody else, the fast path has failed. We will need to
650 * get the lock, and then check the count again.
651 */
652 if (unlikely(ret < 0)) {
653 spin_lock(&dentry->d_lock);
654 if (dentry->d_lockref.count > 1) {
655 dentry->d_lockref.count--;
656 spin_unlock(&dentry->d_lock);
657 return 1;
658 }
659 return 0;
660 }
661
662 /*
663 * If we weren't the last ref, we're done.
664 */
665 if (ret)
666 return 1;
667
668 /*
669 * Careful, careful. The reference count went down
670 * to zero, but we don't hold the dentry lock, so
671 * somebody else could get it again, and do another
672 * dput(), and we need to not race with that.
673 *
674 * However, there is a very special and common case
675 * where we don't care, because there is nothing to
676 * do: the dentry is still hashed, it does not have
677 * a 'delete' op, and it's referenced and already on
678 * the LRU list.
679 *
680 * NOTE! Since we aren't locked, these values are
681 * not "stable". However, it is sufficient that at
682 * some point after we dropped the reference the
683 * dentry was hashed and the flags had the proper
684 * value. Other dentry users may have re-gotten
685 * a reference to the dentry and change that, but
686 * our work is done - we can leave the dentry
687 * around with a zero refcount.
688 */
689 smp_rmb();
690 d_flags = ACCESS_ONCE(dentry->d_flags);
Al Viro75a6f822015-07-08 02:42:38 +0100691 d_flags &= DCACHE_REFERENCED | DCACHE_LRU_LIST | DCACHE_DISCONNECTED;
Linus Torvalds360f5472015-01-09 15:19:03 -0800692
693 /* Nothing to do? Dropping the reference was all we needed? */
694 if (d_flags == (DCACHE_REFERENCED | DCACHE_LRU_LIST) && !d_unhashed(dentry))
695 return 1;
696
697 /*
698 * Not the fast normal case? Get the lock. We've already decremented
699 * the refcount, but we'll need to re-check the situation after
700 * getting the lock.
701 */
702 spin_lock(&dentry->d_lock);
703
704 /*
705 * Did somebody else grab a reference to it in the meantime, and
706 * we're no longer the last user after all? Alternatively, somebody
707 * else could have killed it and marked it dead. Either way, we
708 * don't need to do anything else.
709 */
710 if (dentry->d_lockref.count) {
711 spin_unlock(&dentry->d_lock);
712 return 1;
713 }
714
715 /*
716 * Re-get the reference we optimistically dropped. We hold the
717 * lock, and we just tested that it was zero, so we can just
718 * set it to 1.
719 */
720 dentry->d_lockref.count = 1;
721 return 0;
722}
723
724
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725/*
726 * This is dput
727 *
728 * This is complicated by the fact that we do not want to put
729 * dentries that are no longer on any hash chain on the unused
730 * list: we'd much rather just get rid of them immediately.
731 *
732 * However, that implies that we have to traverse the dentry
733 * tree upwards to the parents which might _also_ now be
734 * scheduled for deletion (it may have been only waiting for
735 * its last child to go away).
736 *
737 * This tail recursion is done by hand as we don't want to depend
738 * on the compiler to always get this right (gcc generally doesn't).
739 * Real recursion would eat up our stack space.
740 */
741
742/*
743 * dput - release a dentry
744 * @dentry: dentry to release
745 *
746 * Release a dentry. This will drop the usage count and if appropriate
747 * call the dentry unlink method as well as removing it from the queues and
748 * releasing its resources. If the parent dentries were scheduled for release
749 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751void dput(struct dentry *dentry)
752{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700753 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 return;
755
756repeat:
Wei Fang47be6182016-07-06 11:32:20 +0800757 might_sleep();
758
Linus Torvalds360f5472015-01-09 15:19:03 -0800759 rcu_read_lock();
760 if (likely(fast_dput(dentry))) {
761 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 return;
Linus Torvalds360f5472015-01-09 15:19:03 -0800763 }
764
765 /* Slow case: now with the dentry lock held */
766 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767
Al Viro85c7f812016-04-14 19:52:13 -0400768 WARN_ON(d_in_lookup(dentry));
769
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700770 /* Unreachable? Get rid of it */
771 if (unlikely(d_unhashed(dentry)))
772 goto kill_it;
773
Al Viro75a6f822015-07-08 02:42:38 +0100774 if (unlikely(dentry->d_flags & DCACHE_DISCONNECTED))
775 goto kill_it;
776
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700777 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100779 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 }
Nick Piggin265ac902010-10-10 05:36:24 -0400781
Linus Torvalds358eec12013-10-31 15:43:02 -0700782 if (!(dentry->d_flags & DCACHE_REFERENCED))
783 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400784 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400785
Waiman Long98474232013-08-28 18:24:59 -0700786 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100787 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 return;
789
Miklos Szeredid52b9082007-05-08 00:23:46 -0700790kill_it:
Al Viro8cbf74d2014-05-29 09:18:26 -0400791 dentry = dentry_kill(dentry);
Wei Fang47be6182016-07-06 11:32:20 +0800792 if (dentry) {
793 cond_resched();
Miklos Szeredid52b9082007-05-08 00:23:46 -0700794 goto repeat;
Wei Fang47be6182016-07-06 11:32:20 +0800795 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700797EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100800/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100801static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802{
Waiman Long98474232013-08-28 18:24:59 -0700803 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804}
805
Nick Piggindc0474b2011-01-07 17:49:43 +1100806static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100807{
Waiman Long98474232013-08-28 18:24:59 -0700808 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100809}
810
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100811struct dentry *dget_parent(struct dentry *dentry)
812{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700813 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100814 struct dentry *ret;
815
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700816 /*
817 * Do optimistic parent lookup without any
818 * locking.
819 */
820 rcu_read_lock();
821 ret = ACCESS_ONCE(dentry->d_parent);
822 gotref = lockref_get_not_zero(&ret->d_lockref);
823 rcu_read_unlock();
824 if (likely(gotref)) {
825 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
826 return ret;
827 dput(ret);
828 }
829
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100830repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100831 /*
832 * Don't need rcu_dereference because we re-check it was correct under
833 * the lock.
834 */
835 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100836 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100837 spin_lock(&ret->d_lock);
838 if (unlikely(ret != dentry->d_parent)) {
839 spin_unlock(&ret->d_lock);
840 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100841 goto repeat;
842 }
Nick Piggina734eb42011-01-07 17:49:44 +1100843 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700844 BUG_ON(!ret->d_lockref.count);
845 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100846 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100847 return ret;
848}
849EXPORT_SYMBOL(dget_parent);
850
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851/**
852 * d_find_alias - grab a hashed alias of inode
853 * @inode: inode in question
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 *
855 * If inode has a hashed alias, or is a directory and has any alias,
856 * acquire the reference to alias and return it. Otherwise return NULL.
857 * Notice that if inode is a directory there can be only one alias and
858 * it can be unhashed only if it has no children, or if it is the root
Eric W. Biederman3ccb3542014-02-12 16:08:06 -0800859 * of a filesystem, or if the directory was renamed and d_revalidate
860 * was the first vfs operation to notice.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700862 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500863 * any other hashed alias over that one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 */
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500865static struct dentry *__d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866{
Nick Pigginda502952011-01-07 17:49:33 +1100867 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868
Nick Pigginda502952011-01-07 17:49:33 +1100869again:
870 discon_alias = NULL;
Al Viro946e51f2014-10-26 19:19:16 -0400871 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100872 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700874 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100875 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 discon_alias = alias;
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500877 } else {
Nick Piggindc0474b2011-01-07 17:49:43 +1100878 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100879 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 return alias;
881 }
882 }
Nick Pigginda502952011-01-07 17:49:33 +1100883 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 }
Nick Pigginda502952011-01-07 17:49:33 +1100885 if (discon_alias) {
886 alias = discon_alias;
887 spin_lock(&alias->d_lock);
888 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
J. Bruce Fields8d80d7d2014-01-16 17:17:31 -0500889 __dget_dlock(alias);
890 spin_unlock(&alias->d_lock);
891 return alias;
Nick Pigginda502952011-01-07 17:49:33 +1100892 }
893 spin_unlock(&alias->d_lock);
894 goto again;
895 }
896 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897}
898
Nick Pigginda502952011-01-07 17:49:33 +1100899struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900{
David Howells214fda12006-03-25 03:06:36 -0800901 struct dentry *de = NULL;
902
Al Virob3d9b7a2012-06-09 13:51:19 -0400903 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100904 spin_lock(&inode->i_lock);
J. Bruce Fields52ed46f2014-01-16 11:15:51 -0500905 de = __d_find_alias(inode);
Nick Piggin873feea2011-01-07 17:50:06 +1100906 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800907 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 return de;
909}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700910EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911
912/*
913 * Try to kill dentries associated with this inode.
914 * WARNING: you must own a reference to inode.
915 */
916void d_prune_aliases(struct inode *inode)
917{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700918 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100920 spin_lock(&inode->i_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400921 hlist_for_each_entry(dentry, &inode->i_dentry, d_u.d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700923 if (!dentry->d_lockref.count) {
Al Viro29355c32014-05-30 11:25:30 -0400924 struct dentry *parent = lock_parent(dentry);
925 if (likely(!dentry->d_lockref.count)) {
926 __dentry_kill(dentry);
Yan, Zheng4a7795d2014-11-19 15:50:34 +0800927 dput(parent);
Al Viro29355c32014-05-30 11:25:30 -0400928 goto restart;
929 }
930 if (parent)
931 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 }
933 spin_unlock(&dentry->d_lock);
934 }
Nick Piggin873feea2011-01-07 17:50:06 +1100935 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700937EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400939static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940{
Al Viro5c47e6d2014-04-29 16:13:18 -0400941 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700942
Miklos Szeredi60942f22014-05-02 15:38:39 -0400943 while (!list_empty(list)) {
Al Viroff2fde92014-05-28 13:59:13 -0400944 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400945 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100946 spin_lock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400947 parent = lock_parent(dentry);
948
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000950 * The dispose list is isolated and dentries are not accounted
951 * to the LRU here, so we can simply remove it from the list
952 * here regardless of whether it is referenced or not.
953 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400954 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000955
956 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000958 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 */
Linus Torvalds360f5472015-01-09 15:19:03 -0800960 if (dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700961 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400962 if (parent)
963 spin_unlock(&parent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 continue;
965 }
Nick Piggin77812a12011-01-07 17:49:48 +1100966
Al Viro64fd72e2014-05-28 09:48:44 -0400967
968 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
969 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
970 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400971 if (parent)
972 spin_unlock(&parent->d_lock);
Al Viro64fd72e2014-05-28 09:48:44 -0400973 if (can_free)
974 dentry_free(dentry);
975 continue;
976 }
977
Al Viroff2fde92014-05-28 13:59:13 -0400978 inode = dentry->d_inode;
979 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400980 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000981 spin_unlock(&dentry->d_lock);
Al Viro046b9612014-05-29 08:54:52 -0400982 if (parent)
983 spin_unlock(&parent->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -0400984 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000985 }
Al Viroff2fde92014-05-28 13:59:13 -0400986
Al Viroff2fde92014-05-28 13:59:13 -0400987 __dentry_kill(dentry);
Al Viro046b9612014-05-29 08:54:52 -0400988
Al Viro5c47e6d2014-04-29 16:13:18 -0400989 /*
990 * We need to prune ancestors too. This is necessary to prevent
991 * quadratic behavior of shrink_dcache_parent(), but is also
992 * expected to be beneficial in reducing dentry cache
993 * fragmentation.
994 */
995 dentry = parent;
Al Virob2b80192014-05-29 09:11:45 -0400996 while (dentry && !lockref_put_or_lock(&dentry->d_lockref)) {
997 parent = lock_parent(dentry);
998 if (dentry->d_lockref.count != 1) {
999 dentry->d_lockref.count--;
1000 spin_unlock(&dentry->d_lock);
1001 if (parent)
1002 spin_unlock(&parent->d_lock);
1003 break;
1004 }
1005 inode = dentry->d_inode; /* can't be NULL */
1006 if (unlikely(!spin_trylock(&inode->i_lock))) {
1007 spin_unlock(&dentry->d_lock);
1008 if (parent)
1009 spin_unlock(&parent->d_lock);
1010 cpu_relax();
1011 continue;
1012 }
1013 __dentry_kill(dentry);
1014 dentry = parent;
1015 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001017}
1018
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001019static enum lru_status dentry_lru_isolate(struct list_head *item,
1020 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerf6041562013-08-28 10:18:00 +10001021{
1022 struct list_head *freeable = arg;
1023 struct dentry *dentry = container_of(item, struct dentry, d_lru);
1024
1025
1026 /*
1027 * we are inverting the lru lock/dentry->d_lock here,
1028 * so use a trylock. If we fail to get the lock, just skip
1029 * it
1030 */
1031 if (!spin_trylock(&dentry->d_lock))
1032 return LRU_SKIP;
1033
1034 /*
1035 * Referenced dentries are still in use. If they have active
1036 * counts, just remove them from the LRU. Otherwise give them
1037 * another pass through the LRU.
1038 */
1039 if (dentry->d_lockref.count) {
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001040 d_lru_isolate(lru, dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +10001041 spin_unlock(&dentry->d_lock);
1042 return LRU_REMOVED;
1043 }
1044
1045 if (dentry->d_flags & DCACHE_REFERENCED) {
1046 dentry->d_flags &= ~DCACHE_REFERENCED;
1047 spin_unlock(&dentry->d_lock);
1048
1049 /*
1050 * The list move itself will be made by the common LRU code. At
1051 * this point, we've dropped the dentry->d_lock but keep the
1052 * lru lock. This is safe to do, since every list movement is
1053 * protected by the lru lock even if both locks are held.
1054 *
1055 * This is guaranteed by the fact that all LRU management
1056 * functions are intermediated by the LRU API calls like
1057 * list_lru_add and list_lru_del. List movement in this file
1058 * only ever occur through this functions or through callbacks
1059 * like this one, that are called from the LRU API.
1060 *
1061 * The only exceptions to this are functions like
1062 * shrink_dentry_list, and code that first checks for the
1063 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
1064 * operating only with stack provided lists after they are
1065 * properly isolated from the main list. It is thus, always a
1066 * local access.
1067 */
1068 return LRU_ROTATE;
1069 }
1070
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001071 d_lru_shrink_move(lru, dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +10001072 spin_unlock(&dentry->d_lock);
1073
1074 return LRU_REMOVED;
1075}
1076
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001077/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001078 * prune_dcache_sb - shrink the dcache
1079 * @sb: superblock
Vladimir Davydov503c3582015-02-12 14:58:47 -08001080 * @sc: shrink control, passed to list_lru_shrink_walk()
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001081 *
Vladimir Davydov503c3582015-02-12 14:58:47 -08001082 * Attempt to shrink the superblock dcache LRU by @sc->nr_to_scan entries. This
1083 * is done when we need more memory and called from the superblock shrinker
Dave Chinnerb48f03b2011-08-23 18:56:24 +10001084 * function.
1085 *
1086 * This function may fail to free any resources if all the dentries are in
1087 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001088 */
Vladimir Davydov503c3582015-02-12 14:58:47 -08001089long prune_dcache_sb(struct super_block *sb, struct shrink_control *sc)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001090{
Dave Chinnerf6041562013-08-28 10:18:00 +10001091 LIST_HEAD(dispose);
1092 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001093
Vladimir Davydov503c3582015-02-12 14:58:47 -08001094 freed = list_lru_shrink_walk(&sb->s_dentry_lru, sc,
1095 dentry_lru_isolate, &dispose);
Dave Chinnerf6041562013-08-28 10:18:00 +10001096 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +10001097 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098}
1099
Glauber Costa4e717f52013-08-28 10:18:03 +10001100static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001101 struct list_lru_one *lru, spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001102{
Glauber Costa4e717f52013-08-28 10:18:03 +10001103 struct list_head *freeable = arg;
1104 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001105
Glauber Costa4e717f52013-08-28 10:18:03 +10001106 /*
1107 * we are inverting the lru lock/dentry->d_lock here,
1108 * so use a trylock. If we fail to get the lock, just skip
1109 * it
1110 */
1111 if (!spin_trylock(&dentry->d_lock))
1112 return LRU_SKIP;
1113
Vladimir Davydov3f97b162015-02-12 14:59:35 -08001114 d_lru_shrink_move(lru, dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +10001115 spin_unlock(&dentry->d_lock);
1116
1117 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +10001118}
1119
Glauber Costa4e717f52013-08-28 10:18:03 +10001120
Kentaro Makitada3bbdd2008-07-23 21:27:13 -07001121/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 * shrink_dcache_sb - shrink dcache for a superblock
1123 * @sb: superblock
1124 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001125 * Shrink the dcache for the specified super block. This is used to free
1126 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001128void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129{
Glauber Costa4e717f52013-08-28 10:18:03 +10001130 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -04001131
Glauber Costa4e717f52013-08-28 10:18:03 +10001132 do {
1133 LIST_HEAD(dispose);
1134
1135 freed = list_lru_walk(&sb->s_dentry_lru,
1136 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
1137
1138 this_cpu_sub(nr_dentry_unused, freed);
1139 shrink_dentry_list(&dispose);
1140 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001142EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001145 * enum d_walk_ret - action to talke during tree walk
1146 * @D_WALK_CONTINUE: contrinue walk
1147 * @D_WALK_QUIT: quit walk
1148 * @D_WALK_NORETRY: quit when retry is needed
1149 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001151enum d_walk_ret {
1152 D_WALK_CONTINUE,
1153 D_WALK_QUIT,
1154 D_WALK_NORETRY,
1155 D_WALK_SKIP,
1156};
1157
1158/**
1159 * d_walk - walk the dentry tree
1160 * @parent: start of walk
1161 * @data: data passed to @enter() and @finish()
1162 * @enter: callback when first entering the dentry
1163 * @finish: callback when successfully finished the walk
1164 *
1165 * The @enter() and @finish() callbacks are called with d_lock held.
1166 */
1167static void d_walk(struct dentry *parent, void *data,
1168 enum d_walk_ret (*enter)(void *, struct dentry *),
1169 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170{
Nick Piggin949854d2011-01-07 17:49:37 +11001171 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001173 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001174 enum d_walk_ret ret;
1175 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001176
Nick Piggin58db63d2011-01-07 17:49:39 +11001177again:
Al Viro48f5ec22013-09-09 15:22:25 -04001178 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001179 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001180 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001181
1182 ret = enter(data, this_parent);
1183 switch (ret) {
1184 case D_WALK_CONTINUE:
1185 break;
1186 case D_WALK_QUIT:
1187 case D_WALK_SKIP:
1188 goto out_unlock;
1189 case D_WALK_NORETRY:
1190 retry = false;
1191 break;
1192 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193repeat:
1194 next = this_parent->d_subdirs.next;
1195resume:
1196 while (next != &this_parent->d_subdirs) {
1197 struct list_head *tmp = next;
Al Viro946e51f2014-10-26 19:19:16 -04001198 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001200
Al Viroba65dc52016-06-10 11:32:47 -04001201 if (unlikely(dentry->d_flags & DCACHE_DENTRY_CURSOR))
1202 continue;
1203
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001204 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001205
1206 ret = enter(data, dentry);
1207 switch (ret) {
1208 case D_WALK_CONTINUE:
1209 break;
1210 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001211 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001212 goto out_unlock;
1213 case D_WALK_NORETRY:
1214 retry = false;
1215 break;
1216 case D_WALK_SKIP:
1217 spin_unlock(&dentry->d_lock);
1218 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001219 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001220
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001222 spin_unlock(&this_parent->d_lock);
1223 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001225 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 goto repeat;
1227 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001228 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 }
1230 /*
1231 * All done at this level ... ascend and resume the search.
1232 */
Al Viroca5358e2014-10-26 19:31:10 -04001233 rcu_read_lock();
1234ascend:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001236 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001237 this_parent = child->d_parent;
1238
Al Viro31dec132013-10-25 17:04:27 -04001239 spin_unlock(&child->d_lock);
1240 spin_lock(&this_parent->d_lock);
1241
Al Viroca5358e2014-10-26 19:31:10 -04001242 /* might go back up the wrong parent if we have had a rename. */
1243 if (need_seqretry(&rename_lock, seq))
Nick Piggin949854d2011-01-07 17:49:37 +11001244 goto rename_retry;
Al Viro21591842015-05-28 23:09:19 -04001245 /* go into the first sibling still alive */
1246 do {
1247 next = child->d_child.next;
Al Viroca5358e2014-10-26 19:31:10 -04001248 if (next == &this_parent->d_subdirs)
1249 goto ascend;
1250 child = list_entry(next, struct dentry, d_child);
Al Viro21591842015-05-28 23:09:19 -04001251 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
Al Viro31dec132013-10-25 17:04:27 -04001252 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 goto resume;
1254 }
Al Viroca5358e2014-10-26 19:31:10 -04001255 if (need_seqretry(&rename_lock, seq))
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001256 goto rename_retry;
Al Viroca5358e2014-10-26 19:31:10 -04001257 rcu_read_unlock();
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001258 if (finish)
1259 finish(data);
1260
1261out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001262 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001263 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001264 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001265
1266rename_retry:
Al Viroca5358e2014-10-26 19:31:10 -04001267 spin_unlock(&this_parent->d_lock);
1268 rcu_read_unlock();
1269 BUG_ON(seq & 1);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001270 if (!retry)
1271 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001272 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001273 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001275
Ian Kent01619492016-11-24 08:03:41 +11001276struct check_mount {
1277 struct vfsmount *mnt;
1278 unsigned int mounted;
1279};
1280
1281static enum d_walk_ret path_check_mount(void *data, struct dentry *dentry)
1282{
1283 struct check_mount *info = data;
1284 struct path path = { .mnt = info->mnt, .dentry = dentry };
1285
1286 if (likely(!d_mountpoint(dentry)))
1287 return D_WALK_CONTINUE;
1288 if (__path_is_mountpoint(&path)) {
1289 info->mounted = 1;
1290 return D_WALK_QUIT;
1291 }
1292 return D_WALK_CONTINUE;
1293}
1294
1295/**
1296 * path_has_submounts - check for mounts over a dentry in the
1297 * current namespace.
1298 * @parent: path to check.
1299 *
1300 * Return true if the parent or its subdirectories contain
1301 * a mount point in the current namespace.
1302 */
1303int path_has_submounts(const struct path *parent)
1304{
1305 struct check_mount data = { .mnt = parent->mnt, .mounted = 0 };
1306
1307 read_seqlock_excl(&mount_lock);
1308 d_walk(parent->dentry, &data, path_check_mount, NULL);
1309 read_sequnlock_excl(&mount_lock);
1310
1311 return data.mounted;
1312}
1313EXPORT_SYMBOL(path_has_submounts);
1314
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001316 * Called by mount code to set a mountpoint and check if the mountpoint is
1317 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1318 * subtree can become unreachable).
1319 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001320 * Only one of d_invalidate() and d_set_mounted() must succeed. For
Miklos Szeredieed81002013-09-05 14:39:11 +02001321 * this reason take rename_lock and d_lock on dentry and ancestors.
1322 */
1323int d_set_mounted(struct dentry *dentry)
1324{
1325 struct dentry *p;
1326 int ret = -ENOENT;
1327 write_seqlock(&rename_lock);
1328 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001329 /* Need exclusion wrt. d_invalidate() */
Miklos Szeredieed81002013-09-05 14:39:11 +02001330 spin_lock(&p->d_lock);
1331 if (unlikely(d_unhashed(p))) {
1332 spin_unlock(&p->d_lock);
1333 goto out;
1334 }
1335 spin_unlock(&p->d_lock);
1336 }
1337 spin_lock(&dentry->d_lock);
1338 if (!d_unlinked(dentry)) {
1339 dentry->d_flags |= DCACHE_MOUNTED;
1340 ret = 0;
1341 }
1342 spin_unlock(&dentry->d_lock);
1343out:
1344 write_sequnlock(&rename_lock);
1345 return ret;
1346}
1347
1348/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001349 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 * and move any unused dentries to the end of the unused
1351 * list for prune_dcache(). We descend to the next level
1352 * whenever the d_subdirs list is non-empty and continue
1353 * searching.
1354 *
1355 * It returns zero iff there are no unused children,
1356 * otherwise it returns the number of children moved to
1357 * the end of the unused list. This may not be the total
1358 * number of unused children, because select_parent can
1359 * drop the lock and return early due to latency
1360 * constraints.
1361 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001362
1363struct select_data {
1364 struct dentry *start;
1365 struct list_head dispose;
1366 int found;
1367};
1368
1369static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001371 struct select_data *data = _data;
1372 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001374 if (data->start == dentry)
1375 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376
Al Virofe915222014-05-03 00:02:25 -04001377 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001378 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001379 } else {
1380 if (dentry->d_flags & DCACHE_LRU_LIST)
1381 d_lru_del(dentry);
1382 if (!dentry->d_lockref.count) {
1383 d_shrink_add(dentry, &data->dispose);
1384 data->found++;
1385 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 }
1387 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001388 * We can return to the caller if we have found some (this
1389 * ensures forward progress). We'll be coming back to find
1390 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 */
Al Virofe915222014-05-03 00:02:25 -04001392 if (!list_empty(&data->dispose))
1393 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001395 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396}
1397
1398/**
1399 * shrink_dcache_parent - prune dcache
1400 * @parent: parent of entries to prune
1401 *
1402 * Prune the dcache to remove unused children of the parent dentry.
1403 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001404void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001406 for (;;) {
1407 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001409 INIT_LIST_HEAD(&data.dispose);
1410 data.start = parent;
1411 data.found = 0;
1412
1413 d_walk(parent, &data, select_collect, NULL);
1414 if (!data.found)
1415 break;
1416
1417 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001418 cond_resched();
1419 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001421EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422
Al Viro9c8c10e2014-05-02 20:36:10 -04001423static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001424{
Al Viro9c8c10e2014-05-02 20:36:10 -04001425 /* it has busy descendents; complain about those instead */
1426 if (!list_empty(&dentry->d_subdirs))
1427 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001428
Al Viro9c8c10e2014-05-02 20:36:10 -04001429 /* root with refcount 1 is fine */
1430 if (dentry == _data && dentry->d_lockref.count == 1)
1431 return D_WALK_CONTINUE;
1432
1433 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1434 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001435 dentry,
1436 dentry->d_inode ?
1437 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001438 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001439 dentry->d_lockref.count,
1440 dentry->d_sb->s_type->name,
1441 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001442 WARN_ON(1);
1443 return D_WALK_CONTINUE;
1444}
1445
1446static void do_one_tree(struct dentry *dentry)
1447{
1448 shrink_dcache_parent(dentry);
1449 d_walk(dentry, dentry, umount_check, NULL);
1450 d_drop(dentry);
1451 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001452}
1453
1454/*
1455 * destroy the dentries attached to a superblock on unmounting
1456 */
1457void shrink_dcache_for_umount(struct super_block *sb)
1458{
1459 struct dentry *dentry;
1460
Al Viro9c8c10e2014-05-02 20:36:10 -04001461 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001462
1463 dentry = sb->s_root;
1464 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001465 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001466
1467 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001468 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1469 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001470 }
1471}
1472
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001473struct detach_data {
1474 struct select_data select;
1475 struct dentry *mountpoint;
1476};
1477static enum d_walk_ret detach_and_collect(void *_data, struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001478{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001479 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001480
1481 if (d_mountpoint(dentry)) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001482 __dget_dlock(dentry);
1483 data->mountpoint = dentry;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001484 return D_WALK_QUIT;
1485 }
1486
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001487 return select_collect(&data->select, dentry);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001488}
1489
1490static void check_and_drop(void *_data)
1491{
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001492 struct detach_data *data = _data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001493
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001494 if (!data->mountpoint && !data->select.found)
1495 __d_drop(data->select.start);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001496}
1497
1498/**
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001499 * d_invalidate - detach submounts, prune dcache, and drop
1500 * @dentry: dentry to invalidate (aka detach, prune and drop)
1501 *
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001502 * no dcache lock.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001503 *
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001504 * The final d_drop is done as an atomic operation relative to
1505 * rename_lock ensuring there are no races with d_set_mounted. This
1506 * ensures there are no unhashed dentries on the path to a mountpoint.
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001507 */
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001508void d_invalidate(struct dentry *dentry)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001509{
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001510 /*
1511 * If it's already been dropped, return OK.
1512 */
1513 spin_lock(&dentry->d_lock);
1514 if (d_unhashed(dentry)) {
1515 spin_unlock(&dentry->d_lock);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001516 return;
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001517 }
1518 spin_unlock(&dentry->d_lock);
1519
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001520 /* Negative dentries can be dropped without further checks */
1521 if (!dentry->d_inode) {
1522 d_drop(dentry);
Eric W. Biederman5542aa22014-02-13 09:46:25 -08001523 return;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001524 }
1525
1526 for (;;) {
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001527 struct detach_data data;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001528
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001529 data.mountpoint = NULL;
1530 INIT_LIST_HEAD(&data.select.dispose);
1531 data.select.start = dentry;
1532 data.select.found = 0;
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001533
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001534 d_walk(dentry, &data, detach_and_collect, check_and_drop);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001535
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001536 if (data.select.found)
1537 shrink_dentry_list(&data.select.dispose);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001538
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07001539 if (data.mountpoint) {
1540 detach_mounts(data.mountpoint);
1541 dput(data.mountpoint);
1542 }
1543
1544 if (!data.mountpoint && !data.select.found)
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001545 break;
1546
1547 cond_resched();
1548 }
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001549}
Eric W. Biederman1ffe46d2014-02-13 09:39:37 -08001550EXPORT_SYMBOL(d_invalidate);
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001551
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552/**
Al Viroa4464db2011-07-07 15:03:58 -04001553 * __d_alloc - allocate a dcache entry
1554 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555 * @name: qstr of the name
1556 *
1557 * Allocates a dentry. It returns %NULL if there is insufficient memory
1558 * available. On a success the dentry is returned. The name passed in is
1559 * copied and the copy passed in may be reused after this call.
1560 */
1561
Al Viroa4464db2011-07-07 15:03:58 -04001562struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563{
1564 struct dentry *dentry;
1565 char *dname;
Miklos Szeredi285b1022016-06-28 11:47:32 +02001566 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
Mel Gormane12ba742007-10-16 01:25:52 -07001568 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 if (!dentry)
1570 return NULL;
1571
Linus Torvalds6326c712012-05-21 16:14:04 -07001572 /*
1573 * We guarantee that the inline name is always NUL-terminated.
1574 * This way the memcpy() done by the name switching in rename
1575 * will still always have a NUL at the end, even if we might
1576 * be overwriting an internal NUL character
1577 */
1578 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Al Viro798434b2016-03-24 20:38:43 -04001579 if (unlikely(!name)) {
1580 static const struct qstr anon = QSTR_INIT("/", 1);
1581 name = &anon;
1582 dname = dentry->d_iname;
1583 } else if (name->len > DNAME_INLINE_LEN-1) {
Al Viro8d85b482014-09-29 14:54:27 -04001584 size_t size = offsetof(struct external_name, name[1]);
Vladimir Davydov5d097052016-01-14 15:18:21 -08001585 struct external_name *p = kmalloc(size + name->len,
1586 GFP_KERNEL_ACCOUNT);
Al Viro8d85b482014-09-29 14:54:27 -04001587 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 kmem_cache_free(dentry_cache, dentry);
1589 return NULL;
1590 }
Al Viro8d85b482014-09-29 14:54:27 -04001591 atomic_set(&p->u.count, 1);
1592 dname = p->name;
Andrey Ryabinindf4c0e32015-02-13 14:39:45 -08001593 if (IS_ENABLED(CONFIG_DCACHE_WORD_ACCESS))
1594 kasan_unpoison_shadow(dname,
1595 round_up(name->len + 1, sizeof(unsigned long)));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 } else {
1597 dname = dentry->d_iname;
1598 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599
1600 dentry->d_name.len = name->len;
1601 dentry->d_name.hash = name->hash;
1602 memcpy(dname, name->name, name->len);
1603 dname[name->len] = 0;
1604
Linus Torvalds6326c712012-05-21 16:14:04 -07001605 /* Make sure we always see the terminating NUL character */
1606 smp_wmb();
1607 dentry->d_name.name = dname;
1608
Waiman Long98474232013-08-28 18:24:59 -07001609 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001610 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001612 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001614 dentry->d_parent = dentry;
1615 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616 dentry->d_op = NULL;
1617 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001618 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619 INIT_LIST_HEAD(&dentry->d_lru);
1620 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Viro946e51f2014-10-26 19:19:16 -04001621 INIT_HLIST_NODE(&dentry->d_u.d_alias);
1622 INIT_LIST_HEAD(&dentry->d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001623 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624
Miklos Szeredi285b1022016-06-28 11:47:32 +02001625 if (dentry->d_op && dentry->d_op->d_init) {
1626 err = dentry->d_op->d_init(dentry);
1627 if (err) {
1628 if (dname_external(dentry))
1629 kfree(external_name(dentry));
1630 kmem_cache_free(dentry_cache, dentry);
1631 return NULL;
1632 }
1633 }
1634
Nick Piggin3e880fb2011-01-07 17:49:19 +11001635 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001636
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 return dentry;
1638}
Al Viroa4464db2011-07-07 15:03:58 -04001639
1640/**
1641 * d_alloc - allocate a dcache entry
1642 * @parent: parent of entry to allocate
1643 * @name: qstr of the name
1644 *
1645 * Allocates a dentry. It returns %NULL if there is insufficient memory
1646 * available. On a success the dentry is returned. The name passed in is
1647 * copied and the copy passed in may be reused after this call.
1648 */
1649struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1650{
1651 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1652 if (!dentry)
1653 return NULL;
Al Viro3d56c252016-06-07 21:26:55 -04001654 dentry->d_flags |= DCACHE_RCUACCESS;
Al Viroa4464db2011-07-07 15:03:58 -04001655 spin_lock(&parent->d_lock);
1656 /*
1657 * don't need child lock because it is not subject
1658 * to concurrency here
1659 */
1660 __dget_dlock(parent);
1661 dentry->d_parent = parent;
Al Viro946e51f2014-10-26 19:19:16 -04001662 list_add(&dentry->d_child, &parent->d_subdirs);
Al Viroa4464db2011-07-07 15:03:58 -04001663 spin_unlock(&parent->d_lock);
1664
1665 return dentry;
1666}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001667EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668
Al Viroba65dc52016-06-10 11:32:47 -04001669struct dentry *d_alloc_cursor(struct dentry * parent)
1670{
1671 struct dentry *dentry = __d_alloc(parent->d_sb, NULL);
1672 if (dentry) {
1673 dentry->d_flags |= DCACHE_RCUACCESS | DCACHE_DENTRY_CURSOR;
1674 dentry->d_parent = dget(parent);
1675 }
1676 return dentry;
1677}
1678
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001679/**
1680 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1681 * @sb: the superblock
1682 * @name: qstr of the name
1683 *
1684 * For a filesystem that just pins its dentries in memory and never
1685 * performs lookups at all, return an unhashed IS_ROOT dentry.
1686 */
Nick Piggin4b936882011-01-07 17:50:07 +11001687struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1688{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001689 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001690}
1691EXPORT_SYMBOL(d_alloc_pseudo);
1692
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1694{
1695 struct qstr q;
1696
1697 q.name = name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07001698 q.hash_len = hashlen_string(parent, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 return d_alloc(parent, &q);
1700}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001701EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702
Nick Pigginfb045ad2011-01-07 17:49:55 +11001703void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1704{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001705 WARN_ON_ONCE(dentry->d_op);
1706 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001707 DCACHE_OP_COMPARE |
1708 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001709 DCACHE_OP_WEAK_REVALIDATE |
David Howells4bacc9c2015-06-18 14:32:31 +01001710 DCACHE_OP_DELETE |
Miklos Szeredid101a122016-03-26 16:14:37 -04001711 DCACHE_OP_REAL));
Nick Pigginfb045ad2011-01-07 17:49:55 +11001712 dentry->d_op = op;
1713 if (!op)
1714 return;
1715 if (op->d_hash)
1716 dentry->d_flags |= DCACHE_OP_HASH;
1717 if (op->d_compare)
1718 dentry->d_flags |= DCACHE_OP_COMPARE;
1719 if (op->d_revalidate)
1720 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001721 if (op->d_weak_revalidate)
1722 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001723 if (op->d_delete)
1724 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001725 if (op->d_prune)
1726 dentry->d_flags |= DCACHE_OP_PRUNE;
Miklos Szeredid101a122016-03-26 16:14:37 -04001727 if (op->d_real)
1728 dentry->d_flags |= DCACHE_OP_REAL;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001729
1730}
1731EXPORT_SYMBOL(d_set_d_op);
1732
David Howellsdf1a0852015-01-29 12:02:28 +00001733
1734/*
1735 * d_set_fallthru - Mark a dentry as falling through to a lower layer
1736 * @dentry - The dentry to mark
1737 *
1738 * Mark a dentry as falling through to the lower layer (as set with
1739 * d_pin_lower()). This flag may be recorded on the medium.
1740 */
1741void d_set_fallthru(struct dentry *dentry)
1742{
1743 spin_lock(&dentry->d_lock);
1744 dentry->d_flags |= DCACHE_FALLTHRU;
1745 spin_unlock(&dentry->d_lock);
1746}
1747EXPORT_SYMBOL(d_set_fallthru);
1748
David Howellsb18825a2013-09-12 19:22:53 +01001749static unsigned d_flags_for_inode(struct inode *inode)
1750{
David Howells44bdb5e2015-01-29 12:02:29 +00001751 unsigned add_flags = DCACHE_REGULAR_TYPE;
David Howellsb18825a2013-09-12 19:22:53 +01001752
1753 if (!inode)
1754 return DCACHE_MISS_TYPE;
1755
1756 if (S_ISDIR(inode->i_mode)) {
1757 add_flags = DCACHE_DIRECTORY_TYPE;
1758 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1759 if (unlikely(!inode->i_op->lookup))
1760 add_flags = DCACHE_AUTODIR_TYPE;
1761 else
1762 inode->i_opflags |= IOP_LOOKUP;
1763 }
David Howells44bdb5e2015-01-29 12:02:29 +00001764 goto type_determined;
David Howellsb18825a2013-09-12 19:22:53 +01001765 }
1766
David Howells44bdb5e2015-01-29 12:02:29 +00001767 if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
Al Viro6b255392015-11-17 10:20:54 -05001768 if (unlikely(inode->i_op->get_link)) {
David Howells44bdb5e2015-01-29 12:02:29 +00001769 add_flags = DCACHE_SYMLINK_TYPE;
1770 goto type_determined;
1771 }
1772 inode->i_opflags |= IOP_NOFOLLOW;
1773 }
1774
1775 if (unlikely(!S_ISREG(inode->i_mode)))
1776 add_flags = DCACHE_SPECIAL_TYPE;
1777
1778type_determined:
David Howellsb18825a2013-09-12 19:22:53 +01001779 if (unlikely(IS_AUTOMOUNT(inode)))
1780 add_flags |= DCACHE_NEED_AUTOMOUNT;
1781 return add_flags;
1782}
1783
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001784static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1785{
David Howellsb18825a2013-09-12 19:22:53 +01001786 unsigned add_flags = d_flags_for_inode(inode);
Al Viro85c7f812016-04-14 19:52:13 -04001787 WARN_ON(d_in_lookup(dentry));
David Howellsb18825a2013-09-12 19:22:53 +01001788
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001789 spin_lock(&dentry->d_lock);
Al Virode689f52016-03-09 18:05:42 -05001790 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
Al Viroa528aca2016-02-29 12:12:46 -05001791 raw_write_seqcount_begin(&dentry->d_seq);
David Howells4bf46a22015-03-05 14:09:22 +00001792 __d_set_inode_and_type(dentry, inode, add_flags);
Al Viroa528aca2016-02-29 12:12:46 -05001793 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04001794 fsnotify_update_flags(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001795 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001796}
1797
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798/**
1799 * d_instantiate - fill in inode information for a dentry
1800 * @entry: dentry to complete
1801 * @inode: inode to attach to this dentry
1802 *
1803 * Fill in inode information in the entry.
1804 *
1805 * This turns negative dentries into productive full members
1806 * of society.
1807 *
1808 * NOTE! This assumes that the inode count has been incremented
1809 * (or otherwise set) by the caller to indicate that it is now
1810 * in use by the dcache.
1811 */
1812
1813void d_instantiate(struct dentry *entry, struct inode * inode)
1814{
Al Viro946e51f2014-10-26 19:19:16 -04001815 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Al Virode689f52016-03-09 18:05:42 -05001816 if (inode) {
Al Virob9680912016-04-11 00:53:26 -04001817 security_d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001818 spin_lock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001819 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001820 spin_unlock(&inode->i_lock);
Al Virode689f52016-03-09 18:05:42 -05001821 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001823EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824
1825/**
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001826 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1827 * @entry: dentry to complete
1828 * @inode: inode to attach to this dentry
1829 *
1830 * Fill in inode information in the entry. If a directory alias is found, then
1831 * return an error (and drop inode). Together with d_materialise_unique() this
1832 * guarantees that a directory inode may never have more than one alias.
1833 */
1834int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1835{
Al Viro946e51f2014-10-26 19:19:16 -04001836 BUG_ON(!hlist_unhashed(&entry->d_u.d_alias));
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001837
Al Virob9680912016-04-11 00:53:26 -04001838 security_d_instantiate(entry, inode);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001839 spin_lock(&inode->i_lock);
1840 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1841 spin_unlock(&inode->i_lock);
1842 iput(inode);
1843 return -EBUSY;
1844 }
1845 __d_instantiate(entry, inode);
1846 spin_unlock(&inode->i_lock);
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001847
1848 return 0;
1849}
1850EXPORT_SYMBOL(d_instantiate_no_diralias);
1851
Al Viroadc0e912012-01-08 16:49:21 -05001852struct dentry *d_make_root(struct inode *root_inode)
1853{
1854 struct dentry *res = NULL;
1855
1856 if (root_inode) {
Al Viro798434b2016-03-24 20:38:43 -04001857 res = __d_alloc(root_inode->i_sb, NULL);
Al Viroadc0e912012-01-08 16:49:21 -05001858 if (res)
1859 d_instantiate(res, root_inode);
1860 else
1861 iput(root_inode);
1862 }
1863 return res;
1864}
1865EXPORT_SYMBOL(d_make_root);
1866
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001867static struct dentry * __d_find_any_alias(struct inode *inode)
1868{
1869 struct dentry *alias;
1870
Al Virob3d9b7a2012-06-09 13:51:19 -04001871 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001872 return NULL;
Al Viro946e51f2014-10-26 19:19:16 -04001873 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_u.d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001874 __dget(alias);
1875 return alias;
1876}
1877
Sage Weil46f72b32012-01-10 09:04:37 -08001878/**
1879 * d_find_any_alias - find any alias for a given inode
1880 * @inode: inode to find an alias for
1881 *
1882 * If any aliases exist for the given inode, take and return a
1883 * reference for one of them. If no aliases exist, return %NULL.
1884 */
1885struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001886{
1887 struct dentry *de;
1888
1889 spin_lock(&inode->i_lock);
1890 de = __d_find_any_alias(inode);
1891 spin_unlock(&inode->i_lock);
1892 return de;
1893}
Sage Weil46f72b32012-01-10 09:04:37 -08001894EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001895
Fengguang Wu49c7dd22014-07-31 17:59:02 -04001896static struct dentry *__d_obtain_alias(struct inode *inode, int disconnected)
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001897{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001898 struct dentry *tmp;
1899 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001900 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001901
1902 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001903 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001904 if (IS_ERR(inode))
1905 return ERR_CAST(inode);
1906
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001907 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001908 if (res)
1909 goto out_iput;
1910
Al Viro798434b2016-03-24 20:38:43 -04001911 tmp = __d_alloc(inode->i_sb, NULL);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001912 if (!tmp) {
1913 res = ERR_PTR(-ENOMEM);
1914 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001915 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001916
Al Virob9680912016-04-11 00:53:26 -04001917 security_d_instantiate(tmp, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001918 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001919 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001920 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001921 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001922 dput(tmp);
1923 goto out_iput;
1924 }
1925
1926 /* attach a disconnected dentry */
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001927 add_flags = d_flags_for_inode(inode);
1928
1929 if (disconnected)
1930 add_flags |= DCACHE_DISCONNECTED;
David Howellsb18825a2013-09-12 19:22:53 +01001931
Christoph Hellwig9308a612008-08-11 15:49:12 +02001932 spin_lock(&tmp->d_lock);
David Howells4bf46a22015-03-05 14:09:22 +00001933 __d_set_inode_and_type(tmp, inode, add_flags);
Al Viro946e51f2014-10-26 19:19:16 -04001934 hlist_add_head(&tmp->d_u.d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001935 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001936 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001937 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001938 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001939 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001940
Christoph Hellwig9308a612008-08-11 15:49:12 +02001941 return tmp;
1942
1943 out_iput:
1944 iput(inode);
1945 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001946}
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001947
1948/**
1949 * d_obtain_alias - find or allocate a DISCONNECTED dentry for a given inode
1950 * @inode: inode to allocate the dentry for
1951 *
1952 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1953 * similar open by handle operations. The returned dentry may be anonymous,
1954 * or may have a full name (if the inode was already in the cache).
1955 *
1956 * When called on a directory inode, we must ensure that the inode only ever
1957 * has one dentry. If a dentry is found, that is returned instead of
1958 * allocating a new one.
1959 *
1960 * On successful return, the reference to the inode has been transferred
1961 * to the dentry. In case of an error the reference on the inode is released.
1962 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1963 * be passed in and the error will be propagated to the return value,
1964 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
1965 */
1966struct dentry *d_obtain_alias(struct inode *inode)
1967{
1968 return __d_obtain_alias(inode, 1);
1969}
Benny Halevyadc48722009-02-27 14:02:59 -08001970EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971
1972/**
J. Bruce Fields1a0a3972014-02-14 17:35:37 -05001973 * d_obtain_root - find or allocate a dentry for a given inode
1974 * @inode: inode to allocate the dentry for
1975 *
1976 * Obtain an IS_ROOT dentry for the root of a filesystem.
1977 *
1978 * We must ensure that directory inodes only ever have one dentry. If a
1979 * dentry is found, that is returned instead of allocating a new one.
1980 *
1981 * On successful return, the reference to the inode has been transferred
1982 * to the dentry. In case of an error the reference on the inode is
1983 * released. A %NULL or IS_ERR inode may be passed in and will be the
1984 * error will be propagate to the return value, with a %NULL @inode
1985 * replaced by ERR_PTR(-ESTALE).
1986 */
1987struct dentry *d_obtain_root(struct inode *inode)
1988{
1989 return __d_obtain_alias(inode, 0);
1990}
1991EXPORT_SYMBOL(d_obtain_root);
1992
1993/**
Barry Naujok94035402008-05-21 16:50:46 +10001994 * d_add_ci - lookup or allocate new dentry with case-exact name
1995 * @inode: the inode case-insensitive lookup has found
1996 * @dentry: the negative dentry that was passed to the parent's lookup func
1997 * @name: the case-exact name to be associated with the returned dentry
1998 *
1999 * This is to avoid filling the dcache with case-insensitive names to the
2000 * same inode, only the actual correct case is stored in the dcache for
2001 * case-insensitive filesystems.
2002 *
2003 * For a case-insensitive lookup match and if the the case-exact dentry
2004 * already exists in in the dcache, use it and return it.
2005 *
2006 * If no entry exists with the exact case name, allocate new dentry with
2007 * the exact case, and return the spliced entry.
2008 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02002009struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10002010 struct qstr *name)
2011{
Al Virod9171b92016-04-15 03:33:13 -04002012 struct dentry *found, *res;
Barry Naujok94035402008-05-21 16:50:46 +10002013
Christoph Hellwigb6520c82009-01-05 19:10:37 +01002014 /*
2015 * First check if a dentry matching the name already exists,
2016 * if not go ahead and create it now.
2017 */
Barry Naujok94035402008-05-21 16:50:46 +10002018 found = d_hash_and_lookup(dentry->d_parent, name);
Al Virod9171b92016-04-15 03:33:13 -04002019 if (found) {
2020 iput(inode);
2021 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002022 }
Al Virod9171b92016-04-15 03:33:13 -04002023 if (d_in_lookup(dentry)) {
2024 found = d_alloc_parallel(dentry->d_parent, name,
2025 dentry->d_wait);
2026 if (IS_ERR(found) || !d_in_lookup(found)) {
2027 iput(inode);
2028 return found;
2029 }
2030 } else {
2031 found = d_alloc(dentry->d_parent, name);
2032 if (!found) {
2033 iput(inode);
2034 return ERR_PTR(-ENOMEM);
2035 }
2036 }
2037 res = d_splice_alias(inode, found);
2038 if (res) {
2039 dput(found);
2040 return res;
2041 }
Al Viro4f522a22013-02-11 23:20:37 -05002042 return found;
Barry Naujok94035402008-05-21 16:50:46 +10002043}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002044EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002046
Al Virod4c91a82016-06-25 23:33:49 -04002047static inline bool d_same_name(const struct dentry *dentry,
2048 const struct dentry *parent,
2049 const struct qstr *name)
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002050{
Al Virod4c91a82016-06-25 23:33:49 -04002051 if (likely(!(parent->d_flags & DCACHE_OP_COMPARE))) {
2052 if (dentry->d_name.len != name->len)
2053 return false;
2054 return dentry_cmp(dentry, name->name, name->len) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002055 }
Al Viro6fa67e72016-07-31 16:37:25 -04002056 return parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002057 dentry->d_name.len, dentry->d_name.name,
2058 name) == 0;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002059}
2060
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061/**
Nick Piggin31e6b012011-01-07 17:49:52 +11002062 * __d_lookup_rcu - search for a dentry (racy, store-free)
2063 * @parent: parent dentry
2064 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07002065 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11002066 * Returns: dentry, or NULL
2067 *
2068 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
2069 * resolution (store-free path walking) design described in
2070 * Documentation/filesystems/path-lookup.txt.
2071 *
2072 * This is not to be used outside core vfs.
2073 *
2074 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
2075 * held, and rcu_read_lock held. The returned dentry must not be stored into
2076 * without taking d_lock and checking d_seq sequence count against @seq
2077 * returned here.
2078 *
Linus Torvalds15570082013-09-02 11:38:06 -07002079 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11002080 * function.
2081 *
2082 * Alternatively, __d_lookup_rcu may be called again to look up the child of
2083 * the returned dentry, so long as its parent's seqlock is checked after the
2084 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2085 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002086 *
2087 * NOTE! The caller *has* to check the resulting dentry against the sequence
2088 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002089 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002090struct dentry *__d_lookup_rcu(const struct dentry *parent,
2091 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002092 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002093{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002094 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002095 const unsigned char *str = name->name;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002096 struct hlist_bl_head *b = d_hash(hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002097 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002098 struct dentry *dentry;
2099
2100 /*
2101 * Note: There is significant duplication with __d_lookup_rcu which is
2102 * required to prevent single threaded performance regressions
2103 * especially on architectures where smp_rmb (in seqcounts) are costly.
2104 * Keep the two functions in sync.
2105 */
2106
2107 /*
2108 * The hash list is protected using RCU.
2109 *
2110 * Carefully use d_seq when comparing a candidate dentry, to avoid
2111 * races with d_move().
2112 *
2113 * It is possible that concurrent renames can mess up our list
2114 * walk here and result in missing our dentry, resulting in the
2115 * false-negative result. d_lookup() protects against concurrent
2116 * renames using rename_lock seqlock.
2117 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002118 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002119 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002120 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002121 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002122
Nick Piggin31e6b012011-01-07 17:49:52 +11002123seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002124 /*
2125 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002126 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002127 *
2128 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002129 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002130 *
2131 * NOTE! We do a "raw" seqcount_begin here. That means that
2132 * we don't wait for the sequence count to stabilize if it
2133 * is in the middle of a sequence change. If we do the slow
2134 * dentry compare, we will do seqretries until it is stable,
2135 * and if we end up with a successful lookup, we actually
2136 * want to exit RCU lookup anyway.
Al Virod4c91a82016-06-25 23:33:49 -04002137 *
2138 * Note that raw_seqcount_begin still *does* smp_rmb(), so
2139 * we are still guaranteed NUL-termination of ->d_name.name.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002140 */
2141 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002142 if (dentry->d_parent != parent)
2143 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002144 if (d_unhashed(dentry))
2145 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002146
2147 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Al Virod4c91a82016-06-25 23:33:49 -04002148 int tlen;
2149 const char *tname;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002150 if (dentry->d_name.hash != hashlen_hash(hashlen))
2151 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002152 tlen = dentry->d_name.len;
2153 tname = dentry->d_name.name;
2154 /* we want a consistent (name,len) pair */
2155 if (read_seqcount_retry(&dentry->d_seq, seq)) {
2156 cpu_relax();
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002157 goto seqretry;
2158 }
Al Viro6fa67e72016-07-31 16:37:25 -04002159 if (parent->d_op->d_compare(dentry,
Al Virod4c91a82016-06-25 23:33:49 -04002160 tlen, tname, name) != 0)
2161 continue;
2162 } else {
2163 if (dentry->d_name.hash_len != hashlen)
2164 continue;
2165 if (dentry_cmp(dentry, str, hashlen_len(hashlen)) != 0)
2166 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002167 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07002168 *seqp = seq;
Al Virod4c91a82016-06-25 23:33:49 -04002169 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002170 }
2171 return NULL;
2172}
2173
2174/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 * d_lookup - search for a dentry
2176 * @parent: parent dentry
2177 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002178 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002180 * d_lookup searches the children of the parent dentry for the name in
2181 * question. If the dentry is found its reference count is incremented and the
2182 * dentry is returned. The caller must use dput to free the entry when it has
2183 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 */
Al Viroda2d8452013-01-24 18:29:34 -05002185struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186{
Nick Piggin31e6b012011-01-07 17:49:52 +11002187 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002188 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189
Daeseok Younb8314f92014-08-11 11:46:53 +09002190 do {
2191 seq = read_seqbegin(&rename_lock);
2192 dentry = __d_lookup(parent, name);
2193 if (dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 break;
2195 } while (read_seqretry(&rename_lock, seq));
2196 return dentry;
2197}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002198EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199
Nick Piggin31e6b012011-01-07 17:49:52 +11002200/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002201 * __d_lookup - search for a dentry (racy)
2202 * @parent: parent dentry
2203 * @name: qstr of name we wish to find
2204 * Returns: dentry, or NULL
2205 *
2206 * __d_lookup is like d_lookup, however it may (rarely) return a
2207 * false-negative result due to unrelated rename activity.
2208 *
2209 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2210 * however it must be used carefully, eg. with a following d_lookup in
2211 * the case of failure.
2212 *
2213 * __d_lookup callers must be commented.
2214 */
Al Viroa713ca22013-01-24 18:27:00 -05002215struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 unsigned int hash = name->hash;
Linus Torvalds8387ff22016-06-10 07:51:30 -07002218 struct hlist_bl_head *b = d_hash(hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002219 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002220 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002221 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222
Nick Pigginb04f7842010-08-18 04:37:34 +10002223 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002224 * Note: There is significant duplication with __d_lookup_rcu which is
2225 * required to prevent single threaded performance regressions
2226 * especially on architectures where smp_rmb (in seqcounts) are costly.
2227 * Keep the two functions in sync.
2228 */
2229
2230 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002231 * The hash list is protected using RCU.
2232 *
2233 * Take d_lock when comparing a candidate dentry, to avoid races
2234 * with d_move().
2235 *
2236 * It is possible that concurrent renames can mess up our list
2237 * walk here and result in missing our dentry, resulting in the
2238 * false-negative result. d_lookup() protects against concurrent
2239 * renames using rename_lock seqlock.
2240 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002241 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002242 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 rcu_read_lock();
2244
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002245 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247 if (dentry->d_name.hash != hash)
2248 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249
2250 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251 if (dentry->d_parent != parent)
2252 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002253 if (d_unhashed(dentry))
2254 goto next;
2255
Al Virod4c91a82016-06-25 23:33:49 -04002256 if (!d_same_name(dentry, parent, name))
2257 goto next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258
Waiman Long98474232013-08-28 18:24:59 -07002259 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002260 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 spin_unlock(&dentry->d_lock);
2262 break;
2263next:
2264 spin_unlock(&dentry->d_lock);
2265 }
2266 rcu_read_unlock();
2267
2268 return found;
2269}
2270
2271/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002272 * d_hash_and_lookup - hash the qstr then search for a dentry
2273 * @dir: Directory to search in
2274 * @name: qstr of name we wish to find
2275 *
Al Viro4f522a22013-02-11 23:20:37 -05002276 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002277 */
2278struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2279{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002280 /*
2281 * Check for a fs-specific hash function. Note that we must
2282 * calculate the standard hash first, as the d_op->d_hash()
2283 * routine may choose to leave the hash value unchanged.
2284 */
Linus Torvalds8387ff22016-06-10 07:51:30 -07002285 name->hash = full_name_hash(dir, name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002286 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002287 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002288 if (unlikely(err < 0))
2289 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002290 }
Al Viro4f522a22013-02-11 23:20:37 -05002291 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002292}
Al Viro4f522a22013-02-11 23:20:37 -05002293EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002294
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295/*
2296 * When a file is deleted, we have two options:
2297 * - turn this dentry into a negative dentry
2298 * - unhash this dentry and free it.
2299 *
2300 * Usually, we want to just turn this into
2301 * a negative dentry, but if anybody else is
2302 * currently using the dentry or the inode
2303 * we can't do that and we fall back on removing
2304 * it from the hash queues and waiting for
2305 * it to be deleted later when it has no users
2306 */
2307
2308/**
2309 * d_delete - delete a dentry
2310 * @dentry: The dentry to delete
2311 *
2312 * Turn the dentry into a negative dentry if possible, otherwise
2313 * remove it from the hash queues so it can be deleted later
2314 */
2315
2316void d_delete(struct dentry * dentry)
2317{
Nick Piggin873feea2011-01-07 17:50:06 +11002318 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002319 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 /*
2321 * Are we the only user?
2322 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002323again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002325 inode = dentry->d_inode;
2326 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002327 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002328 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002329 spin_unlock(&dentry->d_lock);
2330 cpu_relax();
2331 goto again;
2332 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002333 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002334 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002335 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 return;
2337 }
2338
2339 if (!d_unhashed(dentry))
2340 __d_drop(dentry);
2341
2342 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002343
2344 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002346EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347
Al Viro15d3c582016-07-29 17:45:21 -04002348static void __d_rehash(struct dentry *entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349{
Al Viro15d3c582016-07-29 17:45:21 -04002350 struct hlist_bl_head *b = d_hash(entry->d_name.hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002351 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002352 hlist_bl_lock(b);
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002353 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002354 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355}
2356
2357/**
2358 * d_rehash - add an entry back to the hash
2359 * @entry: dentry to add to the hash
2360 *
2361 * Adds a dentry to the hash according to its name.
2362 */
2363
2364void d_rehash(struct dentry * entry)
2365{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366 spin_lock(&entry->d_lock);
Al Viro15d3c582016-07-29 17:45:21 -04002367 __d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002368 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002370EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371
Al Viro84e710d2016-04-15 00:58:55 -04002372static inline unsigned start_dir_add(struct inode *dir)
2373{
2374
2375 for (;;) {
2376 unsigned n = dir->i_dir_seq;
2377 if (!(n & 1) && cmpxchg(&dir->i_dir_seq, n, n + 1) == n)
2378 return n;
2379 cpu_relax();
2380 }
2381}
2382
2383static inline void end_dir_add(struct inode *dir, unsigned n)
2384{
2385 smp_store_release(&dir->i_dir_seq, n + 2);
2386}
2387
Al Virod9171b92016-04-15 03:33:13 -04002388static void d_wait_lookup(struct dentry *dentry)
2389{
2390 if (d_in_lookup(dentry)) {
2391 DECLARE_WAITQUEUE(wait, current);
2392 add_wait_queue(dentry->d_wait, &wait);
2393 do {
2394 set_current_state(TASK_UNINTERRUPTIBLE);
2395 spin_unlock(&dentry->d_lock);
2396 schedule();
2397 spin_lock(&dentry->d_lock);
2398 } while (d_in_lookup(dentry));
2399 }
2400}
2401
Al Viro94bdd652016-04-15 02:42:04 -04002402struct dentry *d_alloc_parallel(struct dentry *parent,
Al Virod9171b92016-04-15 03:33:13 -04002403 const struct qstr *name,
2404 wait_queue_head_t *wq)
Al Viro94bdd652016-04-15 02:42:04 -04002405{
Al Viro94bdd652016-04-15 02:42:04 -04002406 unsigned int hash = name->hash;
Al Viro94bdd652016-04-15 02:42:04 -04002407 struct hlist_bl_head *b = in_lookup_hash(parent, hash);
2408 struct hlist_bl_node *node;
2409 struct dentry *new = d_alloc(parent, name);
2410 struct dentry *dentry;
2411 unsigned seq, r_seq, d_seq;
2412
2413 if (unlikely(!new))
2414 return ERR_PTR(-ENOMEM);
2415
2416retry:
2417 rcu_read_lock();
2418 seq = smp_load_acquire(&parent->d_inode->i_dir_seq) & ~1;
2419 r_seq = read_seqbegin(&rename_lock);
2420 dentry = __d_lookup_rcu(parent, name, &d_seq);
2421 if (unlikely(dentry)) {
2422 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2423 rcu_read_unlock();
2424 goto retry;
2425 }
2426 if (read_seqcount_retry(&dentry->d_seq, d_seq)) {
2427 rcu_read_unlock();
2428 dput(dentry);
2429 goto retry;
2430 }
2431 rcu_read_unlock();
2432 dput(new);
2433 return dentry;
2434 }
2435 if (unlikely(read_seqretry(&rename_lock, r_seq))) {
2436 rcu_read_unlock();
2437 goto retry;
2438 }
2439 hlist_bl_lock(b);
2440 if (unlikely(parent->d_inode->i_dir_seq != seq)) {
2441 hlist_bl_unlock(b);
2442 rcu_read_unlock();
2443 goto retry;
2444 }
Al Viro94bdd652016-04-15 02:42:04 -04002445 /*
2446 * No changes for the parent since the beginning of d_lookup().
2447 * Since all removals from the chain happen with hlist_bl_lock(),
2448 * any potential in-lookup matches are going to stay here until
2449 * we unlock the chain. All fields are stable in everything
2450 * we encounter.
2451 */
2452 hlist_bl_for_each_entry(dentry, node, b, d_u.d_in_lookup_hash) {
2453 if (dentry->d_name.hash != hash)
2454 continue;
2455 if (dentry->d_parent != parent)
2456 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002457 if (!d_same_name(dentry, parent, name))
2458 continue;
Al Viro94bdd652016-04-15 02:42:04 -04002459 hlist_bl_unlock(b);
Al Viroe7d6ef92016-06-20 01:35:59 -04002460 /* now we can try to grab a reference */
2461 if (!lockref_get_not_dead(&dentry->d_lockref)) {
2462 rcu_read_unlock();
2463 goto retry;
2464 }
2465
2466 rcu_read_unlock();
2467 /*
2468 * somebody is likely to be still doing lookup for it;
2469 * wait for them to finish
2470 */
Al Virod9171b92016-04-15 03:33:13 -04002471 spin_lock(&dentry->d_lock);
2472 d_wait_lookup(dentry);
2473 /*
2474 * it's not in-lookup anymore; in principle we should repeat
2475 * everything from dcache lookup, but it's likely to be what
2476 * d_lookup() would've found anyway. If it is, just return it;
2477 * otherwise we really have to repeat the whole thing.
2478 */
2479 if (unlikely(dentry->d_name.hash != hash))
2480 goto mismatch;
2481 if (unlikely(dentry->d_parent != parent))
2482 goto mismatch;
2483 if (unlikely(d_unhashed(dentry)))
2484 goto mismatch;
Al Virod4c91a82016-06-25 23:33:49 -04002485 if (unlikely(!d_same_name(dentry, parent, name)))
2486 goto mismatch;
Al Virod9171b92016-04-15 03:33:13 -04002487 /* OK, it *is* a hashed match; return it */
2488 spin_unlock(&dentry->d_lock);
Al Viro94bdd652016-04-15 02:42:04 -04002489 dput(new);
2490 return dentry;
2491 }
Al Viroe7d6ef92016-06-20 01:35:59 -04002492 rcu_read_unlock();
Al Viro94bdd652016-04-15 02:42:04 -04002493 /* we can't take ->d_lock here; it's OK, though. */
2494 new->d_flags |= DCACHE_PAR_LOOKUP;
Al Virod9171b92016-04-15 03:33:13 -04002495 new->d_wait = wq;
Al Viro94bdd652016-04-15 02:42:04 -04002496 hlist_bl_add_head_rcu(&new->d_u.d_in_lookup_hash, b);
2497 hlist_bl_unlock(b);
2498 return new;
Al Virod9171b92016-04-15 03:33:13 -04002499mismatch:
2500 spin_unlock(&dentry->d_lock);
2501 dput(dentry);
2502 goto retry;
Al Viro94bdd652016-04-15 02:42:04 -04002503}
2504EXPORT_SYMBOL(d_alloc_parallel);
2505
Al Viro85c7f812016-04-14 19:52:13 -04002506void __d_lookup_done(struct dentry *dentry)
2507{
Al Viro94bdd652016-04-15 02:42:04 -04002508 struct hlist_bl_head *b = in_lookup_hash(dentry->d_parent,
2509 dentry->d_name.hash);
2510 hlist_bl_lock(b);
Al Viro85c7f812016-04-14 19:52:13 -04002511 dentry->d_flags &= ~DCACHE_PAR_LOOKUP;
Al Viro94bdd652016-04-15 02:42:04 -04002512 __hlist_bl_del(&dentry->d_u.d_in_lookup_hash);
Al Virod9171b92016-04-15 03:33:13 -04002513 wake_up_all(dentry->d_wait);
2514 dentry->d_wait = NULL;
Al Viro94bdd652016-04-15 02:42:04 -04002515 hlist_bl_unlock(b);
2516 INIT_HLIST_NODE(&dentry->d_u.d_alias);
Al Virod9171b92016-04-15 03:33:13 -04002517 INIT_LIST_HEAD(&dentry->d_lru);
Al Viro85c7f812016-04-14 19:52:13 -04002518}
2519EXPORT_SYMBOL(__d_lookup_done);
Al Viroed782b52016-03-09 19:52:39 -05002520
2521/* inode->i_lock held if inode is non-NULL */
2522
2523static inline void __d_add(struct dentry *dentry, struct inode *inode)
2524{
Al Viro84e710d2016-04-15 00:58:55 -04002525 struct inode *dir = NULL;
2526 unsigned n;
Al Viro0568d702016-04-14 19:40:56 -04002527 spin_lock(&dentry->d_lock);
Al Viro84e710d2016-04-15 00:58:55 -04002528 if (unlikely(d_in_lookup(dentry))) {
2529 dir = dentry->d_parent->d_inode;
2530 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002531 __d_lookup_done(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002532 }
Al Viroed782b52016-03-09 19:52:39 -05002533 if (inode) {
Al Viro0568d702016-04-14 19:40:56 -04002534 unsigned add_flags = d_flags_for_inode(inode);
2535 hlist_add_head(&dentry->d_u.d_alias, &inode->i_dentry);
2536 raw_write_seqcount_begin(&dentry->d_seq);
2537 __d_set_inode_and_type(dentry, inode, add_flags);
2538 raw_write_seqcount_end(&dentry->d_seq);
Al Viroaffda482016-05-29 18:35:12 -04002539 fsnotify_update_flags(dentry);
Al Viroed782b52016-03-09 19:52:39 -05002540 }
Al Viro15d3c582016-07-29 17:45:21 -04002541 __d_rehash(dentry);
Al Viro84e710d2016-04-15 00:58:55 -04002542 if (dir)
2543 end_dir_add(dir, n);
Al Viro0568d702016-04-14 19:40:56 -04002544 spin_unlock(&dentry->d_lock);
2545 if (inode)
2546 spin_unlock(&inode->i_lock);
Al Viroed782b52016-03-09 19:52:39 -05002547}
2548
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002549/**
Al Viro34d0d192016-03-08 21:01:03 -05002550 * d_add - add dentry to hash queues
2551 * @entry: dentry to add
2552 * @inode: The inode to attach to this dentry
2553 *
2554 * This adds the entry to the hash queues and initializes @inode.
2555 * The entry was actually filled in earlier during d_alloc().
2556 */
2557
2558void d_add(struct dentry *entry, struct inode *inode)
2559{
Al Virob9680912016-04-11 00:53:26 -04002560 if (inode) {
2561 security_d_instantiate(entry, inode);
Al Viroed782b52016-03-09 19:52:39 -05002562 spin_lock(&inode->i_lock);
Al Virob9680912016-04-11 00:53:26 -04002563 }
Al Viroed782b52016-03-09 19:52:39 -05002564 __d_add(entry, inode);
Al Viro34d0d192016-03-08 21:01:03 -05002565}
2566EXPORT_SYMBOL(d_add);
2567
2568/**
Al Viro668d0cd2016-03-08 12:44:17 -05002569 * d_exact_alias - find and hash an exact unhashed alias
2570 * @entry: dentry to add
2571 * @inode: The inode to go with this dentry
2572 *
2573 * If an unhashed dentry with the same name/parent and desired
2574 * inode already exists, hash and return it. Otherwise, return
2575 * NULL.
2576 *
2577 * Parent directory should be locked.
2578 */
2579struct dentry *d_exact_alias(struct dentry *entry, struct inode *inode)
2580{
2581 struct dentry *alias;
Al Viro668d0cd2016-03-08 12:44:17 -05002582 unsigned int hash = entry->d_name.hash;
2583
2584 spin_lock(&inode->i_lock);
2585 hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
2586 /*
2587 * Don't need alias->d_lock here, because aliases with
2588 * d_parent == entry->d_parent are not subject to name or
2589 * parent changes, because the parent inode i_mutex is held.
2590 */
2591 if (alias->d_name.hash != hash)
2592 continue;
2593 if (alias->d_parent != entry->d_parent)
2594 continue;
Al Virod4c91a82016-06-25 23:33:49 -04002595 if (!d_same_name(alias, entry->d_parent, &entry->d_name))
Al Viro668d0cd2016-03-08 12:44:17 -05002596 continue;
2597 spin_lock(&alias->d_lock);
2598 if (!d_unhashed(alias)) {
2599 spin_unlock(&alias->d_lock);
2600 alias = NULL;
2601 } else {
2602 __dget_dlock(alias);
Al Viro15d3c582016-07-29 17:45:21 -04002603 __d_rehash(alias);
Al Viro668d0cd2016-03-08 12:44:17 -05002604 spin_unlock(&alias->d_lock);
2605 }
2606 spin_unlock(&inode->i_lock);
2607 return alias;
2608 }
2609 spin_unlock(&inode->i_lock);
2610 return NULL;
2611}
2612EXPORT_SYMBOL(d_exact_alias);
2613
2614/**
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002615 * dentry_update_name_case - update case insensitive dentry with a new name
2616 * @dentry: dentry to be updated
2617 * @name: new name
2618 *
2619 * Update a case insensitive dentry with new case of name.
2620 *
2621 * dentry must have been returned by d_lookup with name @name. Old and new
2622 * name lengths must match (ie. no d_compare which allows mismatched name
2623 * lengths).
2624 *
2625 * Parent inode i_mutex must be held over d_lookup and into this call (to
2626 * keep renames and concurrent inserts, and readdir(2) away).
2627 */
Al Viro9aba36d2016-07-20 22:28:45 -04002628void dentry_update_name_case(struct dentry *dentry, const struct qstr *name)
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002629{
Al Viro59551022016-01-22 15:40:57 -05002630 BUG_ON(!inode_is_locked(dentry->d_parent->d_inode));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002631 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2632
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002633 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002634 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002635 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002636 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002637 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002638}
2639EXPORT_SYMBOL(dentry_update_name_case);
2640
Al Viro8d85b482014-09-29 14:54:27 -04002641static void swap_names(struct dentry *dentry, struct dentry *target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002642{
Al Viro8d85b482014-09-29 14:54:27 -04002643 if (unlikely(dname_external(target))) {
2644 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645 /*
2646 * Both external: swap the pointers
2647 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002648 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002649 } else {
2650 /*
2651 * dentry:internal, target:external. Steal target's
2652 * storage and make target internal.
2653 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002654 memcpy(target->d_iname, dentry->d_name.name,
2655 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002656 dentry->d_name.name = target->d_name.name;
2657 target->d_name.name = target->d_iname;
2658 }
2659 } else {
Al Viro8d85b482014-09-29 14:54:27 -04002660 if (unlikely(dname_external(dentry))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002661 /*
2662 * dentry:external, target:internal. Give dentry's
2663 * storage to target and make dentry internal
2664 */
2665 memcpy(dentry->d_iname, target->d_name.name,
2666 target->d_name.len + 1);
2667 target->d_name.name = dentry->d_name.name;
2668 dentry->d_name.name = dentry->d_iname;
2669 } else {
2670 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002671 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002672 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002673 unsigned int i;
2674 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
Mikulas Patocka08d4f772014-09-05 12:16:01 -04002675 kmemcheck_mark_initialized(dentry->d_iname, DNAME_INLINE_LEN);
2676 kmemcheck_mark_initialized(target->d_iname, DNAME_INLINE_LEN);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002677 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2678 swap(((long *) &dentry->d_iname)[i],
2679 ((long *) &target->d_iname)[i]);
2680 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681 }
2682 }
Linus Torvaldsa28ddb82014-09-24 12:27:39 -07002683 swap(dentry->d_name.hash_len, target->d_name.hash_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002684}
2685
Al Viro8d85b482014-09-29 14:54:27 -04002686static void copy_name(struct dentry *dentry, struct dentry *target)
2687{
2688 struct external_name *old_name = NULL;
2689 if (unlikely(dname_external(dentry)))
2690 old_name = external_name(dentry);
2691 if (unlikely(dname_external(target))) {
2692 atomic_inc(&external_name(target)->u.count);
2693 dentry->d_name = target->d_name;
2694 } else {
2695 memcpy(dentry->d_iname, target->d_name.name,
2696 target->d_name.len + 1);
2697 dentry->d_name.name = dentry->d_iname;
2698 dentry->d_name.hash_len = target->d_name.hash_len;
2699 }
2700 if (old_name && likely(atomic_dec_and_test(&old_name->u.count)))
2701 kfree_rcu(old_name, u.head);
2702}
2703
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002704static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2705{
2706 /*
2707 * XXXX: do we really need to take target->d_lock?
2708 */
2709 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2710 spin_lock(&target->d_parent->d_lock);
2711 else {
2712 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2713 spin_lock(&dentry->d_parent->d_lock);
2714 spin_lock_nested(&target->d_parent->d_lock,
2715 DENTRY_D_LOCK_NESTED);
2716 } else {
2717 spin_lock(&target->d_parent->d_lock);
2718 spin_lock_nested(&dentry->d_parent->d_lock,
2719 DENTRY_D_LOCK_NESTED);
2720 }
2721 }
2722 if (target < dentry) {
2723 spin_lock_nested(&target->d_lock, 2);
2724 spin_lock_nested(&dentry->d_lock, 3);
2725 } else {
2726 spin_lock_nested(&dentry->d_lock, 2);
2727 spin_lock_nested(&target->d_lock, 3);
2728 }
2729}
2730
Al Viro986c0192014-09-26 23:11:15 -04002731static void dentry_unlock_for_move(struct dentry *dentry, struct dentry *target)
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002732{
2733 if (target->d_parent != dentry->d_parent)
2734 spin_unlock(&dentry->d_parent->d_lock);
2735 if (target->d_parent != target)
2736 spin_unlock(&target->d_parent->d_lock);
Al Viro986c0192014-09-26 23:11:15 -04002737 spin_unlock(&target->d_lock);
2738 spin_unlock(&dentry->d_lock);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002739}
2740
Linus Torvalds1da177e2005-04-16 15:20:36 -07002741/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002742 * When switching names, the actual string doesn't strictly have to
2743 * be preserved in the target - because we're dropping the target
2744 * anyway. As such, we can just do a simple memcpy() to copy over
Mikhail Efremovd2fa4a82014-09-24 22:14:33 +04002745 * the new name before we switch, unless we are going to rehash
2746 * it. Note that if we *do* unhash the target, we are not allowed
2747 * to rehash it without giving it a new name/hash key - whether
2748 * we swap or overwrite the names here, resulting name won't match
2749 * the reality in filesystem; it's only there for d_path() purposes.
2750 * Note that all of this is happening under rename_lock, so the
2751 * any hash lookup seeing it in the middle of manipulations will
2752 * be discarded anyway. So we do not care what happens to the hash
2753 * key in that case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002754 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002755/*
Al Viro18367502011-07-12 21:42:24 -04002756 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002757 * @dentry: entry to move
2758 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002759 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002760 *
2761 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002762 * dcache entries should not be moved in this way. Caller must hold
2763 * rename_lock, the i_mutex of the source and target directories,
2764 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002765 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002766static void __d_move(struct dentry *dentry, struct dentry *target,
2767 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002768{
Al Viro84e710d2016-04-15 00:58:55 -04002769 struct inode *dir = NULL;
2770 unsigned n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771 if (!dentry->d_inode)
2772 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2773
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002774 BUG_ON(d_ancestor(dentry, target));
2775 BUG_ON(d_ancestor(target, dentry));
2776
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002777 dentry_lock_for_move(dentry, target);
Al Viro84e710d2016-04-15 00:58:55 -04002778 if (unlikely(d_in_lookup(target))) {
2779 dir = target->d_parent->d_inode;
2780 n = start_dir_add(dir);
Al Viro85c7f812016-04-14 19:52:13 -04002781 __d_lookup_done(target);
Al Viro84e710d2016-04-15 00:58:55 -04002782 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002783
Nick Piggin31e6b012011-01-07 17:49:52 +11002784 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002785 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002786
Al Viro15d3c582016-07-29 17:45:21 -04002787 /* unhash both */
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002788 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002789 __d_drop(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002790 __d_drop(target);
2791
Linus Torvalds1da177e2005-04-16 15:20:36 -07002792 /* Switch the names.. */
Al Viro8d85b482014-09-29 14:54:27 -04002793 if (exchange)
2794 swap_names(dentry, target);
2795 else
2796 copy_name(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002797
Al Viro15d3c582016-07-29 17:45:21 -04002798 /* rehash in new place(s) */
2799 __d_rehash(dentry);
2800 if (exchange)
2801 __d_rehash(target);
2802
Al Viro63cf4272014-09-26 23:06:14 -04002803 /* ... and switch them in the tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002804 if (IS_ROOT(dentry)) {
Al Viro63cf4272014-09-26 23:06:14 -04002805 /* splicing a tree */
Al Viro3d56c252016-06-07 21:26:55 -04002806 dentry->d_flags |= DCACHE_RCUACCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002807 dentry->d_parent = target->d_parent;
2808 target->d_parent = target;
Al Viro946e51f2014-10-26 19:19:16 -04002809 list_del_init(&target->d_child);
2810 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002811 } else {
Al Viro63cf4272014-09-26 23:06:14 -04002812 /* swapping two dentries */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002813 swap(dentry->d_parent, target->d_parent);
Al Viro946e51f2014-10-26 19:19:16 -04002814 list_move(&target->d_child, &target->d_parent->d_subdirs);
2815 list_move(&dentry->d_child, &dentry->d_parent->d_subdirs);
Al Viro63cf4272014-09-26 23:06:14 -04002816 if (exchange)
Al Viroaffda482016-05-29 18:35:12 -04002817 fsnotify_update_flags(target);
2818 fsnotify_update_flags(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002819 }
2820
Nick Piggin31e6b012011-01-07 17:49:52 +11002821 write_seqcount_end(&target->d_seq);
2822 write_seqcount_end(&dentry->d_seq);
2823
Al Viro84e710d2016-04-15 00:58:55 -04002824 if (dir)
2825 end_dir_add(dir, n);
Al Viro986c0192014-09-26 23:11:15 -04002826 dentry_unlock_for_move(dentry, target);
Al Viro18367502011-07-12 21:42:24 -04002827}
2828
2829/*
2830 * d_move - move a dentry
2831 * @dentry: entry to move
2832 * @target: new dentry
2833 *
2834 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002835 * dcache entries should not be moved in this way. See the locking
2836 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002837 */
2838void d_move(struct dentry *dentry, struct dentry *target)
2839{
2840 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002841 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002842 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002843}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002844EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002845
Miklos Szeredida1ce062014-04-01 17:08:43 +02002846/*
2847 * d_exchange - exchange two dentries
2848 * @dentry1: first dentry
2849 * @dentry2: second dentry
2850 */
2851void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2852{
2853 write_seqlock(&rename_lock);
2854
2855 WARN_ON(!dentry1->d_inode);
2856 WARN_ON(!dentry2->d_inode);
2857 WARN_ON(IS_ROOT(dentry1));
2858 WARN_ON(IS_ROOT(dentry2));
2859
2860 __d_move(dentry1, dentry2, true);
2861
2862 write_sequnlock(&rename_lock);
2863}
2864
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002865/**
2866 * d_ancestor - search for an ancestor
2867 * @p1: ancestor dentry
2868 * @p2: child dentry
2869 *
2870 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2871 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002872 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002873struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002874{
2875 struct dentry *p;
2876
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002877 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002878 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002879 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002880 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002881 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002882}
2883
2884/*
2885 * This helper attempts to cope with remotely renamed directories
2886 *
2887 * It assumes that the caller is already holding
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002888 * dentry->d_parent->d_inode->i_mutex, and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002889 *
2890 * Note: If ever the locking in lock_rename() changes, then please
2891 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002892 */
Al Virob5ae6b12014-10-12 22:16:02 -04002893static int __d_unalias(struct inode *inode,
Nick Piggin873feea2011-01-07 17:50:06 +11002894 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002895{
Al Viro9902af72016-04-15 15:08:36 -04002896 struct mutex *m1 = NULL;
2897 struct rw_semaphore *m2 = NULL;
J. Bruce Fields3d330dc2015-02-10 10:55:53 -05002898 int ret = -ESTALE;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002899
2900 /* If alias and dentry share a parent, then no extra locks required */
2901 if (alias->d_parent == dentry->d_parent)
2902 goto out_unalias;
2903
Trond Myklebust9eaef272006-10-21 10:24:20 -07002904 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002905 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2906 goto out_err;
2907 m1 = &dentry->d_sb->s_vfs_rename_mutex;
Al Viro9902af72016-04-15 15:08:36 -04002908 if (!inode_trylock_shared(alias->d_parent->d_inode))
Trond Myklebust9eaef272006-10-21 10:24:20 -07002909 goto out_err;
Al Viro9902af72016-04-15 15:08:36 -04002910 m2 = &alias->d_parent->d_inode->i_rwsem;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002911out_unalias:
Eric W. Biederman8ed936b2013-10-01 18:33:48 -07002912 __d_move(alias, dentry, false);
Al Virob5ae6b12014-10-12 22:16:02 -04002913 ret = 0;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002914out_err:
Trond Myklebust9eaef272006-10-21 10:24:20 -07002915 if (m2)
Al Viro9902af72016-04-15 15:08:36 -04002916 up_read(m2);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002917 if (m1)
2918 mutex_unlock(m1);
2919 return ret;
2920}
2921
David Howells770bfad2006-08-22 20:06:07 -04002922/**
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002923 * d_splice_alias - splice a disconnected dentry into the tree if one exists
2924 * @inode: the inode which may have a disconnected dentry
2925 * @dentry: a negative dentry which we want to point to the inode.
2926 *
J. Bruce Fieldsda093a92014-02-17 18:03:57 -05002927 * If inode is a directory and has an IS_ROOT alias, then d_move that in
2928 * place of the given dentry and return it, else simply d_add the inode
2929 * to the dentry and return NULL.
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002930 *
J. Bruce Fields908790f2014-02-17 17:58:42 -05002931 * If a non-IS_ROOT directory is found, the filesystem is corrupt, and
2932 * we should error out: directories can't have multiple aliases.
2933 *
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002934 * This is needed in the lookup routine of any filesystem that is exportable
2935 * (via knfsd) so that we can build dcache paths to directories effectively.
2936 *
2937 * If a dentry was found and moved, then it is returned. Otherwise NULL
2938 * is returned. This matches the expected return value of ->lookup.
2939 *
2940 * Cluster filesystems may call this function with a negative, hashed dentry.
2941 * In that case, we know that the inode will be a regular file, and also this
2942 * will only occur during atomic_open. So we need to check for the dentry
2943 * being already hashed only in the final case.
2944 */
2945struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
2946{
J. Bruce Fields3f70bd52014-02-18 14:11:26 -05002947 if (IS_ERR(inode))
2948 return ERR_CAST(inode);
2949
David Howells770bfad2006-08-22 20:06:07 -04002950 BUG_ON(!d_unhashed(dentry));
2951
Al Virode689f52016-03-09 18:05:42 -05002952 if (!inode)
Al Virob5ae6b12014-10-12 22:16:02 -04002953 goto out;
Al Virode689f52016-03-09 18:05:42 -05002954
Al Virob9680912016-04-11 00:53:26 -04002955 security_d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11002956 spin_lock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002957 if (S_ISDIR(inode->i_mode)) {
Al Virob5ae6b12014-10-12 22:16:02 -04002958 struct dentry *new = __d_find_any_alias(inode);
2959 if (unlikely(new)) {
Eric W. Biedermana03e2832015-08-15 13:36:41 -05002960 /* The reference to new ensures it remains an alias */
2961 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002962 write_seqlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002963 if (unlikely(d_ancestor(new, dentry))) {
Al Viro18367502011-07-12 21:42:24 -04002964 write_sequnlock(&rename_lock);
Al Virob5ae6b12014-10-12 22:16:02 -04002965 dput(new);
2966 new = ERR_PTR(-ELOOP);
2967 pr_warn_ratelimited(
2968 "VFS: Lookup of '%s' in %s %s"
2969 " would have caused loop\n",
2970 dentry->d_name.name,
2971 inode->i_sb->s_type->name,
2972 inode->i_sb->s_id);
2973 } else if (!IS_ROOT(new)) {
2974 int err = __d_unalias(inode, dentry, new);
2975 write_sequnlock(&rename_lock);
2976 if (err) {
2977 dput(new);
2978 new = ERR_PTR(err);
2979 }
Al Viro18367502011-07-12 21:42:24 -04002980 } else {
Al Virob5ae6b12014-10-12 22:16:02 -04002981 __d_move(new, dentry, false);
2982 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002983 }
Al Virob5ae6b12014-10-12 22:16:02 -04002984 iput(inode);
2985 return new;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002986 }
David Howells770bfad2006-08-22 20:06:07 -04002987 }
Al Virob5ae6b12014-10-12 22:16:02 -04002988out:
Al Viroed782b52016-03-09 19:52:39 -05002989 __d_add(dentry, inode);
Al Virob5ae6b12014-10-12 22:16:02 -04002990 return NULL;
David Howells770bfad2006-08-22 20:06:07 -04002991}
Al Virob5ae6b12014-10-12 22:16:02 -04002992EXPORT_SYMBOL(d_splice_alias);
David Howells770bfad2006-08-22 20:06:07 -04002993
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002994static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002995{
2996 *buflen -= namelen;
2997 if (*buflen < 0)
2998 return -ENAMETOOLONG;
2999 *buffer -= namelen;
3000 memcpy(*buffer, str, namelen);
3001 return 0;
3002}
3003
Waiman Long232d2d62013-09-09 12:18:13 -04003004/**
3005 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04003006 * @buffer: buffer pointer
3007 * @buflen: allocated length of the buffer
3008 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04003009 *
3010 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
3011 * make sure that either the old or the new name pointer and length are
3012 * fetched. However, there may be mismatch between length and pointer.
3013 * The length cannot be trusted, we need to copy it byte-by-byte until
3014 * the length is reached or a null byte is found. It also prepends "/" at
3015 * the beginning of the name. The sequence number check at the caller will
3016 * retry it again when a d_move() does happen. So any garbage in the buffer
3017 * due to mismatched pointer and length will be discarded.
Al Viro6d13f692014-09-29 14:46:30 -04003018 *
3019 * Data dependency barrier is needed to make sure that we see that terminating
3020 * NUL. Alpha strikes again, film at 11...
Waiman Long232d2d62013-09-09 12:18:13 -04003021 */
Al Viro9aba36d2016-07-20 22:28:45 -04003022static int prepend_name(char **buffer, int *buflen, const struct qstr *name)
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003023{
Waiman Long232d2d62013-09-09 12:18:13 -04003024 const char *dname = ACCESS_ONCE(name->name);
3025 u32 dlen = ACCESS_ONCE(name->len);
3026 char *p;
3027
Al Viro6d13f692014-09-29 14:46:30 -04003028 smp_read_barrier_depends();
3029
Waiman Long232d2d62013-09-09 12:18:13 -04003030 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04003031 if (*buflen < 0)
3032 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04003033 p = *buffer -= dlen + 1;
3034 *p++ = '/';
3035 while (dlen--) {
3036 char c = *dname++;
3037 if (!c)
3038 break;
3039 *p++ = c;
3040 }
3041 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003042}
3043
Linus Torvalds1da177e2005-04-16 15:20:36 -07003044/**
Randy Dunlap208898c2010-11-18 15:02:49 -08003045 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003046 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003047 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003048 * @buffer: pointer to the end of the buffer
3049 * @buflen: pointer to buffer length
3050 *
Waiman Long18129972013-09-12 10:55:35 -04003051 * The function will first try to write out the pathname without taking any
3052 * lock other than the RCU read lock to make sure that dentries won't go away.
3053 * It only checks the sequence number of the global rename_lock as any change
3054 * in the dentry's d_seq will be preceded by changes in the rename_lock
3055 * sequence number. If the sequence number had been changed, it will restart
3056 * the whole pathname back-tracing sequence again by taking the rename_lock.
3057 * In this case, there is no need to take the RCU read lock as the recursive
3058 * parent pointer references will keep the dentry chain alive as long as no
3059 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003060 */
Al Viro02125a82011-12-05 08:43:34 -05003061static int prepend_path(const struct path *path,
3062 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003063 char **buffer, int *buflen)
3064{
Al Viroede4ceb2013-11-13 07:45:40 -05003065 struct dentry *dentry;
3066 struct vfsmount *vfsmnt;
3067 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003068 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04003069 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04003070 char *bptr;
3071 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003072
Al Viro48f5ec22013-09-09 15:22:25 -04003073 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04003074restart_mnt:
3075 read_seqbegin_or_lock(&mount_lock, &m_seq);
3076 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003077 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003078restart:
3079 bptr = *buffer;
3080 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04003081 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05003082 dentry = path->dentry;
3083 vfsmnt = path->mnt;
3084 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04003085 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003086 while (dentry != root->dentry || vfsmnt != root->mnt) {
3087 struct dentry * parent;
3088
3089 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04003090 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Eric W. Biedermancde93be2015-08-15 13:36:12 -05003091 /* Escaped? */
3092 if (dentry != vfsmnt->mnt_root) {
3093 bptr = *buffer;
3094 blen = *buflen;
3095 error = 3;
3096 break;
3097 }
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003098 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04003099 if (mnt != parent) {
3100 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
3101 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04003102 vfsmnt = &mnt->mnt;
3103 continue;
3104 }
Waiman Long232d2d62013-09-09 12:18:13 -04003105 if (!error)
3106 error = is_mounted(vfsmnt) ? 1 : 2;
3107 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003108 }
3109 parent = dentry->d_parent;
3110 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003111 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003112 if (error)
3113 break;
3114
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003115 dentry = parent;
3116 }
Al Viro48f5ec22013-09-09 15:22:25 -04003117 if (!(seq & 1))
3118 rcu_read_unlock();
3119 if (need_seqretry(&rename_lock, seq)) {
3120 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003121 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003122 }
Al Viro48f5ec22013-09-09 15:22:25 -04003123 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08003124
3125 if (!(m_seq & 1))
3126 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04003127 if (need_seqretry(&mount_lock, m_seq)) {
3128 m_seq = 1;
3129 goto restart_mnt;
3130 }
3131 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003132
Waiman Long232d2d62013-09-09 12:18:13 -04003133 if (error >= 0 && bptr == *buffer) {
3134 if (--blen < 0)
3135 error = -ENAMETOOLONG;
3136 else
3137 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003138 }
Waiman Long232d2d62013-09-09 12:18:13 -04003139 *buffer = bptr;
3140 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04003141 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003142}
3143
3144/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003145 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003146 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05003147 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07003148 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07003149 * @buflen: buffer length
3150 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003151 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003152 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003153 * Returns a pointer into the buffer or an error code if the
3154 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08003155 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04003156 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01003157 *
Al Viro02125a82011-12-05 08:43:34 -05003158 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003159 */
Al Viro02125a82011-12-05 08:43:34 -05003160char *__d_path(const struct path *path,
3161 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003162 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003163{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003164 char *res = buf + buflen;
3165 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003166
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003167 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003168 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04003169
Al Viro02125a82011-12-05 08:43:34 -05003170 if (error < 0)
3171 return ERR_PTR(error);
3172 if (error > 0)
3173 return NULL;
3174 return res;
3175}
3176
3177char *d_absolute_path(const struct path *path,
3178 char *buf, int buflen)
3179{
3180 struct path root = {};
3181 char *res = buf + buflen;
3182 int error;
3183
3184 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003185 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05003186
3187 if (error > 1)
3188 error = -EINVAL;
3189 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003190 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02003191 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003192}
3193
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003194/*
3195 * same as __d_path but appends "(deleted)" for unlinked files.
3196 */
Al Viro02125a82011-12-05 08:43:34 -05003197static int path_with_deleted(const struct path *path,
3198 const struct path *root,
3199 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003200{
3201 prepend(buf, buflen, "\0", 1);
3202 if (d_unlinked(path->dentry)) {
3203 int error = prepend(buf, buflen, " (deleted)", 10);
3204 if (error)
3205 return error;
3206 }
3207
3208 return prepend_path(path, root, buf, buflen);
3209}
3210
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003211static int prepend_unreachable(char **buffer, int *buflen)
3212{
3213 return prepend(buffer, buflen, "(unreachable)", 13);
3214}
3215
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003216static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
3217{
3218 unsigned seq;
3219
3220 do {
3221 seq = read_seqcount_begin(&fs->seq);
3222 *root = fs->root;
3223 } while (read_seqcount_retry(&fs->seq, seq));
3224}
3225
Jan Bluncka03a8a702008-02-14 19:38:32 -08003226/**
3227 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08003228 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08003229 * @buf: buffer to return value in
3230 * @buflen: buffer length
3231 *
3232 * Convert a dentry into an ASCII path name. If the entry has been deleted
3233 * the string " (deleted)" is appended. Note that this is ambiguous.
3234 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08003235 * Returns a pointer into the buffer or an error code if the path was
3236 * too long. Note: Callers should use the returned pointer, not the passed
3237 * in buffer, to use the name! The implementation often starts at an offset
3238 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003239 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02003240 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08003241 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07003242char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003243{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003244 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003245 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003246 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003247
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003248 /*
3249 * We have various synthetic filesystems that never get mounted. On
3250 * these filesystems dentries are never used for lookup purposes, and
3251 * thus don't need to be hashed. They also don't need a name until a
3252 * user wants to identify the object in /proc/pid/fd/. The little hack
3253 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003254 *
3255 * Some pseudo inodes are mountable. When they are mounted
3256 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3257 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003258 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003259 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3260 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003261 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003262
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003263 rcu_read_lock();
3264 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003265 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003266 rcu_read_unlock();
3267
Al Viro02125a82011-12-05 08:43:34 -05003268 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003269 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003270 return res;
3271}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003272EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003273
3274/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003275 * Helper function for dentry_operations.d_dname() members
3276 */
3277char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3278 const char *fmt, ...)
3279{
3280 va_list args;
3281 char temp[64];
3282 int sz;
3283
3284 va_start(args, fmt);
3285 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3286 va_end(args);
3287
3288 if (sz > sizeof(temp) || sz > buflen)
3289 return ERR_PTR(-ENAMETOOLONG);
3290
3291 buffer += buflen - sz;
3292 return memcpy(buffer, temp, sz);
3293}
3294
Al Viro118b2302013-08-24 12:08:17 -04003295char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3296{
3297 char *end = buffer + buflen;
3298 /* these dentries are never renamed, so d_lock is not needed */
3299 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003300 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003301 prepend(&end, &buflen, "/", 1))
3302 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003303 return end;
Al Viro118b2302013-08-24 12:08:17 -04003304}
David Herrmann31bbe162014-01-03 14:09:47 +01003305EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003306
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003307/*
Ram Pai6092d042008-03-27 13:06:20 +01003308 * Write full pathname from the root of the filesystem into the buffer.
3309 */
Al Virof6500802014-01-26 12:37:55 -05003310static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003311{
Al Virof6500802014-01-26 12:37:55 -05003312 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003313 char *end, *retval;
3314 int len, seq = 0;
3315 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003316
Al Virof6500802014-01-26 12:37:55 -05003317 if (buflen < 2)
3318 goto Elong;
3319
Al Viro48f5ec22013-09-09 15:22:25 -04003320 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003321restart:
Al Virof6500802014-01-26 12:37:55 -05003322 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003323 end = buf + buflen;
3324 len = buflen;
3325 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003326 /* Get '/' right */
3327 retval = end-1;
3328 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003329 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003330 while (!IS_ROOT(dentry)) {
3331 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003332
Ram Pai6092d042008-03-27 13:06:20 +01003333 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003334 error = prepend_name(&end, &len, &dentry->d_name);
3335 if (error)
3336 break;
Ram Pai6092d042008-03-27 13:06:20 +01003337
3338 retval = end;
3339 dentry = parent;
3340 }
Al Viro48f5ec22013-09-09 15:22:25 -04003341 if (!(seq & 1))
3342 rcu_read_unlock();
3343 if (need_seqretry(&rename_lock, seq)) {
3344 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003345 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003346 }
3347 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003348 if (error)
3349 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003350 return retval;
3351Elong:
3352 return ERR_PTR(-ENAMETOOLONG);
3353}
Nick Pigginec2447c2011-01-07 17:49:29 +11003354
3355char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3356{
Waiman Long232d2d62013-09-09 12:18:13 -04003357 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003358}
3359EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003360
3361char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3362{
3363 char *p = NULL;
3364 char *retval;
3365
Al Viroc1031352010-06-06 22:31:14 -04003366 if (d_unlinked(dentry)) {
3367 p = buf + buflen;
3368 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3369 goto Elong;
3370 buflen++;
3371 }
3372 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003373 if (!IS_ERR(retval) && p)
3374 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003375 return retval;
3376Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003377 return ERR_PTR(-ENAMETOOLONG);
3378}
3379
Linus Torvalds8b19e342013-09-12 10:35:47 -07003380static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3381 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003382{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003383 unsigned seq;
3384
3385 do {
3386 seq = read_seqcount_begin(&fs->seq);
3387 *root = fs->root;
3388 *pwd = fs->pwd;
3389 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003390}
3391
Ram Pai6092d042008-03-27 13:06:20 +01003392/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003393 * NOTE! The user-level library version returns a
3394 * character pointer. The kernel system call just
3395 * returns the length of the buffer filled (which
3396 * includes the ending '\0' character), or a negative
3397 * error value. So libc would do something like
3398 *
3399 * char *getcwd(char * buf, size_t size)
3400 * {
3401 * int retval;
3402 *
3403 * retval = sys_getcwd(buf, size);
3404 * if (retval >= 0)
3405 * return buf;
3406 * errno = -retval;
3407 * return NULL;
3408 * }
3409 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003410SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003411{
Linus Torvalds552ce542007-02-13 12:08:18 -08003412 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003413 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003414 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003415
3416 if (!page)
3417 return -ENOMEM;
3418
Linus Torvalds8b19e342013-09-12 10:35:47 -07003419 rcu_read_lock();
3420 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003421
Linus Torvalds552ce542007-02-13 12:08:18 -08003422 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003423 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003424 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003425 char *cwd = page + PATH_MAX;
3426 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003427
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003428 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003429 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003430 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003431
Al Viro02125a82011-12-05 08:43:34 -05003432 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003433 goto out;
3434
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003435 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003436 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003437 error = prepend_unreachable(&cwd, &buflen);
3438 if (error)
3439 goto out;
3440 }
3441
Linus Torvalds552ce542007-02-13 12:08:18 -08003442 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003443 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003444 if (len <= size) {
3445 error = len;
3446 if (copy_to_user(buf, cwd, len))
3447 error = -EFAULT;
3448 }
Nick Piggin949854d2011-01-07 17:49:37 +11003449 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003450 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003451 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003452
3453out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003454 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003455 return error;
3456}
3457
3458/*
3459 * Test whether new_dentry is a subdirectory of old_dentry.
3460 *
3461 * Trivially implemented using the dcache structure
3462 */
3463
3464/**
3465 * is_subdir - is new dentry a subdirectory of old_dentry
3466 * @new_dentry: new dentry
3467 * @old_dentry: old dentry
3468 *
Yaowei Baia6e57872015-11-17 14:40:11 +08003469 * Returns true if new_dentry is a subdirectory of the parent (at any depth).
3470 * Returns false otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003471 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3472 */
3473
Yaowei Baia6e57872015-11-17 14:40:11 +08003474bool is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003475{
Yaowei Baia6e57872015-11-17 14:40:11 +08003476 bool result;
Nick Piggin949854d2011-01-07 17:49:37 +11003477 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003478
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003479 if (new_dentry == old_dentry)
Yaowei Baia6e57872015-11-17 14:40:11 +08003480 return true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003481
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003482 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003483 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003484 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003485 /*
3486 * Need rcu_readlock to protect against the d_parent trashing
3487 * due to d_move
3488 */
3489 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003490 if (d_ancestor(old_dentry, new_dentry))
Yaowei Baia6e57872015-11-17 14:40:11 +08003491 result = true;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003492 else
Yaowei Baia6e57872015-11-17 14:40:11 +08003493 result = false;
Nick Piggin949854d2011-01-07 17:49:37 +11003494 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003495 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003496
3497 return result;
3498}
3499
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003500static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003501{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003502 struct dentry *root = data;
3503 if (dentry != root) {
3504 if (d_unhashed(dentry) || !dentry->d_inode)
3505 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003506
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003507 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3508 dentry->d_flags |= DCACHE_GENOCIDE;
3509 dentry->d_lockref.count--;
3510 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003511 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003512 return D_WALK_CONTINUE;
3513}
Nick Piggin58db63d2011-01-07 17:49:39 +11003514
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003515void d_genocide(struct dentry *parent)
3516{
3517 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003518}
3519
Al Viro60545d02013-06-07 01:20:27 -04003520void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003521{
Al Viro60545d02013-06-07 01:20:27 -04003522 inode_dec_link_count(inode);
3523 BUG_ON(dentry->d_name.name != dentry->d_iname ||
Al Viro946e51f2014-10-26 19:19:16 -04003524 !hlist_unhashed(&dentry->d_u.d_alias) ||
Al Viro60545d02013-06-07 01:20:27 -04003525 !d_unlinked(dentry));
3526 spin_lock(&dentry->d_parent->d_lock);
3527 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3528 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3529 (unsigned long long)inode->i_ino);
3530 spin_unlock(&dentry->d_lock);
3531 spin_unlock(&dentry->d_parent->d_lock);
3532 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003533}
Al Viro60545d02013-06-07 01:20:27 -04003534EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003535
3536static __initdata unsigned long dhash_entries;
3537static int __init set_dhash_entries(char *str)
3538{
3539 if (!str)
3540 return 0;
3541 dhash_entries = simple_strtoul(str, &str, 0);
3542 return 1;
3543}
3544__setup("dhash_entries=", set_dhash_entries);
3545
3546static void __init dcache_init_early(void)
3547{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003548 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003549
3550 /* If hashes are distributed across NUMA nodes, defer
3551 * hash allocation until vmalloc space is available.
3552 */
3553 if (hashdist)
3554 return;
3555
3556 dentry_hashtable =
3557 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003558 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003559 dhash_entries,
3560 13,
3561 HASH_EARLY,
3562 &d_hash_shift,
3563 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003564 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003565 0);
3566
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003567 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003568 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003569}
3570
Denis Cheng74bf17c2007-10-16 23:26:30 -07003571static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003572{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003573 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003574
3575 /*
3576 * A constructor could be added for stable state like the lists,
3577 * but it is probably not worth it because of the cache nature
3578 * of the dcache.
3579 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003580 dentry_cache = KMEM_CACHE(dentry,
Vladimir Davydov5d097052016-01-14 15:18:21 -08003581 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD|SLAB_ACCOUNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003582
3583 /* Hash may have been set up in dcache_init_early */
3584 if (!hashdist)
3585 return;
3586
3587 dentry_hashtable =
3588 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003589 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003590 dhash_entries,
3591 13,
3592 0,
3593 &d_hash_shift,
3594 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003595 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003596 0);
3597
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003598 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003599 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003600}
3601
3602/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003603struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003604EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003605
Linus Torvalds1da177e2005-04-16 15:20:36 -07003606EXPORT_SYMBOL(d_genocide);
3607
Linus Torvalds1da177e2005-04-16 15:20:36 -07003608void __init vfs_caches_init_early(void)
3609{
3610 dcache_init_early();
3611 inode_init_early();
3612}
3613
Mel Gorman4248b0d2015-08-06 15:46:20 -07003614void __init vfs_caches_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003615{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003616 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003617 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003618
Denis Cheng74bf17c2007-10-16 23:26:30 -07003619 dcache_init();
3620 inode_init();
Mel Gorman4248b0d2015-08-06 15:46:20 -07003621 files_init();
3622 files_maxfiles_init();
Denis Cheng74bf17c2007-10-16 23:26:30 -07003623 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003624 bdev_cache_init();
3625 chrdev_init();
3626}