blob: 6888dde4d568e0e3a36ed41ffa7440c06265c3a5 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/dcache.c
3 *
4 * Complete reimplementation
5 * (C) 1997 Thomas Schoebel-Theuer,
6 * with heavy changes by Linus Torvalds
7 */
8
9/*
10 * Notes on the allocation strategy:
11 *
12 * The dcache is a master of the icache - whenever a dcache entry
13 * exists, the inode will always exist. "iput()" is done either when
14 * the dcache entry is deleted or garbage collected.
15 */
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/syscalls.h>
18#include <linux/string.h>
19#include <linux/mm.h>
20#include <linux/fs.h>
John McCutchan7a91bf72005-08-08 13:52:16 -040021#include <linux/fsnotify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/slab.h>
23#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/hash.h>
25#include <linux/cache.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050026#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/mount.h>
28#include <linux/file.h>
29#include <asm/uaccess.h>
30#include <linux/security.h>
31#include <linux/seqlock.h>
32#include <linux/swap.h>
33#include <linux/bootmem.h>
Al Viro5ad4e532009-03-29 19:50:06 -040034#include <linux/fs_struct.h>
Frederic Weisbecker613afbf2009-07-16 15:44:29 +020035#include <linux/hardirq.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110036#include <linux/bit_spinlock.h>
37#include <linux/rculist_bl.h>
Linus Torvalds268bb0c2011-05-20 12:50:29 -070038#include <linux/prefetch.h>
David Howellsdd179942011-08-16 15:31:30 +010039#include <linux/ratelimit.h>
Dave Chinnerf6041562013-08-28 10:18:00 +100040#include <linux/list_lru.h>
David Howells07f3f052006-09-30 20:52:18 +020041#include "internal.h"
Al Virob2dba1a2011-11-23 19:26:23 -050042#include "mount.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Nick Piggin789680d2011-01-07 17:49:30 +110044/*
45 * Usage:
Nick Piggin873feea2011-01-07 17:50:06 +110046 * dcache->d_inode->i_lock protects:
47 * - i_dentry, d_alias, d_inode of aliases
Nick Pigginceb5bdc2011-01-07 17:50:05 +110048 * dcache_hash_bucket lock protects:
49 * - the dcache hash table
50 * s_anon bl list spinlock protects:
51 * - the s_anon list (see __d_drop)
Dave Chinner19156842013-08-28 10:17:55 +100052 * dentry->d_sb->s_dentry_lru_lock protects:
Nick Piggin23044502011-01-07 17:49:31 +110053 * - the dcache lru lists and counters
54 * d_lock protects:
55 * - d_flags
56 * - d_name
57 * - d_lru
Nick Pigginb7ab39f2011-01-07 17:49:32 +110058 * - d_count
Nick Pigginda502952011-01-07 17:49:33 +110059 * - d_unhashed()
Nick Piggin2fd6b7f2011-01-07 17:49:34 +110060 * - d_parent and d_subdirs
61 * - childrens' d_child and d_parent
Nick Pigginb23fb0a2011-01-07 17:49:35 +110062 * - d_alias, d_inode
Nick Piggin789680d2011-01-07 17:49:30 +110063 *
64 * Ordering:
Nick Piggin873feea2011-01-07 17:50:06 +110065 * dentry->d_inode->i_lock
Nick Pigginb5c84bf2011-01-07 17:49:38 +110066 * dentry->d_lock
Dave Chinner19156842013-08-28 10:17:55 +100067 * dentry->d_sb->s_dentry_lru_lock
Nick Pigginceb5bdc2011-01-07 17:50:05 +110068 * dcache_hash_bucket lock
69 * s_anon lock
Nick Piggin789680d2011-01-07 17:49:30 +110070 *
Nick Pigginda502952011-01-07 17:49:33 +110071 * If there is an ancestor relationship:
72 * dentry->d_parent->...->d_parent->d_lock
73 * ...
74 * dentry->d_parent->d_lock
75 * dentry->d_lock
76 *
77 * If no ancestor relationship:
Nick Piggin789680d2011-01-07 17:49:30 +110078 * if (dentry1 < dentry2)
79 * dentry1->d_lock
80 * dentry2->d_lock
81 */
Eric Dumazetfa3536c2006-03-26 01:37:24 -080082int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070083EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
84
Al Viro74c3cbe2007-07-22 08:04:18 -040085__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Nick Piggin949854d2011-01-07 17:49:37 +110087EXPORT_SYMBOL(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Christoph Lametere18b8902006-12-06 20:33:20 -080089static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Linus Torvalds1da177e2005-04-16 15:20:36 -070091/*
92 * This is the single most critical data structure when it comes
93 * to the dcache: the hashtable for lookups. Somebody should try
94 * to make this good - I've just made it work.
95 *
96 * This hash-function tries to avoid losing too many bits of hash
97 * information, yet avoid using a prime hash-size or similar.
98 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Eric Dumazetfa3536c2006-03-26 01:37:24 -0800100static unsigned int d_hash_mask __read_mostly;
101static unsigned int d_hash_shift __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100102
Linus Torvaldsb07ad992011-04-23 22:32:03 -0700103static struct hlist_bl_head *dentry_hashtable __read_mostly;
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100104
Linus Torvalds8966be92012-03-02 14:23:30 -0800105static inline struct hlist_bl_head *d_hash(const struct dentry *parent,
Linus Torvalds6d7d1a02012-03-19 16:19:53 -0700106 unsigned int hash)
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100107{
Linus Torvalds6d7d1a02012-03-19 16:19:53 -0700108 hash += (unsigned long) parent / L1_CACHE_BYTES;
Al Viro482db902013-10-25 16:41:01 -0400109 hash = hash + (hash >> d_hash_shift);
110 return dentry_hashtable + (hash & d_hash_mask);
Nick Pigginceb5bdc2011-01-07 17:50:05 +1100111}
112
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113/* Statistics gathering. */
114struct dentry_stat_t dentry_stat = {
115 .age_limit = 45,
116};
117
Glauber Costa3942c072013-08-28 10:17:53 +1000118static DEFINE_PER_CPU(long, nr_dentry);
Dave Chinner62d36c72013-08-28 10:17:54 +1000119static DEFINE_PER_CPU(long, nr_dentry_unused);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400120
121#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Dave Chinner62d36c72013-08-28 10:17:54 +1000122
123/*
124 * Here we resort to our own counters instead of using generic per-cpu counters
125 * for consistency with what the vfs inode code does. We are expected to harvest
126 * better code and performance by having our own specialized counters.
127 *
128 * Please note that the loop is done over all possible CPUs, not over all online
129 * CPUs. The reason for this is that we don't want to play games with CPUs going
130 * on and off. If one of them goes off, we will just keep their counters.
131 *
132 * glommer: See cffbc8a for details, and if you ever intend to change this,
133 * please update all vfs counters to match.
134 */
Glauber Costa3942c072013-08-28 10:17:53 +1000135static long get_nr_dentry(void)
Nick Piggin3e880fb2011-01-07 17:49:19 +1100136{
137 int i;
Glauber Costa3942c072013-08-28 10:17:53 +1000138 long sum = 0;
Nick Piggin3e880fb2011-01-07 17:49:19 +1100139 for_each_possible_cpu(i)
140 sum += per_cpu(nr_dentry, i);
141 return sum < 0 ? 0 : sum;
142}
143
Dave Chinner62d36c72013-08-28 10:17:54 +1000144static long get_nr_dentry_unused(void)
145{
146 int i;
147 long sum = 0;
148 for_each_possible_cpu(i)
149 sum += per_cpu(nr_dentry_unused, i);
150 return sum < 0 ? 0 : sum;
151}
152
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400153int proc_nr_dentry(ctl_table *table, int write, void __user *buffer,
154 size_t *lenp, loff_t *ppos)
155{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100156 dentry_stat.nr_dentry = get_nr_dentry();
Dave Chinner62d36c72013-08-28 10:17:54 +1000157 dentry_stat.nr_unused = get_nr_dentry_unused();
Glauber Costa3942c072013-08-28 10:17:53 +1000158 return proc_doulongvec_minmax(table, write, buffer, lenp, ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400159}
160#endif
161
Linus Torvalds5483f182012-03-04 15:51:42 -0800162/*
163 * Compare 2 name strings, return 0 if they match, otherwise non-zero.
164 * The strings are both count bytes long, and count is non-zero.
165 */
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700166#ifdef CONFIG_DCACHE_WORD_ACCESS
167
168#include <asm/word-at-a-time.h>
169/*
170 * NOTE! 'cs' and 'scount' come from a dentry, so it has a
171 * aligned allocation for this particular component. We don't
172 * strictly need the load_unaligned_zeropad() safety, but it
173 * doesn't hurt either.
174 *
175 * In contrast, 'ct' and 'tcount' can be from a pathname, and do
176 * need the careful unaligned handling.
177 */
Linus Torvalds94753db52012-05-10 12:19:19 -0700178static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvalds5483f182012-03-04 15:51:42 -0800179{
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800180 unsigned long a,b,mask;
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800181
182 for (;;) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -0700183 a = *(unsigned long *)cs;
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700184 b = load_unaligned_zeropad(ct);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800185 if (tcount < sizeof(unsigned long))
186 break;
187 if (unlikely(a != b))
188 return 1;
189 cs += sizeof(unsigned long);
190 ct += sizeof(unsigned long);
191 tcount -= sizeof(unsigned long);
192 if (!tcount)
193 return 0;
194 }
Will Deacona5c21dc2013-12-12 17:40:21 +0000195 mask = bytemask_from_count(tcount);
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800196 return unlikely(!!((a ^ b) & mask));
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700197}
198
Linus Torvaldsbfcfaa72012-03-06 11:16:17 -0800199#else
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700200
Linus Torvalds94753db52012-05-10 12:19:19 -0700201static inline int dentry_string_cmp(const unsigned char *cs, const unsigned char *ct, unsigned tcount)
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700202{
Linus Torvalds5483f182012-03-04 15:51:42 -0800203 do {
204 if (*cs != *ct)
205 return 1;
206 cs++;
207 ct++;
208 tcount--;
209 } while (tcount);
210 return 0;
211}
212
Linus Torvaldse419b4c2012-05-03 10:16:43 -0700213#endif
214
Linus Torvalds94753db52012-05-10 12:19:19 -0700215static inline int dentry_cmp(const struct dentry *dentry, const unsigned char *ct, unsigned tcount)
216{
Linus Torvalds6326c712012-05-21 16:14:04 -0700217 const unsigned char *cs;
Linus Torvalds94753db52012-05-10 12:19:19 -0700218 /*
219 * Be careful about RCU walk racing with rename:
220 * use ACCESS_ONCE to fetch the name pointer.
221 *
222 * NOTE! Even if a rename will mean that the length
223 * was not loaded atomically, we don't care. The
224 * RCU walk will check the sequence count eventually,
225 * and catch it. And we won't overrun the buffer,
226 * because we're reading the name pointer atomically,
227 * and a dentry name is guaranteed to be properly
228 * terminated with a NUL byte.
229 *
230 * End result: even if 'len' is wrong, we'll exit
231 * early because the data cannot match (there can
232 * be no NUL in the ct/tcount data)
233 */
Linus Torvalds6326c712012-05-21 16:14:04 -0700234 cs = ACCESS_ONCE(dentry->d_name.name);
235 smp_read_barrier_depends();
236 return dentry_string_cmp(cs, ct, tcount);
Linus Torvalds94753db52012-05-10 12:19:19 -0700237}
238
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400239static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400241 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
242
Al Virob3d9b7a2012-06-09 13:51:19 -0400243 WARN_ON(!hlist_unhashed(&dentry->d_alias));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 if (dname_external(dentry))
245 kfree(dentry->d_name.name);
246 kmem_cache_free(dentry_cache, dentry);
247}
248
Al Virob4f03542014-04-29 23:40:14 -0400249static void dentry_free(struct dentry *dentry)
250{
251 /* if dentry was never visible to RCU, immediate free is OK */
252 if (!(dentry->d_flags & DCACHE_RCUACCESS))
253 __d_free(&dentry->d_u.d_rcu);
254 else
255 call_rcu(&dentry->d_u.d_rcu, __d_free);
256}
257
Nick Piggin31e6b012011-01-07 17:49:52 +1100258/**
259 * dentry_rcuwalk_barrier - invalidate in-progress rcu-walk lookups
Randy Dunlapff5fdb62011-01-22 20:16:06 -0800260 * @dentry: the target dentry
Nick Piggin31e6b012011-01-07 17:49:52 +1100261 * After this call, in-progress rcu-walk path lookup will fail. This
262 * should be called after unhashing, and after changing d_inode (if
263 * the dentry has not already been unhashed).
264 */
265static inline void dentry_rcuwalk_barrier(struct dentry *dentry)
266{
267 assert_spin_locked(&dentry->d_lock);
268 /* Go through a barrier */
269 write_seqcount_barrier(&dentry->d_seq);
270}
271
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272/*
273 * Release the dentry's inode, using the filesystem
Nick Piggin31e6b012011-01-07 17:49:52 +1100274 * d_iput() operation if defined. Dentry has no refcount
275 * and is unhashed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 */
Arjan van de Ven858119e2006-01-14 13:20:43 -0800277static void dentry_iput(struct dentry * dentry)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200278 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100279 __releases(dentry->d_inode->i_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280{
281 struct inode *inode = dentry->d_inode;
282 if (inode) {
283 dentry->d_inode = NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -0400284 hlist_del_init(&dentry->d_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100286 spin_unlock(&inode->i_lock);
Linus Torvaldsf805fbd2005-09-19 19:54:29 -0700287 if (!inode->i_nlink)
288 fsnotify_inoderemove(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 if (dentry->d_op && dentry->d_op->d_iput)
290 dentry->d_op->d_iput(dentry, inode);
291 else
292 iput(inode);
293 } else {
294 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 }
296}
297
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700298/*
Nick Piggin31e6b012011-01-07 17:49:52 +1100299 * Release the dentry's inode, using the filesystem
300 * d_iput() operation if defined. dentry remains in-use.
301 */
302static void dentry_unlink_inode(struct dentry * dentry)
303 __releases(dentry->d_lock)
Nick Piggin873feea2011-01-07 17:50:06 +1100304 __releases(dentry->d_inode->i_lock)
Nick Piggin31e6b012011-01-07 17:49:52 +1100305{
306 struct inode *inode = dentry->d_inode;
David Howellsb18825a2013-09-12 19:22:53 +0100307 __d_clear_type(dentry);
Nick Piggin31e6b012011-01-07 17:49:52 +1100308 dentry->d_inode = NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -0400309 hlist_del_init(&dentry->d_alias);
Nick Piggin31e6b012011-01-07 17:49:52 +1100310 dentry_rcuwalk_barrier(dentry);
311 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100312 spin_unlock(&inode->i_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +1100313 if (!inode->i_nlink)
314 fsnotify_inoderemove(inode);
315 if (dentry->d_op && dentry->d_op->d_iput)
316 dentry->d_op->d_iput(dentry, inode);
317 else
318 iput(inode);
319}
320
321/*
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400322 * The DCACHE_LRU_LIST bit is set whenever the 'd_lru' entry
323 * is in use - which includes both the "real" per-superblock
324 * LRU list _and_ the DCACHE_SHRINK_LIST use.
325 *
326 * The DCACHE_SHRINK_LIST bit is set whenever the dentry is
327 * on the shrink list (ie not on the superblock LRU list).
328 *
329 * The per-cpu "nr_dentry_unused" counters are updated with
330 * the DCACHE_LRU_LIST bit.
331 *
332 * These helper functions make sure we always follow the
333 * rules. d_lock must be held by the caller.
334 */
335#define D_FLAG_VERIFY(dentry,x) WARN_ON_ONCE(((dentry)->d_flags & (DCACHE_LRU_LIST | DCACHE_SHRINK_LIST)) != (x))
336static void d_lru_add(struct dentry *dentry)
337{
338 D_FLAG_VERIFY(dentry, 0);
339 dentry->d_flags |= DCACHE_LRU_LIST;
340 this_cpu_inc(nr_dentry_unused);
341 WARN_ON_ONCE(!list_lru_add(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
342}
343
344static void d_lru_del(struct dentry *dentry)
345{
346 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
347 dentry->d_flags &= ~DCACHE_LRU_LIST;
348 this_cpu_dec(nr_dentry_unused);
349 WARN_ON_ONCE(!list_lru_del(&dentry->d_sb->s_dentry_lru, &dentry->d_lru));
350}
351
352static void d_shrink_del(struct dentry *dentry)
353{
354 D_FLAG_VERIFY(dentry, DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
355 list_del_init(&dentry->d_lru);
356 dentry->d_flags &= ~(DCACHE_SHRINK_LIST | DCACHE_LRU_LIST);
357 this_cpu_dec(nr_dentry_unused);
358}
359
360static void d_shrink_add(struct dentry *dentry, struct list_head *list)
361{
362 D_FLAG_VERIFY(dentry, 0);
363 list_add(&dentry->d_lru, list);
364 dentry->d_flags |= DCACHE_SHRINK_LIST | DCACHE_LRU_LIST;
365 this_cpu_inc(nr_dentry_unused);
366}
367
368/*
369 * These can only be called under the global LRU lock, ie during the
370 * callback for freeing the LRU list. "isolate" removes it from the
371 * LRU lists entirely, while shrink_move moves it to the indicated
372 * private list.
373 */
374static void d_lru_isolate(struct dentry *dentry)
375{
376 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
377 dentry->d_flags &= ~DCACHE_LRU_LIST;
378 this_cpu_dec(nr_dentry_unused);
379 list_del_init(&dentry->d_lru);
380}
381
382static void d_lru_shrink_move(struct dentry *dentry, struct list_head *list)
383{
384 D_FLAG_VERIFY(dentry, DCACHE_LRU_LIST);
385 dentry->d_flags |= DCACHE_SHRINK_LIST;
386 list_move_tail(&dentry->d_lru, list);
387}
388
389/*
Dave Chinnerf6041562013-08-28 10:18:00 +1000390 * dentry_lru_(add|del)_list) must be called with d_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700391 */
392static void dentry_lru_add(struct dentry *dentry)
393{
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400394 if (unlikely(!(dentry->d_flags & DCACHE_LRU_LIST)))
395 d_lru_add(dentry);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700396}
397
Miklos Szeredid52b9082007-05-08 00:23:46 -0700398/**
Nick Piggin789680d2011-01-07 17:49:30 +1100399 * d_drop - drop a dentry
400 * @dentry: dentry to drop
401 *
402 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
403 * be found through a VFS lookup any more. Note that this is different from
404 * deleting the dentry - d_delete will try to mark the dentry negative if
405 * possible, giving a successful _negative_ lookup, while d_drop will
406 * just make the cache lookup fail.
407 *
408 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
409 * reason (NFS timeouts or autofs deletes).
410 *
411 * __d_drop requires dentry->d_lock.
412 */
413void __d_drop(struct dentry *dentry)
414{
Linus Torvaldsdea36672011-04-24 07:58:46 -0700415 if (!d_unhashed(dentry)) {
Al Virob61625d2013-10-04 11:09:01 -0400416 struct hlist_bl_head *b;
J. Bruce Fields7632e462012-06-28 12:10:55 -0400417 /*
418 * Hashed dentries are normally on the dentry hashtable,
419 * with the exception of those newly allocated by
420 * d_obtain_alias, which are always IS_ROOT:
421 */
422 if (unlikely(IS_ROOT(dentry)))
Al Virob61625d2013-10-04 11:09:01 -0400423 b = &dentry->d_sb->s_anon;
424 else
425 b = d_hash(dentry->d_parent, dentry->d_name.hash);
426
427 hlist_bl_lock(b);
428 __hlist_bl_del(&dentry->d_hash);
429 dentry->d_hash.pprev = NULL;
430 hlist_bl_unlock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -0700431 dentry_rcuwalk_barrier(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +1100432 }
433}
434EXPORT_SYMBOL(__d_drop);
435
436void d_drop(struct dentry *dentry)
437{
Nick Piggin789680d2011-01-07 17:49:30 +1100438 spin_lock(&dentry->d_lock);
439 __d_drop(dentry);
440 spin_unlock(&dentry->d_lock);
Nick Piggin789680d2011-01-07 17:49:30 +1100441}
442EXPORT_SYMBOL(d_drop);
443
Nick Piggin77812a12011-01-07 17:49:48 +1100444/*
445 * Finish off a dentry we've decided to kill.
446 * dentry->d_lock must be held, returns with it unlocked.
447 * If ref is non-zero, then decrement the refcount too.
448 * Returns dentry requiring refcount drop, or NULL if we're done.
449 */
Linus Torvalds358eec12013-10-31 15:43:02 -0700450static struct dentry *
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000451dentry_kill(struct dentry *dentry, int unlock_on_failure)
Nick Piggin77812a12011-01-07 17:49:48 +1100452 __releases(dentry->d_lock)
453{
Nick Piggin873feea2011-01-07 17:50:06 +1100454 struct inode *inode;
Al Viro41edf272014-05-01 10:30:00 -0400455 struct dentry *parent = NULL;
456 bool can_free = true;
457
Nick Piggin873feea2011-01-07 17:50:06 +1100458 inode = dentry->d_inode;
459 if (inode && !spin_trylock(&inode->i_lock)) {
Nick Piggin77812a12011-01-07 17:49:48 +1100460relock:
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000461 if (unlock_on_failure) {
462 spin_unlock(&dentry->d_lock);
463 cpu_relax();
464 }
Nick Piggin77812a12011-01-07 17:49:48 +1100465 return dentry; /* try again with same dentry */
466 }
Al Viro41edf272014-05-01 10:30:00 -0400467 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100468 parent = dentry->d_parent;
469 if (parent && !spin_trylock(&parent->d_lock)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100470 if (inode)
471 spin_unlock(&inode->i_lock);
Nick Piggin77812a12011-01-07 17:49:48 +1100472 goto relock;
473 }
Nick Piggin31e6b012011-01-07 17:49:52 +1100474
Linus Torvalds0d984392013-09-08 13:46:52 -0700475 /*
476 * The dentry is now unrecoverably dead to the world.
477 */
478 lockref_mark_dead(&dentry->d_lockref);
479
Sage Weilf0023bc2011-10-28 10:02:42 -0700480 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700481 * inform the fs via d_prune that this dentry is about to be
482 * unhashed and destroyed.
483 */
Yan, Zheng590fb512013-08-13 15:42:02 +0800484 if ((dentry->d_flags & DCACHE_OP_PRUNE) && !d_unhashed(dentry))
Yan, Zheng61572bb2013-04-15 14:13:21 +0800485 dentry->d_op->d_prune(dentry);
486
Al Viro01b60352014-04-29 23:42:52 -0400487 if (dentry->d_flags & DCACHE_LRU_LIST) {
488 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
489 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400490 }
Nick Piggin77812a12011-01-07 17:49:48 +1100491 /* if it was on the hash then remove it */
492 __d_drop(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400493 list_del(&dentry->d_u.d_child);
494 /*
495 * Inform d_walk() that we are no longer attached to the
496 * dentry tree
497 */
498 dentry->d_flags |= DCACHE_DENTRY_KILLED;
499 if (parent)
500 spin_unlock(&parent->d_lock);
501 dentry_iput(dentry);
502 /*
503 * dentry_iput drops the locks, at which point nobody (except
504 * transient RCU lookups) can reach this dentry.
505 */
506 BUG_ON((int)dentry->d_lockref.count > 0);
507 this_cpu_dec(nr_dentry);
508 if (dentry->d_op && dentry->d_op->d_release)
509 dentry->d_op->d_release(dentry);
510
Al Viro41edf272014-05-01 10:30:00 -0400511 spin_lock(&dentry->d_lock);
512 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
513 dentry->d_flags |= DCACHE_MAY_FREE;
514 can_free = false;
515 }
516 spin_unlock(&dentry->d_lock);
517out:
518 if (likely(can_free))
519 dentry_free(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400520 return parent;
Nick Piggin77812a12011-01-07 17:49:48 +1100521}
522
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523/*
524 * This is dput
525 *
526 * This is complicated by the fact that we do not want to put
527 * dentries that are no longer on any hash chain on the unused
528 * list: we'd much rather just get rid of them immediately.
529 *
530 * However, that implies that we have to traverse the dentry
531 * tree upwards to the parents which might _also_ now be
532 * scheduled for deletion (it may have been only waiting for
533 * its last child to go away).
534 *
535 * This tail recursion is done by hand as we don't want to depend
536 * on the compiler to always get this right (gcc generally doesn't).
537 * Real recursion would eat up our stack space.
538 */
539
540/*
541 * dput - release a dentry
542 * @dentry: dentry to release
543 *
544 * Release a dentry. This will drop the usage count and if appropriate
545 * call the dentry unlink method as well as removing it from the queues and
546 * releasing its resources. If the parent dentries were scheduled for release
547 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549void dput(struct dentry *dentry)
550{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700551 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 return;
553
554repeat:
Waiman Long98474232013-08-28 18:24:59 -0700555 if (lockref_put_or_lock(&dentry->d_lockref))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700558 /* Unreachable? Get rid of it */
559 if (unlikely(d_unhashed(dentry)))
560 goto kill_it;
561
562 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100564 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 }
Nick Piggin265ac902010-10-10 05:36:24 -0400566
Linus Torvalds358eec12013-10-31 15:43:02 -0700567 if (!(dentry->d_flags & DCACHE_REFERENCED))
568 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400569 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400570
Waiman Long98474232013-08-28 18:24:59 -0700571 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100572 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 return;
574
Miklos Szeredid52b9082007-05-08 00:23:46 -0700575kill_it:
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000576 dentry = dentry_kill(dentry, 1);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700577 if (dentry)
578 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700580EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581
582/**
583 * d_invalidate - invalidate a dentry
584 * @dentry: dentry to invalidate
585 *
586 * Try to invalidate the dentry if it turns out to be
587 * possible. If there are other dentries that can be
588 * reached through this one we can't delete it and we
589 * return -EBUSY. On success we return 0.
590 *
591 * no dcache lock.
592 */
593
594int d_invalidate(struct dentry * dentry)
595{
596 /*
597 * If it's already been dropped, return OK.
598 */
Nick Pigginda502952011-01-07 17:49:33 +1100599 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 if (d_unhashed(dentry)) {
Nick Pigginda502952011-01-07 17:49:33 +1100601 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 return 0;
603 }
604 /*
605 * Check whether to do a partial shrink_dcache
606 * to get rid of unused child entries.
607 */
608 if (!list_empty(&dentry->d_subdirs)) {
Nick Pigginda502952011-01-07 17:49:33 +1100609 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 shrink_dcache_parent(dentry);
Nick Pigginda502952011-01-07 17:49:33 +1100611 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 }
613
614 /*
615 * Somebody else still using it?
616 *
617 * If it's a directory, we can't drop it
618 * for fear of somebody re-populating it
619 * with children (even though dropping it
620 * would make it unreachable from the root,
621 * we might still populate it if it was a
622 * working directory or similar).
Al Viro50e69632011-11-07 16:39:57 +0000623 * We also need to leave mountpoints alone,
624 * directory or not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 */
Waiman Long98474232013-08-28 18:24:59 -0700626 if (dentry->d_lockref.count > 1 && dentry->d_inode) {
Al Viro50e69632011-11-07 16:39:57 +0000627 if (S_ISDIR(dentry->d_inode->i_mode) || d_mountpoint(dentry)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 return -EBUSY;
630 }
631 }
632
633 __d_drop(dentry);
634 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 return 0;
636}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700637EXPORT_SYMBOL(d_invalidate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100639/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100640static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641{
Waiman Long98474232013-08-28 18:24:59 -0700642 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643}
644
Nick Piggindc0474b2011-01-07 17:49:43 +1100645static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100646{
Waiman Long98474232013-08-28 18:24:59 -0700647 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100648}
649
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100650struct dentry *dget_parent(struct dentry *dentry)
651{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700652 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100653 struct dentry *ret;
654
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700655 /*
656 * Do optimistic parent lookup without any
657 * locking.
658 */
659 rcu_read_lock();
660 ret = ACCESS_ONCE(dentry->d_parent);
661 gotref = lockref_get_not_zero(&ret->d_lockref);
662 rcu_read_unlock();
663 if (likely(gotref)) {
664 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
665 return ret;
666 dput(ret);
667 }
668
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100669repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100670 /*
671 * Don't need rcu_dereference because we re-check it was correct under
672 * the lock.
673 */
674 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100675 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100676 spin_lock(&ret->d_lock);
677 if (unlikely(ret != dentry->d_parent)) {
678 spin_unlock(&ret->d_lock);
679 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100680 goto repeat;
681 }
Nick Piggina734eb42011-01-07 17:49:44 +1100682 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700683 BUG_ON(!ret->d_lockref.count);
684 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100685 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100686 return ret;
687}
688EXPORT_SYMBOL(dget_parent);
689
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690/**
691 * d_find_alias - grab a hashed alias of inode
692 * @inode: inode in question
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700693 * @want_discon: flag, used by d_splice_alias, to request
694 * that only a DISCONNECTED alias be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 *
696 * If inode has a hashed alias, or is a directory and has any alias,
697 * acquire the reference to alias and return it. Otherwise return NULL.
698 * Notice that if inode is a directory there can be only one alias and
699 * it can be unhashed only if it has no children, or if it is the root
700 * of a filesystem.
701 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700702 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700703 * any other hashed alias over that one unless @want_discon is set,
704 * in which case only return an IS_ROOT, DCACHE_DISCONNECTED alias.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 */
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700706static struct dentry *__d_find_alias(struct inode *inode, int want_discon)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707{
Nick Pigginda502952011-01-07 17:49:33 +1100708 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
Nick Pigginda502952011-01-07 17:49:33 +1100710again:
711 discon_alias = NULL;
Sasha Levinb67bfe02013-02-27 17:06:00 -0800712 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100713 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700715 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100716 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 discon_alias = alias;
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700718 } else if (!want_discon) {
Nick Piggindc0474b2011-01-07 17:49:43 +1100719 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100720 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 return alias;
722 }
723 }
Nick Pigginda502952011-01-07 17:49:33 +1100724 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 }
Nick Pigginda502952011-01-07 17:49:33 +1100726 if (discon_alias) {
727 alias = discon_alias;
728 spin_lock(&alias->d_lock);
729 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
730 if (IS_ROOT(alias) &&
731 (alias->d_flags & DCACHE_DISCONNECTED)) {
Nick Piggindc0474b2011-01-07 17:49:43 +1100732 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100733 spin_unlock(&alias->d_lock);
734 return alias;
735 }
736 }
737 spin_unlock(&alias->d_lock);
738 goto again;
739 }
740 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741}
742
Nick Pigginda502952011-01-07 17:49:33 +1100743struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744{
David Howells214fda12006-03-25 03:06:36 -0800745 struct dentry *de = NULL;
746
Al Virob3d9b7a2012-06-09 13:51:19 -0400747 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100748 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700749 de = __d_find_alias(inode, 0);
Nick Piggin873feea2011-01-07 17:50:06 +1100750 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800751 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 return de;
753}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700754EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
756/*
757 * Try to kill dentries associated with this inode.
758 * WARNING: you must own a reference to inode.
759 */
760void d_prune_aliases(struct inode *inode)
761{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700762 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100764 spin_lock(&inode->i_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -0800765 hlist_for_each_entry(dentry, &inode->i_dentry, d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700767 if (!dentry->d_lockref.count) {
Yan, Zheng590fb512013-08-13 15:42:02 +0800768 /*
769 * inform the fs via d_prune that this dentry
770 * is about to be unhashed and destroyed.
771 */
772 if ((dentry->d_flags & DCACHE_OP_PRUNE) &&
773 !d_unhashed(dentry))
774 dentry->d_op->d_prune(dentry);
775
Nick Piggindc0474b2011-01-07 17:49:43 +1100776 __dget_dlock(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 __d_drop(dentry);
778 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100779 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 dput(dentry);
781 goto restart;
782 }
783 spin_unlock(&dentry->d_lock);
784 }
Nick Piggin873feea2011-01-07 17:50:06 +1100785 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700787EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400789static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790{
Al Viro5c47e6d2014-04-29 16:13:18 -0400791 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700792
Miklos Szeredi60942f22014-05-02 15:38:39 -0400793 while (!list_empty(list)) {
794 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100795 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000797 * The dispose list is isolated and dentries are not accounted
798 * to the LRU here, so we can simply remove it from the list
799 * here regardless of whether it is referenced or not.
800 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400801 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000802
803 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000805 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 */
Al Viro41edf272014-05-01 10:30:00 -0400807 if ((int)dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700808 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 continue;
810 }
Nick Piggin77812a12011-01-07 17:49:48 +1100811
Al Viro64fd72e2014-05-28 09:48:44 -0400812
813 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
814 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
815 spin_unlock(&dentry->d_lock);
816 if (can_free)
817 dentry_free(dentry);
818 continue;
819 }
820
Al Viro5c47e6d2014-04-29 16:13:18 -0400821 parent = dentry_kill(dentry, 0);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400822 /*
Al Viro5c47e6d2014-04-29 16:13:18 -0400823 * If dentry_kill returns NULL, we have nothing more to do.
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400824 */
Miklos Szeredi60942f22014-05-02 15:38:39 -0400825 if (!parent)
Al Viro5c47e6d2014-04-29 16:13:18 -0400826 continue;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400827
Al Viro5c47e6d2014-04-29 16:13:18 -0400828 if (unlikely(parent == dentry)) {
829 /*
830 * trylocks have failed and d_lock has been held the
831 * whole time, so it could not have been added to any
832 * other lists. Just add it back to the shrink list.
833 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400834 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000835 spin_unlock(&dentry->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -0400836 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000837 }
Al Viro5c47e6d2014-04-29 16:13:18 -0400838 /*
839 * We need to prune ancestors too. This is necessary to prevent
840 * quadratic behavior of shrink_dcache_parent(), but is also
841 * expected to be beneficial in reducing dentry cache
842 * fragmentation.
843 */
844 dentry = parent;
845 while (dentry && !lockref_put_or_lock(&dentry->d_lockref))
846 dentry = dentry_kill(dentry, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400848}
849
Dave Chinnerf6041562013-08-28 10:18:00 +1000850static enum lru_status
851dentry_lru_isolate(struct list_head *item, spinlock_t *lru_lock, void *arg)
852{
853 struct list_head *freeable = arg;
854 struct dentry *dentry = container_of(item, struct dentry, d_lru);
855
856
857 /*
858 * we are inverting the lru lock/dentry->d_lock here,
859 * so use a trylock. If we fail to get the lock, just skip
860 * it
861 */
862 if (!spin_trylock(&dentry->d_lock))
863 return LRU_SKIP;
864
865 /*
866 * Referenced dentries are still in use. If they have active
867 * counts, just remove them from the LRU. Otherwise give them
868 * another pass through the LRU.
869 */
870 if (dentry->d_lockref.count) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400871 d_lru_isolate(dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +1000872 spin_unlock(&dentry->d_lock);
873 return LRU_REMOVED;
874 }
875
876 if (dentry->d_flags & DCACHE_REFERENCED) {
877 dentry->d_flags &= ~DCACHE_REFERENCED;
878 spin_unlock(&dentry->d_lock);
879
880 /*
881 * The list move itself will be made by the common LRU code. At
882 * this point, we've dropped the dentry->d_lock but keep the
883 * lru lock. This is safe to do, since every list movement is
884 * protected by the lru lock even if both locks are held.
885 *
886 * This is guaranteed by the fact that all LRU management
887 * functions are intermediated by the LRU API calls like
888 * list_lru_add and list_lru_del. List movement in this file
889 * only ever occur through this functions or through callbacks
890 * like this one, that are called from the LRU API.
891 *
892 * The only exceptions to this are functions like
893 * shrink_dentry_list, and code that first checks for the
894 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
895 * operating only with stack provided lists after they are
896 * properly isolated from the main list. It is thus, always a
897 * local access.
898 */
899 return LRU_ROTATE;
900 }
901
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400902 d_lru_shrink_move(dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +1000903 spin_unlock(&dentry->d_lock);
904
905 return LRU_REMOVED;
906}
907
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400908/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000909 * prune_dcache_sb - shrink the dcache
910 * @sb: superblock
Dave Chinnerf6041562013-08-28 10:18:00 +1000911 * @nr_to_scan : number of entries to try to free
Dave Chinner9b17c622013-08-28 10:18:05 +1000912 * @nid: which node to scan for freeable entities
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400913 *
Dave Chinnerf6041562013-08-28 10:18:00 +1000914 * Attempt to shrink the superblock dcache LRU by @nr_to_scan entries. This is
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000915 * done when we need more memory an called from the superblock shrinker
916 * function.
917 *
918 * This function may fail to free any resources if all the dentries are in
919 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400920 */
Dave Chinner9b17c622013-08-28 10:18:05 +1000921long prune_dcache_sb(struct super_block *sb, unsigned long nr_to_scan,
922 int nid)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400923{
Dave Chinnerf6041562013-08-28 10:18:00 +1000924 LIST_HEAD(dispose);
925 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400926
Dave Chinner9b17c622013-08-28 10:18:05 +1000927 freed = list_lru_walk_node(&sb->s_dentry_lru, nid, dentry_lru_isolate,
928 &dispose, &nr_to_scan);
Dave Chinnerf6041562013-08-28 10:18:00 +1000929 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +1000930 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931}
932
Glauber Costa4e717f52013-08-28 10:18:03 +1000933static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
934 spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000935{
Glauber Costa4e717f52013-08-28 10:18:03 +1000936 struct list_head *freeable = arg;
937 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000938
Glauber Costa4e717f52013-08-28 10:18:03 +1000939 /*
940 * we are inverting the lru lock/dentry->d_lock here,
941 * so use a trylock. If we fail to get the lock, just skip
942 * it
943 */
944 if (!spin_trylock(&dentry->d_lock))
945 return LRU_SKIP;
946
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400947 d_lru_shrink_move(dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +1000948 spin_unlock(&dentry->d_lock);
949
950 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000951}
952
Glauber Costa4e717f52013-08-28 10:18:03 +1000953
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700954/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 * shrink_dcache_sb - shrink dcache for a superblock
956 * @sb: superblock
957 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400958 * Shrink the dcache for the specified super block. This is used to free
959 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400961void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962{
Glauber Costa4e717f52013-08-28 10:18:03 +1000963 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400964
Glauber Costa4e717f52013-08-28 10:18:03 +1000965 do {
966 LIST_HEAD(dispose);
967
968 freed = list_lru_walk(&sb->s_dentry_lru,
969 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
970
971 this_cpu_sub(nr_dentry_unused, freed);
972 shrink_dentry_list(&dispose);
973 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700975EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +0200978 * enum d_walk_ret - action to talke during tree walk
979 * @D_WALK_CONTINUE: contrinue walk
980 * @D_WALK_QUIT: quit walk
981 * @D_WALK_NORETRY: quit when retry is needed
982 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +0200984enum d_walk_ret {
985 D_WALK_CONTINUE,
986 D_WALK_QUIT,
987 D_WALK_NORETRY,
988 D_WALK_SKIP,
989};
990
991/**
992 * d_walk - walk the dentry tree
993 * @parent: start of walk
994 * @data: data passed to @enter() and @finish()
995 * @enter: callback when first entering the dentry
996 * @finish: callback when successfully finished the walk
997 *
998 * The @enter() and @finish() callbacks are called with d_lock held.
999 */
1000static void d_walk(struct dentry *parent, void *data,
1001 enum d_walk_ret (*enter)(void *, struct dentry *),
1002 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003{
Nick Piggin949854d2011-01-07 17:49:37 +11001004 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001006 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001007 enum d_walk_ret ret;
1008 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001009
Nick Piggin58db63d2011-01-07 17:49:39 +11001010again:
Al Viro48f5ec22013-09-09 15:22:25 -04001011 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001012 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001013 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001014
1015 ret = enter(data, this_parent);
1016 switch (ret) {
1017 case D_WALK_CONTINUE:
1018 break;
1019 case D_WALK_QUIT:
1020 case D_WALK_SKIP:
1021 goto out_unlock;
1022 case D_WALK_NORETRY:
1023 retry = false;
1024 break;
1025 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026repeat:
1027 next = this_parent->d_subdirs.next;
1028resume:
1029 while (next != &this_parent->d_subdirs) {
1030 struct list_head *tmp = next;
Eric Dumazet5160ee62006-01-08 01:03:32 -08001031 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001033
1034 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001035
1036 ret = enter(data, dentry);
1037 switch (ret) {
1038 case D_WALK_CONTINUE:
1039 break;
1040 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001041 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001042 goto out_unlock;
1043 case D_WALK_NORETRY:
1044 retry = false;
1045 break;
1046 case D_WALK_SKIP:
1047 spin_unlock(&dentry->d_lock);
1048 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001049 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001050
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001052 spin_unlock(&this_parent->d_lock);
1053 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001055 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 goto repeat;
1057 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001058 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 }
1060 /*
1061 * All done at this level ... ascend and resume the search.
1062 */
1063 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001064 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001065 this_parent = child->d_parent;
1066
1067 rcu_read_lock();
1068 spin_unlock(&child->d_lock);
1069 spin_lock(&this_parent->d_lock);
1070
1071 /*
1072 * might go back up the wrong parent if we have had a rename
1073 * or deletion
1074 */
1075 if (this_parent != child->d_parent ||
1076 (child->d_flags & DCACHE_DENTRY_KILLED) ||
1077 need_seqretry(&rename_lock, seq)) {
1078 spin_unlock(&this_parent->d_lock);
1079 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11001080 goto rename_retry;
Al Viro31dec132013-10-25 17:04:27 -04001081 }
1082 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11001083 next = child->d_u.d_child.next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084 goto resume;
1085 }
Al Viro48f5ec22013-09-09 15:22:25 -04001086 if (need_seqretry(&rename_lock, seq)) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001087 spin_unlock(&this_parent->d_lock);
1088 goto rename_retry;
1089 }
1090 if (finish)
1091 finish(data);
1092
1093out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001094 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001095 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001096 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001097
1098rename_retry:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001099 if (!retry)
1100 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001101 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001102 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001104
1105/*
1106 * Search for at least 1 mount point in the dentry's subdirs.
1107 * We descend to the next level whenever the d_subdirs
1108 * list is non-empty and continue searching.
1109 */
1110
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001111static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1112{
1113 int *ret = data;
1114 if (d_mountpoint(dentry)) {
1115 *ret = 1;
1116 return D_WALK_QUIT;
1117 }
1118 return D_WALK_CONTINUE;
1119}
1120
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001121/**
1122 * have_submounts - check for mounts over a dentry
1123 * @parent: dentry to check.
1124 *
1125 * Return true if the parent or its subdirectories contain
1126 * a mount point
1127 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001128int have_submounts(struct dentry *parent)
1129{
1130 int ret = 0;
1131
1132 d_walk(parent, &ret, check_mount, NULL);
1133
1134 return ret;
1135}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001136EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137
1138/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001139 * Called by mount code to set a mountpoint and check if the mountpoint is
1140 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1141 * subtree can become unreachable).
1142 *
1143 * Only one of check_submounts_and_drop() and d_set_mounted() must succeed. For
1144 * this reason take rename_lock and d_lock on dentry and ancestors.
1145 */
1146int d_set_mounted(struct dentry *dentry)
1147{
1148 struct dentry *p;
1149 int ret = -ENOENT;
1150 write_seqlock(&rename_lock);
1151 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
1152 /* Need exclusion wrt. check_submounts_and_drop() */
1153 spin_lock(&p->d_lock);
1154 if (unlikely(d_unhashed(p))) {
1155 spin_unlock(&p->d_lock);
1156 goto out;
1157 }
1158 spin_unlock(&p->d_lock);
1159 }
1160 spin_lock(&dentry->d_lock);
1161 if (!d_unlinked(dentry)) {
1162 dentry->d_flags |= DCACHE_MOUNTED;
1163 ret = 0;
1164 }
1165 spin_unlock(&dentry->d_lock);
1166out:
1167 write_sequnlock(&rename_lock);
1168 return ret;
1169}
1170
1171/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001172 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 * and move any unused dentries to the end of the unused
1174 * list for prune_dcache(). We descend to the next level
1175 * whenever the d_subdirs list is non-empty and continue
1176 * searching.
1177 *
1178 * It returns zero iff there are no unused children,
1179 * otherwise it returns the number of children moved to
1180 * the end of the unused list. This may not be the total
1181 * number of unused children, because select_parent can
1182 * drop the lock and return early due to latency
1183 * constraints.
1184 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001185
1186struct select_data {
1187 struct dentry *start;
1188 struct list_head dispose;
1189 int found;
1190};
1191
1192static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001194 struct select_data *data = _data;
1195 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001197 if (data->start == dentry)
1198 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199
Al Virofe915222014-05-03 00:02:25 -04001200 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001201 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001202 } else {
1203 if (dentry->d_flags & DCACHE_LRU_LIST)
1204 d_lru_del(dentry);
1205 if (!dentry->d_lockref.count) {
1206 d_shrink_add(dentry, &data->dispose);
1207 data->found++;
1208 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 }
1210 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001211 * We can return to the caller if we have found some (this
1212 * ensures forward progress). We'll be coming back to find
1213 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214 */
Al Virofe915222014-05-03 00:02:25 -04001215 if (!list_empty(&data->dispose))
1216 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001218 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219}
1220
1221/**
1222 * shrink_dcache_parent - prune dcache
1223 * @parent: parent of entries to prune
1224 *
1225 * Prune the dcache to remove unused children of the parent dentry.
1226 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001227void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001229 for (;;) {
1230 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001232 INIT_LIST_HEAD(&data.dispose);
1233 data.start = parent;
1234 data.found = 0;
1235
1236 d_walk(parent, &data, select_collect, NULL);
1237 if (!data.found)
1238 break;
1239
1240 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001241 cond_resched();
1242 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001244EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245
Al Viro9c8c10e2014-05-02 20:36:10 -04001246static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001247{
Al Viro9c8c10e2014-05-02 20:36:10 -04001248 /* it has busy descendents; complain about those instead */
1249 if (!list_empty(&dentry->d_subdirs))
1250 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001251
Al Viro9c8c10e2014-05-02 20:36:10 -04001252 /* root with refcount 1 is fine */
1253 if (dentry == _data && dentry->d_lockref.count == 1)
1254 return D_WALK_CONTINUE;
1255
1256 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1257 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001258 dentry,
1259 dentry->d_inode ?
1260 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001261 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001262 dentry->d_lockref.count,
1263 dentry->d_sb->s_type->name,
1264 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001265 WARN_ON(1);
1266 return D_WALK_CONTINUE;
1267}
1268
1269static void do_one_tree(struct dentry *dentry)
1270{
1271 shrink_dcache_parent(dentry);
1272 d_walk(dentry, dentry, umount_check, NULL);
1273 d_drop(dentry);
1274 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001275}
1276
1277/*
1278 * destroy the dentries attached to a superblock on unmounting
1279 */
1280void shrink_dcache_for_umount(struct super_block *sb)
1281{
1282 struct dentry *dentry;
1283
Al Viro9c8c10e2014-05-02 20:36:10 -04001284 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001285
1286 dentry = sb->s_root;
1287 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001288 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001289
1290 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001291 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1292 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001293 }
1294}
1295
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001296static enum d_walk_ret check_and_collect(void *_data, struct dentry *dentry)
1297{
1298 struct select_data *data = _data;
1299
1300 if (d_mountpoint(dentry)) {
1301 data->found = -EBUSY;
1302 return D_WALK_QUIT;
1303 }
1304
1305 return select_collect(_data, dentry);
1306}
1307
1308static void check_and_drop(void *_data)
1309{
1310 struct select_data *data = _data;
1311
1312 if (d_mountpoint(data->start))
1313 data->found = -EBUSY;
1314 if (!data->found)
1315 __d_drop(data->start);
1316}
1317
1318/**
1319 * check_submounts_and_drop - prune dcache, check for submounts and drop
1320 *
1321 * All done as a single atomic operation relative to has_unlinked_ancestor().
1322 * Returns 0 if successfully unhashed @parent. If there were submounts then
1323 * return -EBUSY.
1324 *
1325 * @dentry: dentry to prune and drop
1326 */
1327int check_submounts_and_drop(struct dentry *dentry)
1328{
1329 int ret = 0;
1330
1331 /* Negative dentries can be dropped without further checks */
1332 if (!dentry->d_inode) {
1333 d_drop(dentry);
1334 goto out;
1335 }
1336
1337 for (;;) {
1338 struct select_data data;
1339
1340 INIT_LIST_HEAD(&data.dispose);
1341 data.start = dentry;
1342 data.found = 0;
1343
1344 d_walk(dentry, &data, check_and_collect, check_and_drop);
1345 ret = data.found;
1346
1347 if (!list_empty(&data.dispose))
1348 shrink_dentry_list(&data.dispose);
1349
1350 if (ret <= 0)
1351 break;
1352
1353 cond_resched();
1354 }
1355
1356out:
1357 return ret;
1358}
1359EXPORT_SYMBOL(check_submounts_and_drop);
1360
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361/**
Al Viroa4464db2011-07-07 15:03:58 -04001362 * __d_alloc - allocate a dcache entry
1363 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 * @name: qstr of the name
1365 *
1366 * Allocates a dentry. It returns %NULL if there is insufficient memory
1367 * available. On a success the dentry is returned. The name passed in is
1368 * copied and the copy passed in may be reused after this call.
1369 */
1370
Al Viroa4464db2011-07-07 15:03:58 -04001371struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372{
1373 struct dentry *dentry;
1374 char *dname;
1375
Mel Gormane12ba742007-10-16 01:25:52 -07001376 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 if (!dentry)
1378 return NULL;
1379
Linus Torvalds6326c712012-05-21 16:14:04 -07001380 /*
1381 * We guarantee that the inline name is always NUL-terminated.
1382 * This way the memcpy() done by the name switching in rename
1383 * will still always have a NUL at the end, even if we might
1384 * be overwriting an internal NUL character
1385 */
1386 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 if (name->len > DNAME_INLINE_LEN-1) {
1388 dname = kmalloc(name->len + 1, GFP_KERNEL);
1389 if (!dname) {
1390 kmem_cache_free(dentry_cache, dentry);
1391 return NULL;
1392 }
1393 } else {
1394 dname = dentry->d_iname;
1395 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396
1397 dentry->d_name.len = name->len;
1398 dentry->d_name.hash = name->hash;
1399 memcpy(dname, name->name, name->len);
1400 dname[name->len] = 0;
1401
Linus Torvalds6326c712012-05-21 16:14:04 -07001402 /* Make sure we always see the terminating NUL character */
1403 smp_wmb();
1404 dentry->d_name.name = dname;
1405
Waiman Long98474232013-08-28 18:24:59 -07001406 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001407 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001409 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001411 dentry->d_parent = dentry;
1412 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 dentry->d_op = NULL;
1414 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001415 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 INIT_LIST_HEAD(&dentry->d_lru);
1417 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Virob3d9b7a2012-06-09 13:51:19 -04001418 INIT_HLIST_NODE(&dentry->d_alias);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001419 INIT_LIST_HEAD(&dentry->d_u.d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001420 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421
Nick Piggin3e880fb2011-01-07 17:49:19 +11001422 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001423
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 return dentry;
1425}
Al Viroa4464db2011-07-07 15:03:58 -04001426
1427/**
1428 * d_alloc - allocate a dcache entry
1429 * @parent: parent of entry to allocate
1430 * @name: qstr of the name
1431 *
1432 * Allocates a dentry. It returns %NULL if there is insufficient memory
1433 * available. On a success the dentry is returned. The name passed in is
1434 * copied and the copy passed in may be reused after this call.
1435 */
1436struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1437{
1438 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1439 if (!dentry)
1440 return NULL;
1441
1442 spin_lock(&parent->d_lock);
1443 /*
1444 * don't need child lock because it is not subject
1445 * to concurrency here
1446 */
1447 __dget_dlock(parent);
1448 dentry->d_parent = parent;
1449 list_add(&dentry->d_u.d_child, &parent->d_subdirs);
1450 spin_unlock(&parent->d_lock);
1451
1452 return dentry;
1453}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001454EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001456/**
1457 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1458 * @sb: the superblock
1459 * @name: qstr of the name
1460 *
1461 * For a filesystem that just pins its dentries in memory and never
1462 * performs lookups at all, return an unhashed IS_ROOT dentry.
1463 */
Nick Piggin4b936882011-01-07 17:50:07 +11001464struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1465{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001466 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001467}
1468EXPORT_SYMBOL(d_alloc_pseudo);
1469
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1471{
1472 struct qstr q;
1473
1474 q.name = name;
1475 q.len = strlen(name);
1476 q.hash = full_name_hash(q.name, q.len);
1477 return d_alloc(parent, &q);
1478}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001479EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480
Nick Pigginfb045ad2011-01-07 17:49:55 +11001481void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1482{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001483 WARN_ON_ONCE(dentry->d_op);
1484 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001485 DCACHE_OP_COMPARE |
1486 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001487 DCACHE_OP_WEAK_REVALIDATE |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001488 DCACHE_OP_DELETE ));
1489 dentry->d_op = op;
1490 if (!op)
1491 return;
1492 if (op->d_hash)
1493 dentry->d_flags |= DCACHE_OP_HASH;
1494 if (op->d_compare)
1495 dentry->d_flags |= DCACHE_OP_COMPARE;
1496 if (op->d_revalidate)
1497 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001498 if (op->d_weak_revalidate)
1499 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001500 if (op->d_delete)
1501 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001502 if (op->d_prune)
1503 dentry->d_flags |= DCACHE_OP_PRUNE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001504
1505}
1506EXPORT_SYMBOL(d_set_d_op);
1507
David Howellsb18825a2013-09-12 19:22:53 +01001508static unsigned d_flags_for_inode(struct inode *inode)
1509{
1510 unsigned add_flags = DCACHE_FILE_TYPE;
1511
1512 if (!inode)
1513 return DCACHE_MISS_TYPE;
1514
1515 if (S_ISDIR(inode->i_mode)) {
1516 add_flags = DCACHE_DIRECTORY_TYPE;
1517 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1518 if (unlikely(!inode->i_op->lookup))
1519 add_flags = DCACHE_AUTODIR_TYPE;
1520 else
1521 inode->i_opflags |= IOP_LOOKUP;
1522 }
1523 } else if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
1524 if (unlikely(inode->i_op->follow_link))
1525 add_flags = DCACHE_SYMLINK_TYPE;
1526 else
1527 inode->i_opflags |= IOP_NOFOLLOW;
1528 }
1529
1530 if (unlikely(IS_AUTOMOUNT(inode)))
1531 add_flags |= DCACHE_NEED_AUTOMOUNT;
1532 return add_flags;
1533}
1534
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001535static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1536{
David Howellsb18825a2013-09-12 19:22:53 +01001537 unsigned add_flags = d_flags_for_inode(inode);
1538
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001539 spin_lock(&dentry->d_lock);
Al Viro22213312014-04-19 12:30:58 -04001540 __d_set_type(dentry, add_flags);
David Howellsb18825a2013-09-12 19:22:53 +01001541 if (inode)
Al Virob3d9b7a2012-06-09 13:51:19 -04001542 hlist_add_head(&dentry->d_alias, &inode->i_dentry);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001543 dentry->d_inode = inode;
Nick Piggin31e6b012011-01-07 17:49:52 +11001544 dentry_rcuwalk_barrier(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001545 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001546 fsnotify_d_instantiate(dentry, inode);
1547}
1548
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549/**
1550 * d_instantiate - fill in inode information for a dentry
1551 * @entry: dentry to complete
1552 * @inode: inode to attach to this dentry
1553 *
1554 * Fill in inode information in the entry.
1555 *
1556 * This turns negative dentries into productive full members
1557 * of society.
1558 *
1559 * NOTE! This assumes that the inode count has been incremented
1560 * (or otherwise set) by the caller to indicate that it is now
1561 * in use by the dcache.
1562 */
1563
1564void d_instantiate(struct dentry *entry, struct inode * inode)
1565{
Al Virob3d9b7a2012-06-09 13:51:19 -04001566 BUG_ON(!hlist_unhashed(&entry->d_alias));
Nick Piggin873feea2011-01-07 17:50:06 +11001567 if (inode)
1568 spin_lock(&inode->i_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001569 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001570 if (inode)
1571 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 security_d_instantiate(entry, inode);
1573}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001574EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575
1576/**
1577 * d_instantiate_unique - instantiate a non-aliased dentry
1578 * @entry: dentry to instantiate
1579 * @inode: inode to attach to this dentry
1580 *
1581 * Fill in inode information in the entry. On success, it returns NULL.
1582 * If an unhashed alias of "entry" already exists, then we return the
Oleg Drokine866cfa2006-01-09 20:52:51 -08001583 * aliased dentry instead and drop one reference to inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 *
1585 * Note that in order to avoid conflicts with rename() etc, the caller
1586 * had better be holding the parent directory semaphore.
Oleg Drokine866cfa2006-01-09 20:52:51 -08001587 *
1588 * This also assumes that the inode count has been incremented
1589 * (or otherwise set) by the caller to indicate that it is now
1590 * in use by the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 */
David Howells770bfad2006-08-22 20:06:07 -04001592static struct dentry *__d_instantiate_unique(struct dentry *entry,
1593 struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594{
1595 struct dentry *alias;
1596 int len = entry->d_name.len;
1597 const char *name = entry->d_name.name;
1598 unsigned int hash = entry->d_name.hash;
1599
David Howells770bfad2006-08-22 20:06:07 -04001600 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001601 __d_instantiate(entry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001602 return NULL;
1603 }
1604
Sasha Levinb67bfe02013-02-27 17:06:00 -08001605 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Piggin9abca362011-01-07 17:49:36 +11001606 /*
1607 * Don't need alias->d_lock here, because aliases with
1608 * d_parent == entry->d_parent are not subject to name or
1609 * parent changes, because the parent inode i_mutex is held.
1610 */
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001611 if (alias->d_name.hash != hash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 continue;
1613 if (alias->d_parent != entry->d_parent)
1614 continue;
Linus Torvaldsee983e82012-05-10 12:37:10 -07001615 if (alias->d_name.len != len)
1616 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001617 if (dentry_cmp(alias, name, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 continue;
Nick Piggindc0474b2011-01-07 17:49:43 +11001619 __dget(alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 return alias;
1621 }
David Howells770bfad2006-08-22 20:06:07 -04001622
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001623 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 return NULL;
1625}
David Howells770bfad2006-08-22 20:06:07 -04001626
1627struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1628{
1629 struct dentry *result;
1630
Al Virob3d9b7a2012-06-09 13:51:19 -04001631 BUG_ON(!hlist_unhashed(&entry->d_alias));
David Howells770bfad2006-08-22 20:06:07 -04001632
Nick Piggin873feea2011-01-07 17:50:06 +11001633 if (inode)
1634 spin_lock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001635 result = __d_instantiate_unique(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001636 if (inode)
1637 spin_unlock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001638
1639 if (!result) {
1640 security_d_instantiate(entry, inode);
1641 return NULL;
1642 }
1643
1644 BUG_ON(!d_unhashed(result));
1645 iput(inode);
1646 return result;
1647}
1648
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649EXPORT_SYMBOL(d_instantiate_unique);
1650
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001651/**
1652 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1653 * @entry: dentry to complete
1654 * @inode: inode to attach to this dentry
1655 *
1656 * Fill in inode information in the entry. If a directory alias is found, then
1657 * return an error (and drop inode). Together with d_materialise_unique() this
1658 * guarantees that a directory inode may never have more than one alias.
1659 */
1660int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1661{
1662 BUG_ON(!hlist_unhashed(&entry->d_alias));
1663
1664 spin_lock(&inode->i_lock);
1665 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1666 spin_unlock(&inode->i_lock);
1667 iput(inode);
1668 return -EBUSY;
1669 }
1670 __d_instantiate(entry, inode);
1671 spin_unlock(&inode->i_lock);
1672 security_d_instantiate(entry, inode);
1673
1674 return 0;
1675}
1676EXPORT_SYMBOL(d_instantiate_no_diralias);
1677
Al Viroadc0e912012-01-08 16:49:21 -05001678struct dentry *d_make_root(struct inode *root_inode)
1679{
1680 struct dentry *res = NULL;
1681
1682 if (root_inode) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07001683 static const struct qstr name = QSTR_INIT("/", 1);
Al Viroadc0e912012-01-08 16:49:21 -05001684
1685 res = __d_alloc(root_inode->i_sb, &name);
1686 if (res)
1687 d_instantiate(res, root_inode);
1688 else
1689 iput(root_inode);
1690 }
1691 return res;
1692}
1693EXPORT_SYMBOL(d_make_root);
1694
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001695static struct dentry * __d_find_any_alias(struct inode *inode)
1696{
1697 struct dentry *alias;
1698
Al Virob3d9b7a2012-06-09 13:51:19 -04001699 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001700 return NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001701 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001702 __dget(alias);
1703 return alias;
1704}
1705
Sage Weil46f72b32012-01-10 09:04:37 -08001706/**
1707 * d_find_any_alias - find any alias for a given inode
1708 * @inode: inode to find an alias for
1709 *
1710 * If any aliases exist for the given inode, take and return a
1711 * reference for one of them. If no aliases exist, return %NULL.
1712 */
1713struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001714{
1715 struct dentry *de;
1716
1717 spin_lock(&inode->i_lock);
1718 de = __d_find_any_alias(inode);
1719 spin_unlock(&inode->i_lock);
1720 return de;
1721}
Sage Weil46f72b32012-01-10 09:04:37 -08001722EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001723
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724/**
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001725 * d_obtain_alias - find or allocate a dentry for a given inode
1726 * @inode: inode to allocate the dentry for
1727 *
1728 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1729 * similar open by handle operations. The returned dentry may be anonymous,
1730 * or may have a full name (if the inode was already in the cache).
1731 *
1732 * When called on a directory inode, we must ensure that the inode only ever
1733 * has one dentry. If a dentry is found, that is returned instead of
1734 * allocating a new one.
1735 *
1736 * On successful return, the reference to the inode has been transferred
Christoph Hellwig44003722008-08-11 15:49:04 +02001737 * to the dentry. In case of an error the reference on the inode is released.
1738 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1739 * be passed in and will be the error will be propagate to the return value,
1740 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001741 */
1742struct dentry *d_obtain_alias(struct inode *inode)
1743{
NeilBrownb911a6b2012-11-08 16:09:37 -08001744 static const struct qstr anonstring = QSTR_INIT("/", 1);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001745 struct dentry *tmp;
1746 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001747 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001748
1749 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001750 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001751 if (IS_ERR(inode))
1752 return ERR_CAST(inode);
1753
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001754 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001755 if (res)
1756 goto out_iput;
1757
Al Viroa4464db2011-07-07 15:03:58 -04001758 tmp = __d_alloc(inode->i_sb, &anonstring);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001759 if (!tmp) {
1760 res = ERR_PTR(-ENOMEM);
1761 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001762 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001763
Nick Piggin873feea2011-01-07 17:50:06 +11001764 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001765 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001766 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001767 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001768 dput(tmp);
1769 goto out_iput;
1770 }
1771
1772 /* attach a disconnected dentry */
David Howellsb18825a2013-09-12 19:22:53 +01001773 add_flags = d_flags_for_inode(inode) | DCACHE_DISCONNECTED;
1774
Christoph Hellwig9308a612008-08-11 15:49:12 +02001775 spin_lock(&tmp->d_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001776 tmp->d_inode = inode;
David Howellsb18825a2013-09-12 19:22:53 +01001777 tmp->d_flags |= add_flags;
Al Virob3d9b7a2012-06-09 13:51:19 -04001778 hlist_add_head(&tmp->d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001779 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001780 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001781 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001782 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001783 spin_unlock(&inode->i_lock);
Josef Bacik24ff6662010-11-18 20:52:55 -05001784 security_d_instantiate(tmp, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001785
Christoph Hellwig9308a612008-08-11 15:49:12 +02001786 return tmp;
1787
1788 out_iput:
Josef Bacik24ff6662010-11-18 20:52:55 -05001789 if (res && !IS_ERR(res))
1790 security_d_instantiate(res, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001791 iput(inode);
1792 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001793}
Benny Halevyadc48722009-02-27 14:02:59 -08001794EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795
1796/**
1797 * d_splice_alias - splice a disconnected dentry into the tree if one exists
1798 * @inode: the inode which may have a disconnected dentry
1799 * @dentry: a negative dentry which we want to point to the inode.
1800 *
1801 * If inode is a directory and has a 'disconnected' dentry (i.e. IS_ROOT and
1802 * DCACHE_DISCONNECTED), then d_move that in place of the given dentry
1803 * and return it, else simply d_add the inode to the dentry and return NULL.
1804 *
1805 * This is needed in the lookup routine of any filesystem that is exportable
1806 * (via knfsd) so that we can build dcache paths to directories effectively.
1807 *
1808 * If a dentry was found and moved, then it is returned. Otherwise NULL
1809 * is returned. This matches the expected return value of ->lookup.
1810 *
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001811 * Cluster filesystems may call this function with a negative, hashed dentry.
1812 * In that case, we know that the inode will be a regular file, and also this
1813 * will only occur during atomic_open. So we need to check for the dentry
1814 * being already hashed only in the final case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 */
1816struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
1817{
1818 struct dentry *new = NULL;
1819
Al Viroa9049372011-07-08 21:20:11 -04001820 if (IS_ERR(inode))
1821 return ERR_CAST(inode);
1822
NeilBrown21c0d8f2006-10-04 02:16:16 -07001823 if (inode && S_ISDIR(inode->i_mode)) {
Nick Piggin873feea2011-01-07 17:50:06 +11001824 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001825 new = __d_find_alias(inode, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 if (new) {
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001827 BUG_ON(!(new->d_flags & DCACHE_DISCONNECTED));
Nick Piggin873feea2011-01-07 17:50:06 +11001828 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 security_d_instantiate(new, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 d_move(new, dentry);
1831 iput(inode);
1832 } else {
Nick Piggin873feea2011-01-07 17:50:06 +11001833 /* already taking inode->i_lock, so d_add() by hand */
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001834 __d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001835 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 security_d_instantiate(dentry, inode);
1837 d_rehash(dentry);
1838 }
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001839 } else {
1840 d_instantiate(dentry, inode);
1841 if (d_unhashed(dentry))
1842 d_rehash(dentry);
1843 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 return new;
1845}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001846EXPORT_SYMBOL(d_splice_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847
Barry Naujok94035402008-05-21 16:50:46 +10001848/**
1849 * d_add_ci - lookup or allocate new dentry with case-exact name
1850 * @inode: the inode case-insensitive lookup has found
1851 * @dentry: the negative dentry that was passed to the parent's lookup func
1852 * @name: the case-exact name to be associated with the returned dentry
1853 *
1854 * This is to avoid filling the dcache with case-insensitive names to the
1855 * same inode, only the actual correct case is stored in the dcache for
1856 * case-insensitive filesystems.
1857 *
1858 * For a case-insensitive lookup match and if the the case-exact dentry
1859 * already exists in in the dcache, use it and return it.
1860 *
1861 * If no entry exists with the exact case name, allocate new dentry with
1862 * the exact case, and return the spliced entry.
1863 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001864struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001865 struct qstr *name)
1866{
Barry Naujok94035402008-05-21 16:50:46 +10001867 struct dentry *found;
1868 struct dentry *new;
1869
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001870 /*
1871 * First check if a dentry matching the name already exists,
1872 * if not go ahead and create it now.
1873 */
Barry Naujok94035402008-05-21 16:50:46 +10001874 found = d_hash_and_lookup(dentry->d_parent, name);
Al Viro4f522a22013-02-11 23:20:37 -05001875 if (unlikely(IS_ERR(found)))
1876 goto err_out;
Barry Naujok94035402008-05-21 16:50:46 +10001877 if (!found) {
1878 new = d_alloc(dentry->d_parent, name);
1879 if (!new) {
Al Viro4f522a22013-02-11 23:20:37 -05001880 found = ERR_PTR(-ENOMEM);
Barry Naujok94035402008-05-21 16:50:46 +10001881 goto err_out;
1882 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001883
Barry Naujok94035402008-05-21 16:50:46 +10001884 found = d_splice_alias(inode, new);
1885 if (found) {
1886 dput(new);
1887 return found;
1888 }
1889 return new;
1890 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001891
1892 /*
1893 * If a matching dentry exists, and it's not negative use it.
1894 *
1895 * Decrement the reference count to balance the iget() done
1896 * earlier on.
1897 */
Barry Naujok94035402008-05-21 16:50:46 +10001898 if (found->d_inode) {
1899 if (unlikely(found->d_inode != inode)) {
1900 /* This can't happen because bad inodes are unhashed. */
1901 BUG_ON(!is_bad_inode(inode));
1902 BUG_ON(!is_bad_inode(found->d_inode));
1903 }
Barry Naujok94035402008-05-21 16:50:46 +10001904 iput(inode);
1905 return found;
1906 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001907
Barry Naujok94035402008-05-21 16:50:46 +10001908 /*
1909 * Negative dentry: instantiate it unless the inode is a directory and
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001910 * already has a dentry.
Barry Naujok94035402008-05-21 16:50:46 +10001911 */
Al Viro4513d892011-07-17 10:52:14 -04001912 new = d_splice_alias(inode, found);
1913 if (new) {
1914 dput(found);
1915 found = new;
Barry Naujok94035402008-05-21 16:50:46 +10001916 }
Al Viro4513d892011-07-17 10:52:14 -04001917 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001918
1919err_out:
1920 iput(inode);
Al Viro4f522a22013-02-11 23:20:37 -05001921 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001922}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001923EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001925/*
1926 * Do the slow-case of the dentry name compare.
1927 *
1928 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07001929 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001930 * filesystem can rely on them, and can use the 'name' and
1931 * 'len' information without worrying about walking off the
1932 * end of memory etc.
1933 *
1934 * Thus the read_seqcount_retry() and the "duplicate" info
1935 * in arguments (the low-level filesystem should not look
1936 * at the dentry inode or name contents directly, since
1937 * rename can change them while we're in RCU mode).
1938 */
1939enum slow_d_compare {
1940 D_COMP_OK,
1941 D_COMP_NOMATCH,
1942 D_COMP_SEQRETRY,
1943};
1944
1945static noinline enum slow_d_compare slow_dentry_cmp(
1946 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001947 struct dentry *dentry,
1948 unsigned int seq,
1949 const struct qstr *name)
1950{
1951 int tlen = dentry->d_name.len;
1952 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001953
1954 if (read_seqcount_retry(&dentry->d_seq, seq)) {
1955 cpu_relax();
1956 return D_COMP_SEQRETRY;
1957 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07001958 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001959 return D_COMP_NOMATCH;
1960 return D_COMP_OK;
1961}
1962
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963/**
Nick Piggin31e6b012011-01-07 17:49:52 +11001964 * __d_lookup_rcu - search for a dentry (racy, store-free)
1965 * @parent: parent dentry
1966 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07001967 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11001968 * Returns: dentry, or NULL
1969 *
1970 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
1971 * resolution (store-free path walking) design described in
1972 * Documentation/filesystems/path-lookup.txt.
1973 *
1974 * This is not to be used outside core vfs.
1975 *
1976 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
1977 * held, and rcu_read_lock held. The returned dentry must not be stored into
1978 * without taking d_lock and checking d_seq sequence count against @seq
1979 * returned here.
1980 *
Linus Torvalds15570082013-09-02 11:38:06 -07001981 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11001982 * function.
1983 *
1984 * Alternatively, __d_lookup_rcu may be called again to look up the child of
1985 * the returned dentry, so long as its parent's seqlock is checked after the
1986 * child is looked up. Thus, an interlocking stepping of sequence lock checks
1987 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001988 *
1989 * NOTE! The caller *has* to check the resulting dentry against the sequence
1990 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11001991 */
Linus Torvalds8966be92012-03-02 14:23:30 -08001992struct dentry *__d_lookup_rcu(const struct dentry *parent,
1993 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07001994 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11001995{
Linus Torvalds26fe5752012-05-10 13:14:12 -07001996 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11001997 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07001998 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001999 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002000 struct dentry *dentry;
2001
2002 /*
2003 * Note: There is significant duplication with __d_lookup_rcu which is
2004 * required to prevent single threaded performance regressions
2005 * especially on architectures where smp_rmb (in seqcounts) are costly.
2006 * Keep the two functions in sync.
2007 */
2008
2009 /*
2010 * The hash list is protected using RCU.
2011 *
2012 * Carefully use d_seq when comparing a candidate dentry, to avoid
2013 * races with d_move().
2014 *
2015 * It is possible that concurrent renames can mess up our list
2016 * walk here and result in missing our dentry, resulting in the
2017 * false-negative result. d_lookup() protects against concurrent
2018 * renames using rename_lock seqlock.
2019 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002020 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002021 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002022 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002023 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002024
Nick Piggin31e6b012011-01-07 17:49:52 +11002025seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002026 /*
2027 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002028 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002029 *
2030 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002031 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002032 *
2033 * NOTE! We do a "raw" seqcount_begin here. That means that
2034 * we don't wait for the sequence count to stabilize if it
2035 * is in the middle of a sequence change. If we do the slow
2036 * dentry compare, we will do seqretries until it is stable,
2037 * and if we end up with a successful lookup, we actually
2038 * want to exit RCU lookup anyway.
2039 */
2040 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002041 if (dentry->d_parent != parent)
2042 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002043 if (d_unhashed(dentry))
2044 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002045
2046 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002047 if (dentry->d_name.hash != hashlen_hash(hashlen))
2048 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002049 *seqp = seq;
2050 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002051 case D_COMP_OK:
2052 return dentry;
2053 case D_COMP_NOMATCH:
2054 continue;
2055 default:
2056 goto seqretry;
2057 }
2058 }
2059
Linus Torvalds26fe5752012-05-10 13:14:12 -07002060 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002061 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002062 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002063 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002064 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002065 }
2066 return NULL;
2067}
2068
2069/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070 * d_lookup - search for a dentry
2071 * @parent: parent dentry
2072 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002073 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002075 * d_lookup searches the children of the parent dentry for the name in
2076 * question. If the dentry is found its reference count is incremented and the
2077 * dentry is returned. The caller must use dput to free the entry when it has
2078 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079 */
Al Viroda2d8452013-01-24 18:29:34 -05002080struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081{
Nick Piggin31e6b012011-01-07 17:49:52 +11002082 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002083 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084
2085 do {
2086 seq = read_seqbegin(&rename_lock);
2087 dentry = __d_lookup(parent, name);
2088 if (dentry)
2089 break;
2090 } while (read_seqretry(&rename_lock, seq));
2091 return dentry;
2092}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002093EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094
Nick Piggin31e6b012011-01-07 17:49:52 +11002095/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002096 * __d_lookup - search for a dentry (racy)
2097 * @parent: parent dentry
2098 * @name: qstr of name we wish to find
2099 * Returns: dentry, or NULL
2100 *
2101 * __d_lookup is like d_lookup, however it may (rarely) return a
2102 * false-negative result due to unrelated rename activity.
2103 *
2104 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2105 * however it must be used carefully, eg. with a following d_lookup in
2106 * the case of failure.
2107 *
2108 * __d_lookup callers must be commented.
2109 */
Al Viroa713ca22013-01-24 18:27:00 -05002110struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111{
2112 unsigned int len = name->len;
2113 unsigned int hash = name->hash;
2114 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002115 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002116 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002117 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002118 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119
Nick Pigginb04f7842010-08-18 04:37:34 +10002120 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002121 * Note: There is significant duplication with __d_lookup_rcu which is
2122 * required to prevent single threaded performance regressions
2123 * especially on architectures where smp_rmb (in seqcounts) are costly.
2124 * Keep the two functions in sync.
2125 */
2126
2127 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002128 * The hash list is protected using RCU.
2129 *
2130 * Take d_lock when comparing a candidate dentry, to avoid races
2131 * with d_move().
2132 *
2133 * It is possible that concurrent renames can mess up our list
2134 * walk here and result in missing our dentry, resulting in the
2135 * false-negative result. d_lookup() protects against concurrent
2136 * renames using rename_lock seqlock.
2137 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002138 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002139 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 rcu_read_lock();
2141
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002142 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 if (dentry->d_name.hash != hash)
2145 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146
2147 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148 if (dentry->d_parent != parent)
2149 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002150 if (d_unhashed(dentry))
2151 goto next;
2152
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 /*
2154 * It is safe to compare names since d_move() cannot
2155 * change the qstr (protected by d_lock).
2156 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002157 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002158 int tlen = dentry->d_name.len;
2159 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002160 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 goto next;
2162 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002163 if (dentry->d_name.len != len)
2164 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002165 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 goto next;
2167 }
2168
Waiman Long98474232013-08-28 18:24:59 -07002169 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002170 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 spin_unlock(&dentry->d_lock);
2172 break;
2173next:
2174 spin_unlock(&dentry->d_lock);
2175 }
2176 rcu_read_unlock();
2177
2178 return found;
2179}
2180
2181/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002182 * d_hash_and_lookup - hash the qstr then search for a dentry
2183 * @dir: Directory to search in
2184 * @name: qstr of name we wish to find
2185 *
Al Viro4f522a22013-02-11 23:20:37 -05002186 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002187 */
2188struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2189{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002190 /*
2191 * Check for a fs-specific hash function. Note that we must
2192 * calculate the standard hash first, as the d_op->d_hash()
2193 * routine may choose to leave the hash value unchanged.
2194 */
2195 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002196 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002197 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002198 if (unlikely(err < 0))
2199 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002200 }
Al Viro4f522a22013-02-11 23:20:37 -05002201 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002202}
Al Viro4f522a22013-02-11 23:20:37 -05002203EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002204
2205/**
Nick Piggin786a5e12011-01-07 17:49:16 +11002206 * d_validate - verify dentry provided from insecure source (deprecated)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 * @dentry: The dentry alleged to be valid child of @dparent
Randy Dunlapff5fdb62011-01-22 20:16:06 -08002208 * @dparent: The parent dentry (known to be valid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 *
2210 * An insecure source has sent us a dentry, here we verify it and dget() it.
2211 * This is used by ncpfs in its readdir implementation.
2212 * Zero is returned in the dentry is invalid.
Nick Piggin786a5e12011-01-07 17:49:16 +11002213 *
2214 * This function is slow for big directories, and deprecated, do not use it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215 */
Nick Piggind3a23e12011-01-05 20:01:21 +11002216int d_validate(struct dentry *dentry, struct dentry *dparent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217{
Nick Piggin786a5e12011-01-07 17:49:16 +11002218 struct dentry *child;
Nick Piggind3a23e12011-01-05 20:01:21 +11002219
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002220 spin_lock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002221 list_for_each_entry(child, &dparent->d_subdirs, d_u.d_child) {
2222 if (dentry == child) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002223 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Nick Piggindc0474b2011-01-07 17:49:43 +11002224 __dget_dlock(dentry);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002225 spin_unlock(&dentry->d_lock);
2226 spin_unlock(&dparent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227 return 1;
2228 }
2229 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002230 spin_unlock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002231
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232 return 0;
2233}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002234EXPORT_SYMBOL(d_validate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235
2236/*
2237 * When a file is deleted, we have two options:
2238 * - turn this dentry into a negative dentry
2239 * - unhash this dentry and free it.
2240 *
2241 * Usually, we want to just turn this into
2242 * a negative dentry, but if anybody else is
2243 * currently using the dentry or the inode
2244 * we can't do that and we fall back on removing
2245 * it from the hash queues and waiting for
2246 * it to be deleted later when it has no users
2247 */
2248
2249/**
2250 * d_delete - delete a dentry
2251 * @dentry: The dentry to delete
2252 *
2253 * Turn the dentry into a negative dentry if possible, otherwise
2254 * remove it from the hash queues so it can be deleted later
2255 */
2256
2257void d_delete(struct dentry * dentry)
2258{
Nick Piggin873feea2011-01-07 17:50:06 +11002259 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002260 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 /*
2262 * Are we the only user?
2263 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002264again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002266 inode = dentry->d_inode;
2267 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002268 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002269 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002270 spin_unlock(&dentry->d_lock);
2271 cpu_relax();
2272 goto again;
2273 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002274 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002275 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002276 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 return;
2278 }
2279
2280 if (!d_unhashed(dentry))
2281 __d_drop(dentry);
2282
2283 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002284
2285 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002287EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002289static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002290{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002291 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002292 hlist_bl_lock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -07002293 entry->d_flags |= DCACHE_RCUACCESS;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002294 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002295 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296}
2297
David Howells770bfad2006-08-22 20:06:07 -04002298static void _d_rehash(struct dentry * entry)
2299{
2300 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2301}
2302
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303/**
2304 * d_rehash - add an entry back to the hash
2305 * @entry: dentry to add to the hash
2306 *
2307 * Adds a dentry to the hash according to its name.
2308 */
2309
2310void d_rehash(struct dentry * entry)
2311{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002313 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002316EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002318/**
2319 * dentry_update_name_case - update case insensitive dentry with a new name
2320 * @dentry: dentry to be updated
2321 * @name: new name
2322 *
2323 * Update a case insensitive dentry with new case of name.
2324 *
2325 * dentry must have been returned by d_lookup with name @name. Old and new
2326 * name lengths must match (ie. no d_compare which allows mismatched name
2327 * lengths).
2328 *
2329 * Parent inode i_mutex must be held over d_lookup and into this call (to
2330 * keep renames and concurrent inserts, and readdir(2) away).
2331 */
2332void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2333{
Linus Torvalds7ebfa572011-04-15 07:34:26 -07002334 BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002335 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2336
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002337 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002338 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002339 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002340 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002341 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002342}
2343EXPORT_SYMBOL(dentry_update_name_case);
2344
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345static void switch_names(struct dentry *dentry, struct dentry *target)
2346{
2347 if (dname_external(target)) {
2348 if (dname_external(dentry)) {
2349 /*
2350 * Both external: swap the pointers
2351 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002352 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353 } else {
2354 /*
2355 * dentry:internal, target:external. Steal target's
2356 * storage and make target internal.
2357 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002358 memcpy(target->d_iname, dentry->d_name.name,
2359 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360 dentry->d_name.name = target->d_name.name;
2361 target->d_name.name = target->d_iname;
2362 }
2363 } else {
2364 if (dname_external(dentry)) {
2365 /*
2366 * dentry:external, target:internal. Give dentry's
2367 * storage to target and make dentry internal
2368 */
2369 memcpy(dentry->d_iname, target->d_name.name,
2370 target->d_name.len + 1);
2371 target->d_name.name = dentry->d_name.name;
2372 dentry->d_name.name = dentry->d_iname;
2373 } else {
2374 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002375 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002377 unsigned int i;
2378 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2379 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2380 swap(((long *) &dentry->d_iname)[i],
2381 ((long *) &target->d_iname)[i]);
2382 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383 }
2384 }
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002385 swap(dentry->d_name.len, target->d_name.len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386}
2387
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002388static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2389{
2390 /*
2391 * XXXX: do we really need to take target->d_lock?
2392 */
2393 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2394 spin_lock(&target->d_parent->d_lock);
2395 else {
2396 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2397 spin_lock(&dentry->d_parent->d_lock);
2398 spin_lock_nested(&target->d_parent->d_lock,
2399 DENTRY_D_LOCK_NESTED);
2400 } else {
2401 spin_lock(&target->d_parent->d_lock);
2402 spin_lock_nested(&dentry->d_parent->d_lock,
2403 DENTRY_D_LOCK_NESTED);
2404 }
2405 }
2406 if (target < dentry) {
2407 spin_lock_nested(&target->d_lock, 2);
2408 spin_lock_nested(&dentry->d_lock, 3);
2409 } else {
2410 spin_lock_nested(&dentry->d_lock, 2);
2411 spin_lock_nested(&target->d_lock, 3);
2412 }
2413}
2414
2415static void dentry_unlock_parents_for_move(struct dentry *dentry,
2416 struct dentry *target)
2417{
2418 if (target->d_parent != dentry->d_parent)
2419 spin_unlock(&dentry->d_parent->d_lock);
2420 if (target->d_parent != target)
2421 spin_unlock(&target->d_parent->d_lock);
2422}
2423
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002425 * When switching names, the actual string doesn't strictly have to
2426 * be preserved in the target - because we're dropping the target
2427 * anyway. As such, we can just do a simple memcpy() to copy over
2428 * the new name before we switch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429 *
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002430 * Note that we have to be a lot more careful about getting the hash
2431 * switched - we have to switch the hash value properly even if it
2432 * then no longer matches the actual (corrupted) string of the target.
2433 * The hash value has to match the hash queue that the dentry is on..
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002435/*
Al Viro18367502011-07-12 21:42:24 -04002436 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002437 * @dentry: entry to move
2438 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002439 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 *
2441 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002442 * dcache entries should not be moved in this way. Caller must hold
2443 * rename_lock, the i_mutex of the source and target directories,
2444 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002446static void __d_move(struct dentry *dentry, struct dentry *target,
2447 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449 if (!dentry->d_inode)
2450 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2451
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002452 BUG_ON(d_ancestor(dentry, target));
2453 BUG_ON(d_ancestor(target, dentry));
2454
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002455 dentry_lock_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456
Nick Piggin31e6b012011-01-07 17:49:52 +11002457 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002458 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002459
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002460 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2461
2462 /*
2463 * Move the dentry to the target hash queue. Don't bother checking
2464 * for the same hash queue because of how unlikely it is.
2465 */
2466 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002467 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468
Miklos Szeredida1ce062014-04-01 17:08:43 +02002469 /*
2470 * Unhash the target (d_delete() is not usable here). If exchanging
2471 * the two dentries, then rehash onto the other's hash queue.
2472 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002473 __d_drop(target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002474 if (exchange) {
2475 __d_rehash(target,
2476 d_hash(dentry->d_parent, dentry->d_name.hash));
2477 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478
Eric Dumazet5160ee62006-01-08 01:03:32 -08002479 list_del(&dentry->d_u.d_child);
2480 list_del(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481
2482 /* Switch the names.. */
2483 switch_names(dentry, target);
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002484 swap(dentry->d_name.hash, target->d_name.hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485
2486 /* ... and switch the parents */
2487 if (IS_ROOT(dentry)) {
2488 dentry->d_parent = target->d_parent;
2489 target->d_parent = target;
Eric Dumazet5160ee62006-01-08 01:03:32 -08002490 INIT_LIST_HEAD(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491 } else {
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002492 swap(dentry->d_parent, target->d_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493
2494 /* And add them back to the (new) parent lists */
Eric Dumazet5160ee62006-01-08 01:03:32 -08002495 list_add(&target->d_u.d_child, &target->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496 }
2497
Eric Dumazet5160ee62006-01-08 01:03:32 -08002498 list_add(&dentry->d_u.d_child, &dentry->d_parent->d_subdirs);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002499
Nick Piggin31e6b012011-01-07 17:49:52 +11002500 write_seqcount_end(&target->d_seq);
2501 write_seqcount_end(&dentry->d_seq);
2502
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002503 dentry_unlock_parents_for_move(dentry, target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002504 if (exchange)
2505 fsnotify_d_move(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506 spin_unlock(&target->d_lock);
Nick Pigginc32ccd82006-03-25 03:07:09 -08002507 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002508 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002509}
2510
2511/*
2512 * d_move - move a dentry
2513 * @dentry: entry to move
2514 * @target: new dentry
2515 *
2516 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002517 * dcache entries should not be moved in this way. See the locking
2518 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002519 */
2520void d_move(struct dentry *dentry, struct dentry *target)
2521{
2522 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002523 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002524 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002525}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002526EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002527
Miklos Szeredida1ce062014-04-01 17:08:43 +02002528/*
2529 * d_exchange - exchange two dentries
2530 * @dentry1: first dentry
2531 * @dentry2: second dentry
2532 */
2533void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2534{
2535 write_seqlock(&rename_lock);
2536
2537 WARN_ON(!dentry1->d_inode);
2538 WARN_ON(!dentry2->d_inode);
2539 WARN_ON(IS_ROOT(dentry1));
2540 WARN_ON(IS_ROOT(dentry2));
2541
2542 __d_move(dentry1, dentry2, true);
2543
2544 write_sequnlock(&rename_lock);
2545}
2546
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002547/**
2548 * d_ancestor - search for an ancestor
2549 * @p1: ancestor dentry
2550 * @p2: child dentry
2551 *
2552 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2553 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002554 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002555struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002556{
2557 struct dentry *p;
2558
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002559 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002560 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002561 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002562 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002563 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002564}
2565
2566/*
2567 * This helper attempts to cope with remotely renamed directories
2568 *
2569 * It assumes that the caller is already holding
Al Viro18367502011-07-12 21:42:24 -04002570 * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002571 *
2572 * Note: If ever the locking in lock_rename() changes, then please
2573 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002574 */
Nick Piggin873feea2011-01-07 17:50:06 +11002575static struct dentry *__d_unalias(struct inode *inode,
2576 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002577{
2578 struct mutex *m1 = NULL, *m2 = NULL;
Al Viroee3efa92012-06-08 15:59:33 -04002579 struct dentry *ret = ERR_PTR(-EBUSY);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002580
2581 /* If alias and dentry share a parent, then no extra locks required */
2582 if (alias->d_parent == dentry->d_parent)
2583 goto out_unalias;
2584
Trond Myklebust9eaef272006-10-21 10:24:20 -07002585 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002586 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2587 goto out_err;
2588 m1 = &dentry->d_sb->s_vfs_rename_mutex;
2589 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
2590 goto out_err;
2591 m2 = &alias->d_parent->d_inode->i_mutex;
2592out_unalias:
Al Viroee3efa92012-06-08 15:59:33 -04002593 if (likely(!d_mountpoint(alias))) {
Miklos Szeredida1ce062014-04-01 17:08:43 +02002594 __d_move(alias, dentry, false);
Al Viroee3efa92012-06-08 15:59:33 -04002595 ret = alias;
2596 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002597out_err:
Nick Piggin873feea2011-01-07 17:50:06 +11002598 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002599 if (m2)
2600 mutex_unlock(m2);
2601 if (m1)
2602 mutex_unlock(m1);
2603 return ret;
2604}
2605
2606/*
David Howells770bfad2006-08-22 20:06:07 -04002607 * Prepare an anonymous dentry for life in the superblock's dentry tree as a
2608 * named dentry in place of the dentry to be replaced.
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002609 * returns with anon->d_lock held!
David Howells770bfad2006-08-22 20:06:07 -04002610 */
2611static void __d_materialise_dentry(struct dentry *dentry, struct dentry *anon)
2612{
Al Viro740da422013-01-30 10:13:38 -05002613 struct dentry *dparent;
David Howells770bfad2006-08-22 20:06:07 -04002614
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002615 dentry_lock_for_move(anon, dentry);
David Howells770bfad2006-08-22 20:06:07 -04002616
Nick Piggin31e6b012011-01-07 17:49:52 +11002617 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002618 write_seqcount_begin_nested(&anon->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002619
David Howells770bfad2006-08-22 20:06:07 -04002620 dparent = dentry->d_parent;
David Howells770bfad2006-08-22 20:06:07 -04002621
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002622 switch_names(dentry, anon);
2623 swap(dentry->d_name.hash, anon->d_name.hash);
2624
Al Viro740da422013-01-30 10:13:38 -05002625 dentry->d_parent = dentry;
2626 list_del_init(&dentry->d_u.d_child);
2627 anon->d_parent = dparent;
Wei Yongjun9ed53b12013-03-12 00:10:50 +08002628 list_move(&anon->d_u.d_child, &dparent->d_subdirs);
David Howells770bfad2006-08-22 20:06:07 -04002629
Nick Piggin31e6b012011-01-07 17:49:52 +11002630 write_seqcount_end(&dentry->d_seq);
2631 write_seqcount_end(&anon->d_seq);
2632
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002633 dentry_unlock_parents_for_move(anon, dentry);
2634 spin_unlock(&dentry->d_lock);
2635
2636 /* anon->d_lock still locked, returns locked */
David Howells770bfad2006-08-22 20:06:07 -04002637}
2638
2639/**
2640 * d_materialise_unique - introduce an inode into the tree
2641 * @dentry: candidate dentry
2642 * @inode: inode to bind to the dentry, to which aliases may be attached
2643 *
2644 * Introduces an dentry into the tree, substituting an extant disconnected
Jeff Laytonc46c8872011-07-26 13:33:16 -04002645 * root directory alias in its place if there is one. Caller must hold the
2646 * i_mutex of the parent directory.
David Howells770bfad2006-08-22 20:06:07 -04002647 */
2648struct dentry *d_materialise_unique(struct dentry *dentry, struct inode *inode)
2649{
Trond Myklebust9eaef272006-10-21 10:24:20 -07002650 struct dentry *actual;
David Howells770bfad2006-08-22 20:06:07 -04002651
2652 BUG_ON(!d_unhashed(dentry));
2653
David Howells770bfad2006-08-22 20:06:07 -04002654 if (!inode) {
2655 actual = dentry;
OGAWA Hirofumi360da902008-10-16 07:50:28 +09002656 __d_instantiate(dentry, NULL);
Nick Piggin357f8e62011-01-07 17:49:42 +11002657 d_rehash(actual);
2658 goto out_nolock;
David Howells770bfad2006-08-22 20:06:07 -04002659 }
2660
Nick Piggin873feea2011-01-07 17:50:06 +11002661 spin_lock(&inode->i_lock);
Nick Piggin357f8e62011-01-07 17:49:42 +11002662
Trond Myklebust9eaef272006-10-21 10:24:20 -07002663 if (S_ISDIR(inode->i_mode)) {
2664 struct dentry *alias;
David Howells770bfad2006-08-22 20:06:07 -04002665
Trond Myklebust9eaef272006-10-21 10:24:20 -07002666 /* Does an aliased dentry already exist? */
Linus Torvalds32ba9c32012-06-08 10:34:03 -07002667 alias = __d_find_alias(inode, 0);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002668 if (alias) {
2669 actual = alias;
Al Viro18367502011-07-12 21:42:24 -04002670 write_seqlock(&rename_lock);
2671
2672 if (d_ancestor(alias, dentry)) {
2673 /* Check for loops */
2674 actual = ERR_PTR(-ELOOP);
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002675 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002676 } else if (IS_ROOT(alias)) {
2677 /* Is this an anonymous mountpoint that we
2678 * could splice into our tree? */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002679 __d_materialise_dentry(dentry, alias);
Al Viro18367502011-07-12 21:42:24 -04002680 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002681 __d_drop(alias);
2682 goto found;
Al Viro18367502011-07-12 21:42:24 -04002683 } else {
2684 /* Nope, but we must(!) avoid directory
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002685 * aliasing. This drops inode->i_lock */
Al Viro18367502011-07-12 21:42:24 -04002686 actual = __d_unalias(inode, dentry, alias);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002687 }
Al Viro18367502011-07-12 21:42:24 -04002688 write_sequnlock(&rename_lock);
David Howellsdd179942011-08-16 15:31:30 +01002689 if (IS_ERR(actual)) {
2690 if (PTR_ERR(actual) == -ELOOP)
2691 pr_warn_ratelimited(
2692 "VFS: Lookup of '%s' in %s %s"
2693 " would have caused loop\n",
2694 dentry->d_name.name,
2695 inode->i_sb->s_type->name,
2696 inode->i_sb->s_id);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002697 dput(alias);
David Howellsdd179942011-08-16 15:31:30 +01002698 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002699 goto out_nolock;
2700 }
David Howells770bfad2006-08-22 20:06:07 -04002701 }
2702
2703 /* Add a unique reference */
2704 actual = __d_instantiate_unique(dentry, inode);
2705 if (!actual)
2706 actual = dentry;
Nick Piggin357f8e62011-01-07 17:49:42 +11002707 else
2708 BUG_ON(!d_unhashed(actual));
David Howells770bfad2006-08-22 20:06:07 -04002709
David Howells770bfad2006-08-22 20:06:07 -04002710 spin_lock(&actual->d_lock);
2711found:
2712 _d_rehash(actual);
2713 spin_unlock(&actual->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002714 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002715out_nolock:
David Howells770bfad2006-08-22 20:06:07 -04002716 if (actual == dentry) {
2717 security_d_instantiate(dentry, inode);
2718 return NULL;
2719 }
2720
2721 iput(inode);
2722 return actual;
David Howells770bfad2006-08-22 20:06:07 -04002723}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002724EXPORT_SYMBOL_GPL(d_materialise_unique);
David Howells770bfad2006-08-22 20:06:07 -04002725
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002726static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002727{
2728 *buflen -= namelen;
2729 if (*buflen < 0)
2730 return -ENAMETOOLONG;
2731 *buffer -= namelen;
2732 memcpy(*buffer, str, namelen);
2733 return 0;
2734}
2735
Waiman Long232d2d62013-09-09 12:18:13 -04002736/**
2737 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04002738 * @buffer: buffer pointer
2739 * @buflen: allocated length of the buffer
2740 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04002741 *
2742 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
2743 * make sure that either the old or the new name pointer and length are
2744 * fetched. However, there may be mismatch between length and pointer.
2745 * The length cannot be trusted, we need to copy it byte-by-byte until
2746 * the length is reached or a null byte is found. It also prepends "/" at
2747 * the beginning of the name. The sequence number check at the caller will
2748 * retry it again when a d_move() does happen. So any garbage in the buffer
2749 * due to mismatched pointer and length will be discarded.
2750 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002751static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2752{
Waiman Long232d2d62013-09-09 12:18:13 -04002753 const char *dname = ACCESS_ONCE(name->name);
2754 u32 dlen = ACCESS_ONCE(name->len);
2755 char *p;
2756
Waiman Long232d2d62013-09-09 12:18:13 -04002757 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04002758 if (*buflen < 0)
2759 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04002760 p = *buffer -= dlen + 1;
2761 *p++ = '/';
2762 while (dlen--) {
2763 char c = *dname++;
2764 if (!c)
2765 break;
2766 *p++ = c;
2767 }
2768 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002769}
2770
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771/**
Randy Dunlap208898c2010-11-18 15:02:49 -08002772 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002773 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002774 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002775 * @buffer: pointer to the end of the buffer
2776 * @buflen: pointer to buffer length
2777 *
Waiman Long18129972013-09-12 10:55:35 -04002778 * The function will first try to write out the pathname without taking any
2779 * lock other than the RCU read lock to make sure that dentries won't go away.
2780 * It only checks the sequence number of the global rename_lock as any change
2781 * in the dentry's d_seq will be preceded by changes in the rename_lock
2782 * sequence number. If the sequence number had been changed, it will restart
2783 * the whole pathname back-tracing sequence again by taking the rename_lock.
2784 * In this case, there is no need to take the RCU read lock as the recursive
2785 * parent pointer references will keep the dentry chain alive as long as no
2786 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002787 */
Al Viro02125a82011-12-05 08:43:34 -05002788static int prepend_path(const struct path *path,
2789 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002790 char **buffer, int *buflen)
2791{
Al Viroede4ceb2013-11-13 07:45:40 -05002792 struct dentry *dentry;
2793 struct vfsmount *vfsmnt;
2794 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002795 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04002796 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04002797 char *bptr;
2798 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002799
Al Viro48f5ec22013-09-09 15:22:25 -04002800 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04002801restart_mnt:
2802 read_seqbegin_or_lock(&mount_lock, &m_seq);
2803 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002804 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002805restart:
2806 bptr = *buffer;
2807 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04002808 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05002809 dentry = path->dentry;
2810 vfsmnt = path->mnt;
2811 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04002812 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002813 while (dentry != root->dentry || vfsmnt != root->mnt) {
2814 struct dentry * parent;
2815
2816 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04002817 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002818 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04002819 if (mnt != parent) {
2820 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
2821 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04002822 vfsmnt = &mnt->mnt;
2823 continue;
2824 }
2825 /*
2826 * Filesystems needing to implement special "root names"
2827 * should do so with ->d_dname()
2828 */
2829 if (IS_ROOT(dentry) &&
2830 (dentry->d_name.len != 1 ||
2831 dentry->d_name.name[0] != '/')) {
2832 WARN(1, "Root dentry has weird name <%.*s>\n",
2833 (int) dentry->d_name.len,
2834 dentry->d_name.name);
2835 }
2836 if (!error)
2837 error = is_mounted(vfsmnt) ? 1 : 2;
2838 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002839 }
2840 parent = dentry->d_parent;
2841 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002842 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002843 if (error)
2844 break;
2845
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002846 dentry = parent;
2847 }
Al Viro48f5ec22013-09-09 15:22:25 -04002848 if (!(seq & 1))
2849 rcu_read_unlock();
2850 if (need_seqretry(&rename_lock, seq)) {
2851 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04002852 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002853 }
Al Viro48f5ec22013-09-09 15:22:25 -04002854 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002855
2856 if (!(m_seq & 1))
2857 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04002858 if (need_seqretry(&mount_lock, m_seq)) {
2859 m_seq = 1;
2860 goto restart_mnt;
2861 }
2862 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002863
Waiman Long232d2d62013-09-09 12:18:13 -04002864 if (error >= 0 && bptr == *buffer) {
2865 if (--blen < 0)
2866 error = -ENAMETOOLONG;
2867 else
2868 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002869 }
Waiman Long232d2d62013-09-09 12:18:13 -04002870 *buffer = bptr;
2871 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04002872 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002873}
2874
2875/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002876 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002877 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002878 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07002879 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880 * @buflen: buffer length
2881 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002882 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002883 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002884 * Returns a pointer into the buffer or an error code if the
2885 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08002886 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04002887 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002888 *
Al Viro02125a82011-12-05 08:43:34 -05002889 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002890 */
Al Viro02125a82011-12-05 08:43:34 -05002891char *__d_path(const struct path *path,
2892 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002893 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002894{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002895 char *res = buf + buflen;
2896 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002897
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002898 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002899 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002900
Al Viro02125a82011-12-05 08:43:34 -05002901 if (error < 0)
2902 return ERR_PTR(error);
2903 if (error > 0)
2904 return NULL;
2905 return res;
2906}
2907
2908char *d_absolute_path(const struct path *path,
2909 char *buf, int buflen)
2910{
2911 struct path root = {};
2912 char *res = buf + buflen;
2913 int error;
2914
2915 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05002916 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05002917
2918 if (error > 1)
2919 error = -EINVAL;
2920 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002921 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002922 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002923}
2924
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002925/*
2926 * same as __d_path but appends "(deleted)" for unlinked files.
2927 */
Al Viro02125a82011-12-05 08:43:34 -05002928static int path_with_deleted(const struct path *path,
2929 const struct path *root,
2930 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002931{
2932 prepend(buf, buflen, "\0", 1);
2933 if (d_unlinked(path->dentry)) {
2934 int error = prepend(buf, buflen, " (deleted)", 10);
2935 if (error)
2936 return error;
2937 }
2938
2939 return prepend_path(path, root, buf, buflen);
2940}
2941
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002942static int prepend_unreachable(char **buffer, int *buflen)
2943{
2944 return prepend(buffer, buflen, "(unreachable)", 13);
2945}
2946
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07002947static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
2948{
2949 unsigned seq;
2950
2951 do {
2952 seq = read_seqcount_begin(&fs->seq);
2953 *root = fs->root;
2954 } while (read_seqcount_retry(&fs->seq, seq));
2955}
2956
Jan Bluncka03a8a702008-02-14 19:38:32 -08002957/**
2958 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08002959 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08002960 * @buf: buffer to return value in
2961 * @buflen: buffer length
2962 *
2963 * Convert a dentry into an ASCII path name. If the entry has been deleted
2964 * the string " (deleted)" is appended. Note that this is ambiguous.
2965 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002966 * Returns a pointer into the buffer or an error code if the path was
2967 * too long. Note: Callers should use the returned pointer, not the passed
2968 * in buffer, to use the name! The implementation often starts at an offset
2969 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002970 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002971 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002972 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07002973char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002974{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002975 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08002976 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002977 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002978
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002979 /*
2980 * We have various synthetic filesystems that never get mounted. On
2981 * these filesystems dentries are never used for lookup purposes, and
2982 * thus don't need to be hashed. They also don't need a name until a
2983 * user wants to identify the object in /proc/pid/fd/. The little hack
2984 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08002985 *
2986 * Some pseudo inodes are mountable. When they are mounted
2987 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
2988 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002989 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08002990 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
2991 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08002992 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002993
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07002994 rcu_read_lock();
2995 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05002996 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07002997 rcu_read_unlock();
2998
Al Viro02125a82011-12-05 08:43:34 -05002999 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003000 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003001 return res;
3002}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003003EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003004
3005/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003006 * Helper function for dentry_operations.d_dname() members
3007 */
3008char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3009 const char *fmt, ...)
3010{
3011 va_list args;
3012 char temp[64];
3013 int sz;
3014
3015 va_start(args, fmt);
3016 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3017 va_end(args);
3018
3019 if (sz > sizeof(temp) || sz > buflen)
3020 return ERR_PTR(-ENAMETOOLONG);
3021
3022 buffer += buflen - sz;
3023 return memcpy(buffer, temp, sz);
3024}
3025
Al Viro118b2302013-08-24 12:08:17 -04003026char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3027{
3028 char *end = buffer + buflen;
3029 /* these dentries are never renamed, so d_lock is not needed */
3030 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003031 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003032 prepend(&end, &buflen, "/", 1))
3033 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003034 return end;
Al Viro118b2302013-08-24 12:08:17 -04003035}
David Herrmann31bbe162014-01-03 14:09:47 +01003036EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003037
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003038/*
Ram Pai6092d042008-03-27 13:06:20 +01003039 * Write full pathname from the root of the filesystem into the buffer.
3040 */
Al Virof6500802014-01-26 12:37:55 -05003041static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003042{
Al Virof6500802014-01-26 12:37:55 -05003043 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003044 char *end, *retval;
3045 int len, seq = 0;
3046 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003047
Al Virof6500802014-01-26 12:37:55 -05003048 if (buflen < 2)
3049 goto Elong;
3050
Al Viro48f5ec22013-09-09 15:22:25 -04003051 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003052restart:
Al Virof6500802014-01-26 12:37:55 -05003053 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003054 end = buf + buflen;
3055 len = buflen;
3056 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003057 /* Get '/' right */
3058 retval = end-1;
3059 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003060 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003061 while (!IS_ROOT(dentry)) {
3062 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003063
Ram Pai6092d042008-03-27 13:06:20 +01003064 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003065 error = prepend_name(&end, &len, &dentry->d_name);
3066 if (error)
3067 break;
Ram Pai6092d042008-03-27 13:06:20 +01003068
3069 retval = end;
3070 dentry = parent;
3071 }
Al Viro48f5ec22013-09-09 15:22:25 -04003072 if (!(seq & 1))
3073 rcu_read_unlock();
3074 if (need_seqretry(&rename_lock, seq)) {
3075 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003076 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003077 }
3078 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003079 if (error)
3080 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003081 return retval;
3082Elong:
3083 return ERR_PTR(-ENAMETOOLONG);
3084}
Nick Pigginec2447c2011-01-07 17:49:29 +11003085
3086char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3087{
Waiman Long232d2d62013-09-09 12:18:13 -04003088 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003089}
3090EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003091
3092char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3093{
3094 char *p = NULL;
3095 char *retval;
3096
Al Viroc1031352010-06-06 22:31:14 -04003097 if (d_unlinked(dentry)) {
3098 p = buf + buflen;
3099 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3100 goto Elong;
3101 buflen++;
3102 }
3103 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003104 if (!IS_ERR(retval) && p)
3105 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003106 return retval;
3107Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003108 return ERR_PTR(-ENAMETOOLONG);
3109}
3110
Linus Torvalds8b19e342013-09-12 10:35:47 -07003111static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3112 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003113{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003114 unsigned seq;
3115
3116 do {
3117 seq = read_seqcount_begin(&fs->seq);
3118 *root = fs->root;
3119 *pwd = fs->pwd;
3120 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003121}
3122
Ram Pai6092d042008-03-27 13:06:20 +01003123/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003124 * NOTE! The user-level library version returns a
3125 * character pointer. The kernel system call just
3126 * returns the length of the buffer filled (which
3127 * includes the ending '\0' character), or a negative
3128 * error value. So libc would do something like
3129 *
3130 * char *getcwd(char * buf, size_t size)
3131 * {
3132 * int retval;
3133 *
3134 * retval = sys_getcwd(buf, size);
3135 * if (retval >= 0)
3136 * return buf;
3137 * errno = -retval;
3138 * return NULL;
3139 * }
3140 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003141SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003142{
Linus Torvalds552ce542007-02-13 12:08:18 -08003143 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003144 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003145 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003146
3147 if (!page)
3148 return -ENOMEM;
3149
Linus Torvalds8b19e342013-09-12 10:35:47 -07003150 rcu_read_lock();
3151 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003152
Linus Torvalds552ce542007-02-13 12:08:18 -08003153 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003154 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003155 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003156 char *cwd = page + PATH_MAX;
3157 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003158
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003159 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003160 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003161 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003162
Al Viro02125a82011-12-05 08:43:34 -05003163 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003164 goto out;
3165
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003166 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003167 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003168 error = prepend_unreachable(&cwd, &buflen);
3169 if (error)
3170 goto out;
3171 }
3172
Linus Torvalds552ce542007-02-13 12:08:18 -08003173 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003174 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003175 if (len <= size) {
3176 error = len;
3177 if (copy_to_user(buf, cwd, len))
3178 error = -EFAULT;
3179 }
Nick Piggin949854d2011-01-07 17:49:37 +11003180 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003181 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003182 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003183
3184out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003185 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003186 return error;
3187}
3188
3189/*
3190 * Test whether new_dentry is a subdirectory of old_dentry.
3191 *
3192 * Trivially implemented using the dcache structure
3193 */
3194
3195/**
3196 * is_subdir - is new dentry a subdirectory of old_dentry
3197 * @new_dentry: new dentry
3198 * @old_dentry: old dentry
3199 *
3200 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
3201 * Returns 0 otherwise.
3202 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3203 */
3204
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003205int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003206{
3207 int result;
Nick Piggin949854d2011-01-07 17:49:37 +11003208 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003209
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003210 if (new_dentry == old_dentry)
3211 return 1;
3212
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003213 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003214 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003215 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003216 /*
3217 * Need rcu_readlock to protect against the d_parent trashing
3218 * due to d_move
3219 */
3220 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003221 if (d_ancestor(old_dentry, new_dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003222 result = 1;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003223 else
3224 result = 0;
Nick Piggin949854d2011-01-07 17:49:37 +11003225 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003226 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003227
3228 return result;
3229}
3230
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003231static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003232{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003233 struct dentry *root = data;
3234 if (dentry != root) {
3235 if (d_unhashed(dentry) || !dentry->d_inode)
3236 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003237
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003238 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3239 dentry->d_flags |= DCACHE_GENOCIDE;
3240 dentry->d_lockref.count--;
3241 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003242 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003243 return D_WALK_CONTINUE;
3244}
Nick Piggin58db63d2011-01-07 17:49:39 +11003245
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003246void d_genocide(struct dentry *parent)
3247{
3248 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003249}
3250
Al Viro60545d02013-06-07 01:20:27 -04003251void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003252{
Al Viro60545d02013-06-07 01:20:27 -04003253 inode_dec_link_count(inode);
3254 BUG_ON(dentry->d_name.name != dentry->d_iname ||
3255 !hlist_unhashed(&dentry->d_alias) ||
3256 !d_unlinked(dentry));
3257 spin_lock(&dentry->d_parent->d_lock);
3258 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3259 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3260 (unsigned long long)inode->i_ino);
3261 spin_unlock(&dentry->d_lock);
3262 spin_unlock(&dentry->d_parent->d_lock);
3263 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003264}
Al Viro60545d02013-06-07 01:20:27 -04003265EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003266
3267static __initdata unsigned long dhash_entries;
3268static int __init set_dhash_entries(char *str)
3269{
3270 if (!str)
3271 return 0;
3272 dhash_entries = simple_strtoul(str, &str, 0);
3273 return 1;
3274}
3275__setup("dhash_entries=", set_dhash_entries);
3276
3277static void __init dcache_init_early(void)
3278{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003279 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003280
3281 /* If hashes are distributed across NUMA nodes, defer
3282 * hash allocation until vmalloc space is available.
3283 */
3284 if (hashdist)
3285 return;
3286
3287 dentry_hashtable =
3288 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003289 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003290 dhash_entries,
3291 13,
3292 HASH_EARLY,
3293 &d_hash_shift,
3294 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003295 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003296 0);
3297
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003298 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003299 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003300}
3301
Denis Cheng74bf17c2007-10-16 23:26:30 -07003302static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003303{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003304 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003305
3306 /*
3307 * A constructor could be added for stable state like the lists,
3308 * but it is probably not worth it because of the cache nature
3309 * of the dcache.
3310 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003311 dentry_cache = KMEM_CACHE(dentry,
3312 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003313
3314 /* Hash may have been set up in dcache_init_early */
3315 if (!hashdist)
3316 return;
3317
3318 dentry_hashtable =
3319 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003320 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003321 dhash_entries,
3322 13,
3323 0,
3324 &d_hash_shift,
3325 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003326 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003327 0);
3328
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003329 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003330 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003331}
3332
3333/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003334struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003335EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003336
Linus Torvalds1da177e2005-04-16 15:20:36 -07003337EXPORT_SYMBOL(d_genocide);
3338
Linus Torvalds1da177e2005-04-16 15:20:36 -07003339void __init vfs_caches_init_early(void)
3340{
3341 dcache_init_early();
3342 inode_init_early();
3343}
3344
3345void __init vfs_caches_init(unsigned long mempages)
3346{
3347 unsigned long reserve;
3348
3349 /* Base hash sizes on available memory, with a reserve equal to
3350 150% of current kernel size */
3351
3352 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
3353 mempages -= reserve;
3354
3355 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003356 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003357
Denis Cheng74bf17c2007-10-16 23:26:30 -07003358 dcache_init();
3359 inode_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003360 files_init(mempages);
Denis Cheng74bf17c2007-10-16 23:26:30 -07003361 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003362 bdev_cache_init();
3363 chrdev_init();
3364}