blob: 1577c14dfb4ee112808a8263998d117e569ce141 [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
Al Viroe55fd012014-05-28 13:51:12 -0400444static void __dentry_kill(struct dentry *dentry)
Nick Piggin77812a12011-01-07 17:49:48 +1100445{
Al Viro41edf272014-05-01 10:30:00 -0400446 struct dentry *parent = NULL;
447 bool can_free = true;
Al Viro41edf272014-05-01 10:30:00 -0400448 if (!IS_ROOT(dentry))
Nick Piggin77812a12011-01-07 17:49:48 +1100449 parent = dentry->d_parent;
Nick Piggin31e6b012011-01-07 17:49:52 +1100450
Linus Torvalds0d984392013-09-08 13:46:52 -0700451 /*
452 * The dentry is now unrecoverably dead to the world.
453 */
454 lockref_mark_dead(&dentry->d_lockref);
455
Sage Weilf0023bc2011-10-28 10:02:42 -0700456 /*
Sage Weilf0023bc2011-10-28 10:02:42 -0700457 * inform the fs via d_prune that this dentry is about to be
458 * unhashed and destroyed.
459 */
Yan, Zheng590fb512013-08-13 15:42:02 +0800460 if ((dentry->d_flags & DCACHE_OP_PRUNE) && !d_unhashed(dentry))
Yan, Zheng61572bb2013-04-15 14:13:21 +0800461 dentry->d_op->d_prune(dentry);
462
Al Viro01b60352014-04-29 23:42:52 -0400463 if (dentry->d_flags & DCACHE_LRU_LIST) {
464 if (!(dentry->d_flags & DCACHE_SHRINK_LIST))
465 d_lru_del(dentry);
Al Viro01b60352014-04-29 23:42:52 -0400466 }
Nick Piggin77812a12011-01-07 17:49:48 +1100467 /* if it was on the hash then remove it */
468 __d_drop(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400469 list_del(&dentry->d_u.d_child);
470 /*
471 * Inform d_walk() that we are no longer attached to the
472 * dentry tree
473 */
474 dentry->d_flags |= DCACHE_DENTRY_KILLED;
475 if (parent)
476 spin_unlock(&parent->d_lock);
477 dentry_iput(dentry);
478 /*
479 * dentry_iput drops the locks, at which point nobody (except
480 * transient RCU lookups) can reach this dentry.
481 */
482 BUG_ON((int)dentry->d_lockref.count > 0);
483 this_cpu_dec(nr_dentry);
484 if (dentry->d_op && dentry->d_op->d_release)
485 dentry->d_op->d_release(dentry);
486
Al Viro41edf272014-05-01 10:30:00 -0400487 spin_lock(&dentry->d_lock);
488 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
489 dentry->d_flags |= DCACHE_MAY_FREE;
490 can_free = false;
491 }
492 spin_unlock(&dentry->d_lock);
Al Viro41edf272014-05-01 10:30:00 -0400493 if (likely(can_free))
494 dentry_free(dentry);
Al Viroe55fd012014-05-28 13:51:12 -0400495}
496
497/*
498 * Finish off a dentry we've decided to kill.
499 * dentry->d_lock must be held, returns with it unlocked.
500 * If ref is non-zero, then decrement the refcount too.
501 * Returns dentry requiring refcount drop, or NULL if we're done.
502 */
503static struct dentry *
504dentry_kill(struct dentry *dentry, int unlock_on_failure)
505 __releases(dentry->d_lock)
506{
507 struct inode *inode = dentry->d_inode;
508 struct dentry *parent = NULL;
509
510 if (inode && unlikely(!spin_trylock(&inode->i_lock)))
511 goto failed;
512
513 if (!IS_ROOT(dentry)) {
514 parent = dentry->d_parent;
515 if (unlikely(!spin_trylock(&parent->d_lock))) {
516 if (inode)
517 spin_unlock(&inode->i_lock);
518 goto failed;
519 }
520 }
521
522 __dentry_kill(dentry);
Al Viro03b3b882014-04-29 15:45:28 -0400523 return parent;
Al Viroe55fd012014-05-28 13:51:12 -0400524
525failed:
526 if (unlock_on_failure) {
527 spin_unlock(&dentry->d_lock);
528 cpu_relax();
529 }
530 return dentry; /* try again with same dentry */
Nick Piggin77812a12011-01-07 17:49:48 +1100531}
532
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533/*
534 * This is dput
535 *
536 * This is complicated by the fact that we do not want to put
537 * dentries that are no longer on any hash chain on the unused
538 * list: we'd much rather just get rid of them immediately.
539 *
540 * However, that implies that we have to traverse the dentry
541 * tree upwards to the parents which might _also_ now be
542 * scheduled for deletion (it may have been only waiting for
543 * its last child to go away).
544 *
545 * This tail recursion is done by hand as we don't want to depend
546 * on the compiler to always get this right (gcc generally doesn't).
547 * Real recursion would eat up our stack space.
548 */
549
550/*
551 * dput - release a dentry
552 * @dentry: dentry to release
553 *
554 * Release a dentry. This will drop the usage count and if appropriate
555 * call the dentry unlink method as well as removing it from the queues and
556 * releasing its resources. If the parent dentries were scheduled for release
557 * they too may now get deleted.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559void dput(struct dentry *dentry)
560{
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700561 if (unlikely(!dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 return;
563
564repeat:
Waiman Long98474232013-08-28 18:24:59 -0700565 if (lockref_put_or_lock(&dentry->d_lockref))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
Linus Torvalds8aab6a22013-09-08 13:26:18 -0700568 /* Unreachable? Get rid of it */
569 if (unlikely(d_unhashed(dentry)))
570 goto kill_it;
571
572 if (unlikely(dentry->d_flags & DCACHE_OP_DELETE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 if (dentry->d_op->d_delete(dentry))
Nick Piggin61f3dee2011-01-07 17:49:40 +1100574 goto kill_it;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 }
Nick Piggin265ac902010-10-10 05:36:24 -0400576
Linus Torvalds358eec12013-10-31 15:43:02 -0700577 if (!(dentry->d_flags & DCACHE_REFERENCED))
578 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400579 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400580
Waiman Long98474232013-08-28 18:24:59 -0700581 dentry->d_lockref.count--;
Nick Piggin61f3dee2011-01-07 17:49:40 +1100582 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 return;
584
Miklos Szeredid52b9082007-05-08 00:23:46 -0700585kill_it:
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000586 dentry = dentry_kill(dentry, 1);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700587 if (dentry)
588 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700590EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
592/**
593 * d_invalidate - invalidate a dentry
594 * @dentry: dentry to invalidate
595 *
596 * Try to invalidate the dentry if it turns out to be
597 * possible. If there are other dentries that can be
598 * reached through this one we can't delete it and we
599 * return -EBUSY. On success we return 0.
600 *
601 * no dcache lock.
602 */
603
604int d_invalidate(struct dentry * dentry)
605{
606 /*
607 * If it's already been dropped, return OK.
608 */
Nick Pigginda502952011-01-07 17:49:33 +1100609 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 if (d_unhashed(dentry)) {
Nick Pigginda502952011-01-07 17:49:33 +1100611 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 return 0;
613 }
614 /*
615 * Check whether to do a partial shrink_dcache
616 * to get rid of unused child entries.
617 */
618 if (!list_empty(&dentry->d_subdirs)) {
Nick Pigginda502952011-01-07 17:49:33 +1100619 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 shrink_dcache_parent(dentry);
Nick Pigginda502952011-01-07 17:49:33 +1100621 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 }
623
624 /*
625 * Somebody else still using it?
626 *
627 * If it's a directory, we can't drop it
628 * for fear of somebody re-populating it
629 * with children (even though dropping it
630 * would make it unreachable from the root,
631 * we might still populate it if it was a
632 * working directory or similar).
Al Viro50e69632011-11-07 16:39:57 +0000633 * We also need to leave mountpoints alone,
634 * directory or not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 */
Waiman Long98474232013-08-28 18:24:59 -0700636 if (dentry->d_lockref.count > 1 && dentry->d_inode) {
Al Viro50e69632011-11-07 16:39:57 +0000637 if (S_ISDIR(dentry->d_inode->i_mode) || d_mountpoint(dentry)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 return -EBUSY;
640 }
641 }
642
643 __d_drop(dentry);
644 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 return 0;
646}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700647EXPORT_SYMBOL(d_invalidate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648
Nick Pigginb5c84bf2011-01-07 17:49:38 +1100649/* This must be called with d_lock held */
Nick Piggindc0474b2011-01-07 17:49:43 +1100650static inline void __dget_dlock(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651{
Waiman Long98474232013-08-28 18:24:59 -0700652 dentry->d_lockref.count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653}
654
Nick Piggindc0474b2011-01-07 17:49:43 +1100655static inline void __dget(struct dentry *dentry)
Nick Piggin23044502011-01-07 17:49:31 +1100656{
Waiman Long98474232013-08-28 18:24:59 -0700657 lockref_get(&dentry->d_lockref);
Nick Piggin23044502011-01-07 17:49:31 +1100658}
659
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100660struct dentry *dget_parent(struct dentry *dentry)
661{
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700662 int gotref;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100663 struct dentry *ret;
664
Waiman Longdf3d0bb2013-09-02 11:29:22 -0700665 /*
666 * Do optimistic parent lookup without any
667 * locking.
668 */
669 rcu_read_lock();
670 ret = ACCESS_ONCE(dentry->d_parent);
671 gotref = lockref_get_not_zero(&ret->d_lockref);
672 rcu_read_unlock();
673 if (likely(gotref)) {
674 if (likely(ret == ACCESS_ONCE(dentry->d_parent)))
675 return ret;
676 dput(ret);
677 }
678
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100679repeat:
Nick Piggina734eb42011-01-07 17:49:44 +1100680 /*
681 * Don't need rcu_dereference because we re-check it was correct under
682 * the lock.
683 */
684 rcu_read_lock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100685 ret = dentry->d_parent;
Nick Piggina734eb42011-01-07 17:49:44 +1100686 spin_lock(&ret->d_lock);
687 if (unlikely(ret != dentry->d_parent)) {
688 spin_unlock(&ret->d_lock);
689 rcu_read_unlock();
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100690 goto repeat;
691 }
Nick Piggina734eb42011-01-07 17:49:44 +1100692 rcu_read_unlock();
Waiman Long98474232013-08-28 18:24:59 -0700693 BUG_ON(!ret->d_lockref.count);
694 ret->d_lockref.count++;
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100695 spin_unlock(&ret->d_lock);
Nick Pigginb7ab39f2011-01-07 17:49:32 +1100696 return ret;
697}
698EXPORT_SYMBOL(dget_parent);
699
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700/**
701 * d_find_alias - grab a hashed alias of inode
702 * @inode: inode in question
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700703 * @want_discon: flag, used by d_splice_alias, to request
704 * that only a DISCONNECTED alias be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 *
706 * If inode has a hashed alias, or is a directory and has any alias,
707 * acquire the reference to alias and return it. Otherwise return NULL.
708 * Notice that if inode is a directory there can be only one alias and
709 * it can be unhashed only if it has no children, or if it is the root
710 * of a filesystem.
711 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700712 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700713 * any other hashed alias over that one unless @want_discon is set,
714 * in which case only return an IS_ROOT, DCACHE_DISCONNECTED alias.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 */
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700716static struct dentry *__d_find_alias(struct inode *inode, int want_discon)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717{
Nick Pigginda502952011-01-07 17:49:33 +1100718 struct dentry *alias, *discon_alias;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
Nick Pigginda502952011-01-07 17:49:33 +1100720again:
721 discon_alias = NULL;
Sasha Levinb67bfe02013-02-27 17:06:00 -0800722 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Pigginda502952011-01-07 17:49:33 +1100723 spin_lock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700725 if (IS_ROOT(alias) &&
Nick Pigginda502952011-01-07 17:49:33 +1100726 (alias->d_flags & DCACHE_DISCONNECTED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 discon_alias = alias;
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700728 } else if (!want_discon) {
Nick Piggindc0474b2011-01-07 17:49:43 +1100729 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100730 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 return alias;
732 }
733 }
Nick Pigginda502952011-01-07 17:49:33 +1100734 spin_unlock(&alias->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 }
Nick Pigginda502952011-01-07 17:49:33 +1100736 if (discon_alias) {
737 alias = discon_alias;
738 spin_lock(&alias->d_lock);
739 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
740 if (IS_ROOT(alias) &&
741 (alias->d_flags & DCACHE_DISCONNECTED)) {
Nick Piggindc0474b2011-01-07 17:49:43 +1100742 __dget_dlock(alias);
Nick Pigginda502952011-01-07 17:49:33 +1100743 spin_unlock(&alias->d_lock);
744 return alias;
745 }
746 }
747 spin_unlock(&alias->d_lock);
748 goto again;
749 }
750 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751}
752
Nick Pigginda502952011-01-07 17:49:33 +1100753struct dentry *d_find_alias(struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754{
David Howells214fda12006-03-25 03:06:36 -0800755 struct dentry *de = NULL;
756
Al Virob3d9b7a2012-06-09 13:51:19 -0400757 if (!hlist_empty(&inode->i_dentry)) {
Nick Piggin873feea2011-01-07 17:50:06 +1100758 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -0700759 de = __d_find_alias(inode, 0);
Nick Piggin873feea2011-01-07 17:50:06 +1100760 spin_unlock(&inode->i_lock);
David Howells214fda12006-03-25 03:06:36 -0800761 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 return de;
763}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700764EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765
766/*
767 * Try to kill dentries associated with this inode.
768 * WARNING: you must own a reference to inode.
769 */
770void d_prune_aliases(struct inode *inode)
771{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700772 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773restart:
Nick Piggin873feea2011-01-07 17:50:06 +1100774 spin_lock(&inode->i_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -0800775 hlist_for_each_entry(dentry, &inode->i_dentry, d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 spin_lock(&dentry->d_lock);
Waiman Long98474232013-08-28 18:24:59 -0700777 if (!dentry->d_lockref.count) {
Yan, Zheng590fb512013-08-13 15:42:02 +0800778 /*
779 * inform the fs via d_prune that this dentry
780 * is about to be unhashed and destroyed.
781 */
782 if ((dentry->d_flags & DCACHE_OP_PRUNE) &&
783 !d_unhashed(dentry))
784 dentry->d_op->d_prune(dentry);
785
Nick Piggindc0474b2011-01-07 17:49:43 +1100786 __dget_dlock(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 __d_drop(dentry);
788 spin_unlock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +1100789 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 dput(dentry);
791 goto restart;
792 }
793 spin_unlock(&dentry->d_lock);
794 }
Nick Piggin873feea2011-01-07 17:50:06 +1100795 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700797EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400799static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800{
Al Viro5c47e6d2014-04-29 16:13:18 -0400801 struct dentry *dentry, *parent;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700802
Miklos Szeredi60942f22014-05-02 15:38:39 -0400803 while (!list_empty(list)) {
804 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100805 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000807 * The dispose list is isolated and dentries are not accounted
808 * to the LRU here, so we can simply remove it from the list
809 * here regardless of whether it is referenced or not.
810 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400811 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000812
813 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000815 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 */
Al Viro41edf272014-05-01 10:30:00 -0400817 if ((int)dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700818 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 continue;
820 }
Nick Piggin77812a12011-01-07 17:49:48 +1100821
Al Viro64fd72e2014-05-28 09:48:44 -0400822
823 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
824 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
825 spin_unlock(&dentry->d_lock);
826 if (can_free)
827 dentry_free(dentry);
828 continue;
829 }
830
Al Viro5c47e6d2014-04-29 16:13:18 -0400831 parent = dentry_kill(dentry, 0);
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400832 /*
Al Viro5c47e6d2014-04-29 16:13:18 -0400833 * If dentry_kill returns NULL, we have nothing more to do.
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400834 */
Miklos Szeredi60942f22014-05-02 15:38:39 -0400835 if (!parent)
Al Viro5c47e6d2014-04-29 16:13:18 -0400836 continue;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400837
Al Viro5c47e6d2014-04-29 16:13:18 -0400838 if (unlikely(parent == dentry)) {
839 /*
840 * trylocks have failed and d_lock has been held the
841 * whole time, so it could not have been added to any
842 * other lists. Just add it back to the shrink list.
843 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400844 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000845 spin_unlock(&dentry->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -0400846 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000847 }
Al Viro5c47e6d2014-04-29 16:13:18 -0400848 /*
849 * We need to prune ancestors too. This is necessary to prevent
850 * quadratic behavior of shrink_dcache_parent(), but is also
851 * expected to be beneficial in reducing dentry cache
852 * fragmentation.
853 */
854 dentry = parent;
855 while (dentry && !lockref_put_or_lock(&dentry->d_lockref))
856 dentry = dentry_kill(dentry, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400858}
859
Dave Chinnerf6041562013-08-28 10:18:00 +1000860static enum lru_status
861dentry_lru_isolate(struct list_head *item, spinlock_t *lru_lock, void *arg)
862{
863 struct list_head *freeable = arg;
864 struct dentry *dentry = container_of(item, struct dentry, d_lru);
865
866
867 /*
868 * we are inverting the lru lock/dentry->d_lock here,
869 * so use a trylock. If we fail to get the lock, just skip
870 * it
871 */
872 if (!spin_trylock(&dentry->d_lock))
873 return LRU_SKIP;
874
875 /*
876 * Referenced dentries are still in use. If they have active
877 * counts, just remove them from the LRU. Otherwise give them
878 * another pass through the LRU.
879 */
880 if (dentry->d_lockref.count) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400881 d_lru_isolate(dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +1000882 spin_unlock(&dentry->d_lock);
883 return LRU_REMOVED;
884 }
885
886 if (dentry->d_flags & DCACHE_REFERENCED) {
887 dentry->d_flags &= ~DCACHE_REFERENCED;
888 spin_unlock(&dentry->d_lock);
889
890 /*
891 * The list move itself will be made by the common LRU code. At
892 * this point, we've dropped the dentry->d_lock but keep the
893 * lru lock. This is safe to do, since every list movement is
894 * protected by the lru lock even if both locks are held.
895 *
896 * This is guaranteed by the fact that all LRU management
897 * functions are intermediated by the LRU API calls like
898 * list_lru_add and list_lru_del. List movement in this file
899 * only ever occur through this functions or through callbacks
900 * like this one, that are called from the LRU API.
901 *
902 * The only exceptions to this are functions like
903 * shrink_dentry_list, and code that first checks for the
904 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
905 * operating only with stack provided lists after they are
906 * properly isolated from the main list. It is thus, always a
907 * local access.
908 */
909 return LRU_ROTATE;
910 }
911
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400912 d_lru_shrink_move(dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +1000913 spin_unlock(&dentry->d_lock);
914
915 return LRU_REMOVED;
916}
917
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400918/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000919 * prune_dcache_sb - shrink the dcache
920 * @sb: superblock
Dave Chinnerf6041562013-08-28 10:18:00 +1000921 * @nr_to_scan : number of entries to try to free
Dave Chinner9b17c622013-08-28 10:18:05 +1000922 * @nid: which node to scan for freeable entities
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400923 *
Dave Chinnerf6041562013-08-28 10:18:00 +1000924 * Attempt to shrink the superblock dcache LRU by @nr_to_scan entries. This is
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000925 * done when we need more memory an called from the superblock shrinker
926 * function.
927 *
928 * This function may fail to free any resources if all the dentries are in
929 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400930 */
Dave Chinner9b17c622013-08-28 10:18:05 +1000931long prune_dcache_sb(struct super_block *sb, unsigned long nr_to_scan,
932 int nid)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400933{
Dave Chinnerf6041562013-08-28 10:18:00 +1000934 LIST_HEAD(dispose);
935 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400936
Dave Chinner9b17c622013-08-28 10:18:05 +1000937 freed = list_lru_walk_node(&sb->s_dentry_lru, nid, dentry_lru_isolate,
938 &dispose, &nr_to_scan);
Dave Chinnerf6041562013-08-28 10:18:00 +1000939 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +1000940 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941}
942
Glauber Costa4e717f52013-08-28 10:18:03 +1000943static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
944 spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000945{
Glauber Costa4e717f52013-08-28 10:18:03 +1000946 struct list_head *freeable = arg;
947 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000948
Glauber Costa4e717f52013-08-28 10:18:03 +1000949 /*
950 * we are inverting the lru lock/dentry->d_lock here,
951 * so use a trylock. If we fail to get the lock, just skip
952 * it
953 */
954 if (!spin_trylock(&dentry->d_lock))
955 return LRU_SKIP;
956
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400957 d_lru_shrink_move(dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +1000958 spin_unlock(&dentry->d_lock);
959
960 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000961}
962
Glauber Costa4e717f52013-08-28 10:18:03 +1000963
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700964/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 * shrink_dcache_sb - shrink dcache for a superblock
966 * @sb: superblock
967 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400968 * Shrink the dcache for the specified super block. This is used to free
969 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400971void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972{
Glauber Costa4e717f52013-08-28 10:18:03 +1000973 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400974
Glauber Costa4e717f52013-08-28 10:18:03 +1000975 do {
976 LIST_HEAD(dispose);
977
978 freed = list_lru_walk(&sb->s_dentry_lru,
979 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
980
981 this_cpu_sub(nr_dentry_unused, freed);
982 shrink_dentry_list(&dispose);
983 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700985EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +0200988 * enum d_walk_ret - action to talke during tree walk
989 * @D_WALK_CONTINUE: contrinue walk
990 * @D_WALK_QUIT: quit walk
991 * @D_WALK_NORETRY: quit when retry is needed
992 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +0200994enum d_walk_ret {
995 D_WALK_CONTINUE,
996 D_WALK_QUIT,
997 D_WALK_NORETRY,
998 D_WALK_SKIP,
999};
1000
1001/**
1002 * d_walk - walk the dentry tree
1003 * @parent: start of walk
1004 * @data: data passed to @enter() and @finish()
1005 * @enter: callback when first entering the dentry
1006 * @finish: callback when successfully finished the walk
1007 *
1008 * The @enter() and @finish() callbacks are called with d_lock held.
1009 */
1010static void d_walk(struct dentry *parent, void *data,
1011 enum d_walk_ret (*enter)(void *, struct dentry *),
1012 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013{
Nick Piggin949854d2011-01-07 17:49:37 +11001014 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001016 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001017 enum d_walk_ret ret;
1018 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001019
Nick Piggin58db63d2011-01-07 17:49:39 +11001020again:
Al Viro48f5ec22013-09-09 15:22:25 -04001021 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001022 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001023 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001024
1025 ret = enter(data, this_parent);
1026 switch (ret) {
1027 case D_WALK_CONTINUE:
1028 break;
1029 case D_WALK_QUIT:
1030 case D_WALK_SKIP:
1031 goto out_unlock;
1032 case D_WALK_NORETRY:
1033 retry = false;
1034 break;
1035 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036repeat:
1037 next = this_parent->d_subdirs.next;
1038resume:
1039 while (next != &this_parent->d_subdirs) {
1040 struct list_head *tmp = next;
Eric Dumazet5160ee62006-01-08 01:03:32 -08001041 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001043
1044 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001045
1046 ret = enter(data, dentry);
1047 switch (ret) {
1048 case D_WALK_CONTINUE:
1049 break;
1050 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001051 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001052 goto out_unlock;
1053 case D_WALK_NORETRY:
1054 retry = false;
1055 break;
1056 case D_WALK_SKIP:
1057 spin_unlock(&dentry->d_lock);
1058 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001059 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001060
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001062 spin_unlock(&this_parent->d_lock);
1063 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001065 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 goto repeat;
1067 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001068 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 }
1070 /*
1071 * All done at this level ... ascend and resume the search.
1072 */
1073 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001074 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001075 this_parent = child->d_parent;
1076
1077 rcu_read_lock();
1078 spin_unlock(&child->d_lock);
1079 spin_lock(&this_parent->d_lock);
1080
1081 /*
1082 * might go back up the wrong parent if we have had a rename
1083 * or deletion
1084 */
1085 if (this_parent != child->d_parent ||
1086 (child->d_flags & DCACHE_DENTRY_KILLED) ||
1087 need_seqretry(&rename_lock, seq)) {
1088 spin_unlock(&this_parent->d_lock);
1089 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11001090 goto rename_retry;
Al Viro31dec132013-10-25 17:04:27 -04001091 }
1092 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11001093 next = child->d_u.d_child.next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 goto resume;
1095 }
Al Viro48f5ec22013-09-09 15:22:25 -04001096 if (need_seqretry(&rename_lock, seq)) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001097 spin_unlock(&this_parent->d_lock);
1098 goto rename_retry;
1099 }
1100 if (finish)
1101 finish(data);
1102
1103out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001104 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001105 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001106 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001107
1108rename_retry:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001109 if (!retry)
1110 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001111 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001112 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001114
1115/*
1116 * Search for at least 1 mount point in the dentry's subdirs.
1117 * We descend to the next level whenever the d_subdirs
1118 * list is non-empty and continue searching.
1119 */
1120
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001121static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1122{
1123 int *ret = data;
1124 if (d_mountpoint(dentry)) {
1125 *ret = 1;
1126 return D_WALK_QUIT;
1127 }
1128 return D_WALK_CONTINUE;
1129}
1130
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001131/**
1132 * have_submounts - check for mounts over a dentry
1133 * @parent: dentry to check.
1134 *
1135 * Return true if the parent or its subdirectories contain
1136 * a mount point
1137 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001138int have_submounts(struct dentry *parent)
1139{
1140 int ret = 0;
1141
1142 d_walk(parent, &ret, check_mount, NULL);
1143
1144 return ret;
1145}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001146EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147
1148/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001149 * Called by mount code to set a mountpoint and check if the mountpoint is
1150 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1151 * subtree can become unreachable).
1152 *
1153 * Only one of check_submounts_and_drop() and d_set_mounted() must succeed. For
1154 * this reason take rename_lock and d_lock on dentry and ancestors.
1155 */
1156int d_set_mounted(struct dentry *dentry)
1157{
1158 struct dentry *p;
1159 int ret = -ENOENT;
1160 write_seqlock(&rename_lock);
1161 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
1162 /* Need exclusion wrt. check_submounts_and_drop() */
1163 spin_lock(&p->d_lock);
1164 if (unlikely(d_unhashed(p))) {
1165 spin_unlock(&p->d_lock);
1166 goto out;
1167 }
1168 spin_unlock(&p->d_lock);
1169 }
1170 spin_lock(&dentry->d_lock);
1171 if (!d_unlinked(dentry)) {
1172 dentry->d_flags |= DCACHE_MOUNTED;
1173 ret = 0;
1174 }
1175 spin_unlock(&dentry->d_lock);
1176out:
1177 write_sequnlock(&rename_lock);
1178 return ret;
1179}
1180
1181/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001182 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 * and move any unused dentries to the end of the unused
1184 * list for prune_dcache(). We descend to the next level
1185 * whenever the d_subdirs list is non-empty and continue
1186 * searching.
1187 *
1188 * It returns zero iff there are no unused children,
1189 * otherwise it returns the number of children moved to
1190 * the end of the unused list. This may not be the total
1191 * number of unused children, because select_parent can
1192 * drop the lock and return early due to latency
1193 * constraints.
1194 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001195
1196struct select_data {
1197 struct dentry *start;
1198 struct list_head dispose;
1199 int found;
1200};
1201
1202static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001204 struct select_data *data = _data;
1205 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001207 if (data->start == dentry)
1208 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209
Al Virofe915222014-05-03 00:02:25 -04001210 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001211 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001212 } else {
1213 if (dentry->d_flags & DCACHE_LRU_LIST)
1214 d_lru_del(dentry);
1215 if (!dentry->d_lockref.count) {
1216 d_shrink_add(dentry, &data->dispose);
1217 data->found++;
1218 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 }
1220 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001221 * We can return to the caller if we have found some (this
1222 * ensures forward progress). We'll be coming back to find
1223 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 */
Al Virofe915222014-05-03 00:02:25 -04001225 if (!list_empty(&data->dispose))
1226 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001228 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229}
1230
1231/**
1232 * shrink_dcache_parent - prune dcache
1233 * @parent: parent of entries to prune
1234 *
1235 * Prune the dcache to remove unused children of the parent dentry.
1236 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001237void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001239 for (;;) {
1240 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001242 INIT_LIST_HEAD(&data.dispose);
1243 data.start = parent;
1244 data.found = 0;
1245
1246 d_walk(parent, &data, select_collect, NULL);
1247 if (!data.found)
1248 break;
1249
1250 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001251 cond_resched();
1252 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001254EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255
Al Viro9c8c10e2014-05-02 20:36:10 -04001256static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001257{
Al Viro9c8c10e2014-05-02 20:36:10 -04001258 /* it has busy descendents; complain about those instead */
1259 if (!list_empty(&dentry->d_subdirs))
1260 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001261
Al Viro9c8c10e2014-05-02 20:36:10 -04001262 /* root with refcount 1 is fine */
1263 if (dentry == _data && dentry->d_lockref.count == 1)
1264 return D_WALK_CONTINUE;
1265
1266 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1267 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001268 dentry,
1269 dentry->d_inode ?
1270 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001271 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001272 dentry->d_lockref.count,
1273 dentry->d_sb->s_type->name,
1274 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001275 WARN_ON(1);
1276 return D_WALK_CONTINUE;
1277}
1278
1279static void do_one_tree(struct dentry *dentry)
1280{
1281 shrink_dcache_parent(dentry);
1282 d_walk(dentry, dentry, umount_check, NULL);
1283 d_drop(dentry);
1284 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001285}
1286
1287/*
1288 * destroy the dentries attached to a superblock on unmounting
1289 */
1290void shrink_dcache_for_umount(struct super_block *sb)
1291{
1292 struct dentry *dentry;
1293
Al Viro9c8c10e2014-05-02 20:36:10 -04001294 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001295
1296 dentry = sb->s_root;
1297 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001298 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001299
1300 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001301 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1302 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001303 }
1304}
1305
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001306static enum d_walk_ret check_and_collect(void *_data, struct dentry *dentry)
1307{
1308 struct select_data *data = _data;
1309
1310 if (d_mountpoint(dentry)) {
1311 data->found = -EBUSY;
1312 return D_WALK_QUIT;
1313 }
1314
1315 return select_collect(_data, dentry);
1316}
1317
1318static void check_and_drop(void *_data)
1319{
1320 struct select_data *data = _data;
1321
1322 if (d_mountpoint(data->start))
1323 data->found = -EBUSY;
1324 if (!data->found)
1325 __d_drop(data->start);
1326}
1327
1328/**
1329 * check_submounts_and_drop - prune dcache, check for submounts and drop
1330 *
1331 * All done as a single atomic operation relative to has_unlinked_ancestor().
1332 * Returns 0 if successfully unhashed @parent. If there were submounts then
1333 * return -EBUSY.
1334 *
1335 * @dentry: dentry to prune and drop
1336 */
1337int check_submounts_and_drop(struct dentry *dentry)
1338{
1339 int ret = 0;
1340
1341 /* Negative dentries can be dropped without further checks */
1342 if (!dentry->d_inode) {
1343 d_drop(dentry);
1344 goto out;
1345 }
1346
1347 for (;;) {
1348 struct select_data data;
1349
1350 INIT_LIST_HEAD(&data.dispose);
1351 data.start = dentry;
1352 data.found = 0;
1353
1354 d_walk(dentry, &data, check_and_collect, check_and_drop);
1355 ret = data.found;
1356
1357 if (!list_empty(&data.dispose))
1358 shrink_dentry_list(&data.dispose);
1359
1360 if (ret <= 0)
1361 break;
1362
1363 cond_resched();
1364 }
1365
1366out:
1367 return ret;
1368}
1369EXPORT_SYMBOL(check_submounts_and_drop);
1370
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371/**
Al Viroa4464db2011-07-07 15:03:58 -04001372 * __d_alloc - allocate a dcache entry
1373 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 * @name: qstr of the name
1375 *
1376 * Allocates a dentry. It returns %NULL if there is insufficient memory
1377 * available. On a success the dentry is returned. The name passed in is
1378 * copied and the copy passed in may be reused after this call.
1379 */
1380
Al Viroa4464db2011-07-07 15:03:58 -04001381struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382{
1383 struct dentry *dentry;
1384 char *dname;
1385
Mel Gormane12ba742007-10-16 01:25:52 -07001386 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 if (!dentry)
1388 return NULL;
1389
Linus Torvalds6326c712012-05-21 16:14:04 -07001390 /*
1391 * We guarantee that the inline name is always NUL-terminated.
1392 * This way the memcpy() done by the name switching in rename
1393 * will still always have a NUL at the end, even if we might
1394 * be overwriting an internal NUL character
1395 */
1396 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 if (name->len > DNAME_INLINE_LEN-1) {
1398 dname = kmalloc(name->len + 1, GFP_KERNEL);
1399 if (!dname) {
1400 kmem_cache_free(dentry_cache, dentry);
1401 return NULL;
1402 }
1403 } else {
1404 dname = dentry->d_iname;
1405 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406
1407 dentry->d_name.len = name->len;
1408 dentry->d_name.hash = name->hash;
1409 memcpy(dname, name->name, name->len);
1410 dname[name->len] = 0;
1411
Linus Torvalds6326c712012-05-21 16:14:04 -07001412 /* Make sure we always see the terminating NUL character */
1413 smp_wmb();
1414 dentry->d_name.name = dname;
1415
Waiman Long98474232013-08-28 18:24:59 -07001416 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001417 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001419 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001421 dentry->d_parent = dentry;
1422 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 dentry->d_op = NULL;
1424 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001425 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 INIT_LIST_HEAD(&dentry->d_lru);
1427 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Virob3d9b7a2012-06-09 13:51:19 -04001428 INIT_HLIST_NODE(&dentry->d_alias);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001429 INIT_LIST_HEAD(&dentry->d_u.d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001430 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431
Nick Piggin3e880fb2011-01-07 17:49:19 +11001432 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001433
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 return dentry;
1435}
Al Viroa4464db2011-07-07 15:03:58 -04001436
1437/**
1438 * d_alloc - allocate a dcache entry
1439 * @parent: parent of entry to allocate
1440 * @name: qstr of the name
1441 *
1442 * Allocates a dentry. It returns %NULL if there is insufficient memory
1443 * available. On a success the dentry is returned. The name passed in is
1444 * copied and the copy passed in may be reused after this call.
1445 */
1446struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1447{
1448 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1449 if (!dentry)
1450 return NULL;
1451
1452 spin_lock(&parent->d_lock);
1453 /*
1454 * don't need child lock because it is not subject
1455 * to concurrency here
1456 */
1457 __dget_dlock(parent);
1458 dentry->d_parent = parent;
1459 list_add(&dentry->d_u.d_child, &parent->d_subdirs);
1460 spin_unlock(&parent->d_lock);
1461
1462 return dentry;
1463}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001464EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001466/**
1467 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1468 * @sb: the superblock
1469 * @name: qstr of the name
1470 *
1471 * For a filesystem that just pins its dentries in memory and never
1472 * performs lookups at all, return an unhashed IS_ROOT dentry.
1473 */
Nick Piggin4b936882011-01-07 17:50:07 +11001474struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1475{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001476 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001477}
1478EXPORT_SYMBOL(d_alloc_pseudo);
1479
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1481{
1482 struct qstr q;
1483
1484 q.name = name;
1485 q.len = strlen(name);
1486 q.hash = full_name_hash(q.name, q.len);
1487 return d_alloc(parent, &q);
1488}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001489EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490
Nick Pigginfb045ad2011-01-07 17:49:55 +11001491void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1492{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001493 WARN_ON_ONCE(dentry->d_op);
1494 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001495 DCACHE_OP_COMPARE |
1496 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001497 DCACHE_OP_WEAK_REVALIDATE |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001498 DCACHE_OP_DELETE ));
1499 dentry->d_op = op;
1500 if (!op)
1501 return;
1502 if (op->d_hash)
1503 dentry->d_flags |= DCACHE_OP_HASH;
1504 if (op->d_compare)
1505 dentry->d_flags |= DCACHE_OP_COMPARE;
1506 if (op->d_revalidate)
1507 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001508 if (op->d_weak_revalidate)
1509 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001510 if (op->d_delete)
1511 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001512 if (op->d_prune)
1513 dentry->d_flags |= DCACHE_OP_PRUNE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001514
1515}
1516EXPORT_SYMBOL(d_set_d_op);
1517
David Howellsb18825a2013-09-12 19:22:53 +01001518static unsigned d_flags_for_inode(struct inode *inode)
1519{
1520 unsigned add_flags = DCACHE_FILE_TYPE;
1521
1522 if (!inode)
1523 return DCACHE_MISS_TYPE;
1524
1525 if (S_ISDIR(inode->i_mode)) {
1526 add_flags = DCACHE_DIRECTORY_TYPE;
1527 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1528 if (unlikely(!inode->i_op->lookup))
1529 add_flags = DCACHE_AUTODIR_TYPE;
1530 else
1531 inode->i_opflags |= IOP_LOOKUP;
1532 }
1533 } else if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
1534 if (unlikely(inode->i_op->follow_link))
1535 add_flags = DCACHE_SYMLINK_TYPE;
1536 else
1537 inode->i_opflags |= IOP_NOFOLLOW;
1538 }
1539
1540 if (unlikely(IS_AUTOMOUNT(inode)))
1541 add_flags |= DCACHE_NEED_AUTOMOUNT;
1542 return add_flags;
1543}
1544
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001545static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1546{
David Howellsb18825a2013-09-12 19:22:53 +01001547 unsigned add_flags = d_flags_for_inode(inode);
1548
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001549 spin_lock(&dentry->d_lock);
Al Viro22213312014-04-19 12:30:58 -04001550 __d_set_type(dentry, add_flags);
David Howellsb18825a2013-09-12 19:22:53 +01001551 if (inode)
Al Virob3d9b7a2012-06-09 13:51:19 -04001552 hlist_add_head(&dentry->d_alias, &inode->i_dentry);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001553 dentry->d_inode = inode;
Nick Piggin31e6b012011-01-07 17:49:52 +11001554 dentry_rcuwalk_barrier(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001555 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001556 fsnotify_d_instantiate(dentry, inode);
1557}
1558
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559/**
1560 * d_instantiate - fill in inode information for a dentry
1561 * @entry: dentry to complete
1562 * @inode: inode to attach to this dentry
1563 *
1564 * Fill in inode information in the entry.
1565 *
1566 * This turns negative dentries into productive full members
1567 * of society.
1568 *
1569 * NOTE! This assumes that the inode count has been incremented
1570 * (or otherwise set) by the caller to indicate that it is now
1571 * in use by the dcache.
1572 */
1573
1574void d_instantiate(struct dentry *entry, struct inode * inode)
1575{
Al Virob3d9b7a2012-06-09 13:51:19 -04001576 BUG_ON(!hlist_unhashed(&entry->d_alias));
Nick Piggin873feea2011-01-07 17:50:06 +11001577 if (inode)
1578 spin_lock(&inode->i_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001579 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001580 if (inode)
1581 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 security_d_instantiate(entry, inode);
1583}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001584EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585
1586/**
1587 * d_instantiate_unique - instantiate a non-aliased dentry
1588 * @entry: dentry to instantiate
1589 * @inode: inode to attach to this dentry
1590 *
1591 * Fill in inode information in the entry. On success, it returns NULL.
1592 * If an unhashed alias of "entry" already exists, then we return the
Oleg Drokine866cfa2006-01-09 20:52:51 -08001593 * aliased dentry instead and drop one reference to inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 *
1595 * Note that in order to avoid conflicts with rename() etc, the caller
1596 * had better be holding the parent directory semaphore.
Oleg Drokine866cfa2006-01-09 20:52:51 -08001597 *
1598 * This also assumes that the inode count has been incremented
1599 * (or otherwise set) by the caller to indicate that it is now
1600 * in use by the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 */
David Howells770bfad2006-08-22 20:06:07 -04001602static struct dentry *__d_instantiate_unique(struct dentry *entry,
1603 struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604{
1605 struct dentry *alias;
1606 int len = entry->d_name.len;
1607 const char *name = entry->d_name.name;
1608 unsigned int hash = entry->d_name.hash;
1609
David Howells770bfad2006-08-22 20:06:07 -04001610 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001611 __d_instantiate(entry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001612 return NULL;
1613 }
1614
Sasha Levinb67bfe02013-02-27 17:06:00 -08001615 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Piggin9abca362011-01-07 17:49:36 +11001616 /*
1617 * Don't need alias->d_lock here, because aliases with
1618 * d_parent == entry->d_parent are not subject to name or
1619 * parent changes, because the parent inode i_mutex is held.
1620 */
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001621 if (alias->d_name.hash != hash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 continue;
1623 if (alias->d_parent != entry->d_parent)
1624 continue;
Linus Torvaldsee983e82012-05-10 12:37:10 -07001625 if (alias->d_name.len != len)
1626 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001627 if (dentry_cmp(alias, name, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 continue;
Nick Piggindc0474b2011-01-07 17:49:43 +11001629 __dget(alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 return alias;
1631 }
David Howells770bfad2006-08-22 20:06:07 -04001632
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001633 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 return NULL;
1635}
David Howells770bfad2006-08-22 20:06:07 -04001636
1637struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1638{
1639 struct dentry *result;
1640
Al Virob3d9b7a2012-06-09 13:51:19 -04001641 BUG_ON(!hlist_unhashed(&entry->d_alias));
David Howells770bfad2006-08-22 20:06:07 -04001642
Nick Piggin873feea2011-01-07 17:50:06 +11001643 if (inode)
1644 spin_lock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001645 result = __d_instantiate_unique(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001646 if (inode)
1647 spin_unlock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001648
1649 if (!result) {
1650 security_d_instantiate(entry, inode);
1651 return NULL;
1652 }
1653
1654 BUG_ON(!d_unhashed(result));
1655 iput(inode);
1656 return result;
1657}
1658
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659EXPORT_SYMBOL(d_instantiate_unique);
1660
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001661/**
1662 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1663 * @entry: dentry to complete
1664 * @inode: inode to attach to this dentry
1665 *
1666 * Fill in inode information in the entry. If a directory alias is found, then
1667 * return an error (and drop inode). Together with d_materialise_unique() this
1668 * guarantees that a directory inode may never have more than one alias.
1669 */
1670int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1671{
1672 BUG_ON(!hlist_unhashed(&entry->d_alias));
1673
1674 spin_lock(&inode->i_lock);
1675 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1676 spin_unlock(&inode->i_lock);
1677 iput(inode);
1678 return -EBUSY;
1679 }
1680 __d_instantiate(entry, inode);
1681 spin_unlock(&inode->i_lock);
1682 security_d_instantiate(entry, inode);
1683
1684 return 0;
1685}
1686EXPORT_SYMBOL(d_instantiate_no_diralias);
1687
Al Viroadc0e912012-01-08 16:49:21 -05001688struct dentry *d_make_root(struct inode *root_inode)
1689{
1690 struct dentry *res = NULL;
1691
1692 if (root_inode) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07001693 static const struct qstr name = QSTR_INIT("/", 1);
Al Viroadc0e912012-01-08 16:49:21 -05001694
1695 res = __d_alloc(root_inode->i_sb, &name);
1696 if (res)
1697 d_instantiate(res, root_inode);
1698 else
1699 iput(root_inode);
1700 }
1701 return res;
1702}
1703EXPORT_SYMBOL(d_make_root);
1704
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001705static struct dentry * __d_find_any_alias(struct inode *inode)
1706{
1707 struct dentry *alias;
1708
Al Virob3d9b7a2012-06-09 13:51:19 -04001709 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001710 return NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001711 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001712 __dget(alias);
1713 return alias;
1714}
1715
Sage Weil46f72b32012-01-10 09:04:37 -08001716/**
1717 * d_find_any_alias - find any alias for a given inode
1718 * @inode: inode to find an alias for
1719 *
1720 * If any aliases exist for the given inode, take and return a
1721 * reference for one of them. If no aliases exist, return %NULL.
1722 */
1723struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001724{
1725 struct dentry *de;
1726
1727 spin_lock(&inode->i_lock);
1728 de = __d_find_any_alias(inode);
1729 spin_unlock(&inode->i_lock);
1730 return de;
1731}
Sage Weil46f72b32012-01-10 09:04:37 -08001732EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001733
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734/**
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001735 * d_obtain_alias - find or allocate a dentry for a given inode
1736 * @inode: inode to allocate the dentry for
1737 *
1738 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1739 * similar open by handle operations. The returned dentry may be anonymous,
1740 * or may have a full name (if the inode was already in the cache).
1741 *
1742 * When called on a directory inode, we must ensure that the inode only ever
1743 * has one dentry. If a dentry is found, that is returned instead of
1744 * allocating a new one.
1745 *
1746 * On successful return, the reference to the inode has been transferred
Christoph Hellwig44003722008-08-11 15:49:04 +02001747 * to the dentry. In case of an error the reference on the inode is released.
1748 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1749 * be passed in and will be the error will be propagate to the return value,
1750 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001751 */
1752struct dentry *d_obtain_alias(struct inode *inode)
1753{
NeilBrownb911a6b2012-11-08 16:09:37 -08001754 static const struct qstr anonstring = QSTR_INIT("/", 1);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001755 struct dentry *tmp;
1756 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001757 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001758
1759 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001760 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001761 if (IS_ERR(inode))
1762 return ERR_CAST(inode);
1763
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001764 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001765 if (res)
1766 goto out_iput;
1767
Al Viroa4464db2011-07-07 15:03:58 -04001768 tmp = __d_alloc(inode->i_sb, &anonstring);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001769 if (!tmp) {
1770 res = ERR_PTR(-ENOMEM);
1771 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001772 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001773
Nick Piggin873feea2011-01-07 17:50:06 +11001774 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001775 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001776 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001777 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001778 dput(tmp);
1779 goto out_iput;
1780 }
1781
1782 /* attach a disconnected dentry */
David Howellsb18825a2013-09-12 19:22:53 +01001783 add_flags = d_flags_for_inode(inode) | DCACHE_DISCONNECTED;
1784
Christoph Hellwig9308a612008-08-11 15:49:12 +02001785 spin_lock(&tmp->d_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001786 tmp->d_inode = inode;
David Howellsb18825a2013-09-12 19:22:53 +01001787 tmp->d_flags |= add_flags;
Al Virob3d9b7a2012-06-09 13:51:19 -04001788 hlist_add_head(&tmp->d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001789 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001790 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001791 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001792 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001793 spin_unlock(&inode->i_lock);
Josef Bacik24ff6662010-11-18 20:52:55 -05001794 security_d_instantiate(tmp, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001795
Christoph Hellwig9308a612008-08-11 15:49:12 +02001796 return tmp;
1797
1798 out_iput:
Josef Bacik24ff6662010-11-18 20:52:55 -05001799 if (res && !IS_ERR(res))
1800 security_d_instantiate(res, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001801 iput(inode);
1802 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001803}
Benny Halevyadc48722009-02-27 14:02:59 -08001804EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805
1806/**
1807 * d_splice_alias - splice a disconnected dentry into the tree if one exists
1808 * @inode: the inode which may have a disconnected dentry
1809 * @dentry: a negative dentry which we want to point to the inode.
1810 *
1811 * If inode is a directory and has a 'disconnected' dentry (i.e. IS_ROOT and
1812 * DCACHE_DISCONNECTED), then d_move that in place of the given dentry
1813 * and return it, else simply d_add the inode to the dentry and return NULL.
1814 *
1815 * This is needed in the lookup routine of any filesystem that is exportable
1816 * (via knfsd) so that we can build dcache paths to directories effectively.
1817 *
1818 * If a dentry was found and moved, then it is returned. Otherwise NULL
1819 * is returned. This matches the expected return value of ->lookup.
1820 *
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001821 * Cluster filesystems may call this function with a negative, hashed dentry.
1822 * In that case, we know that the inode will be a regular file, and also this
1823 * will only occur during atomic_open. So we need to check for the dentry
1824 * being already hashed only in the final case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825 */
1826struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
1827{
1828 struct dentry *new = NULL;
1829
Al Viroa9049372011-07-08 21:20:11 -04001830 if (IS_ERR(inode))
1831 return ERR_CAST(inode);
1832
NeilBrown21c0d8f2006-10-04 02:16:16 -07001833 if (inode && S_ISDIR(inode->i_mode)) {
Nick Piggin873feea2011-01-07 17:50:06 +11001834 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001835 new = __d_find_alias(inode, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 if (new) {
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001837 BUG_ON(!(new->d_flags & DCACHE_DISCONNECTED));
Nick Piggin873feea2011-01-07 17:50:06 +11001838 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839 security_d_instantiate(new, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 d_move(new, dentry);
1841 iput(inode);
1842 } else {
Nick Piggin873feea2011-01-07 17:50:06 +11001843 /* already taking inode->i_lock, so d_add() by hand */
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001844 __d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001845 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846 security_d_instantiate(dentry, inode);
1847 d_rehash(dentry);
1848 }
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001849 } else {
1850 d_instantiate(dentry, inode);
1851 if (d_unhashed(dentry))
1852 d_rehash(dentry);
1853 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854 return new;
1855}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001856EXPORT_SYMBOL(d_splice_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857
Barry Naujok94035402008-05-21 16:50:46 +10001858/**
1859 * d_add_ci - lookup or allocate new dentry with case-exact name
1860 * @inode: the inode case-insensitive lookup has found
1861 * @dentry: the negative dentry that was passed to the parent's lookup func
1862 * @name: the case-exact name to be associated with the returned dentry
1863 *
1864 * This is to avoid filling the dcache with case-insensitive names to the
1865 * same inode, only the actual correct case is stored in the dcache for
1866 * case-insensitive filesystems.
1867 *
1868 * For a case-insensitive lookup match and if the the case-exact dentry
1869 * already exists in in the dcache, use it and return it.
1870 *
1871 * If no entry exists with the exact case name, allocate new dentry with
1872 * the exact case, and return the spliced entry.
1873 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001874struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001875 struct qstr *name)
1876{
Barry Naujok94035402008-05-21 16:50:46 +10001877 struct dentry *found;
1878 struct dentry *new;
1879
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001880 /*
1881 * First check if a dentry matching the name already exists,
1882 * if not go ahead and create it now.
1883 */
Barry Naujok94035402008-05-21 16:50:46 +10001884 found = d_hash_and_lookup(dentry->d_parent, name);
Al Viro4f522a22013-02-11 23:20:37 -05001885 if (unlikely(IS_ERR(found)))
1886 goto err_out;
Barry Naujok94035402008-05-21 16:50:46 +10001887 if (!found) {
1888 new = d_alloc(dentry->d_parent, name);
1889 if (!new) {
Al Viro4f522a22013-02-11 23:20:37 -05001890 found = ERR_PTR(-ENOMEM);
Barry Naujok94035402008-05-21 16:50:46 +10001891 goto err_out;
1892 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001893
Barry Naujok94035402008-05-21 16:50:46 +10001894 found = d_splice_alias(inode, new);
1895 if (found) {
1896 dput(new);
1897 return found;
1898 }
1899 return new;
1900 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001901
1902 /*
1903 * If a matching dentry exists, and it's not negative use it.
1904 *
1905 * Decrement the reference count to balance the iget() done
1906 * earlier on.
1907 */
Barry Naujok94035402008-05-21 16:50:46 +10001908 if (found->d_inode) {
1909 if (unlikely(found->d_inode != inode)) {
1910 /* This can't happen because bad inodes are unhashed. */
1911 BUG_ON(!is_bad_inode(inode));
1912 BUG_ON(!is_bad_inode(found->d_inode));
1913 }
Barry Naujok94035402008-05-21 16:50:46 +10001914 iput(inode);
1915 return found;
1916 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001917
Barry Naujok94035402008-05-21 16:50:46 +10001918 /*
1919 * Negative dentry: instantiate it unless the inode is a directory and
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001920 * already has a dentry.
Barry Naujok94035402008-05-21 16:50:46 +10001921 */
Al Viro4513d892011-07-17 10:52:14 -04001922 new = d_splice_alias(inode, found);
1923 if (new) {
1924 dput(found);
1925 found = new;
Barry Naujok94035402008-05-21 16:50:46 +10001926 }
Al Viro4513d892011-07-17 10:52:14 -04001927 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001928
1929err_out:
1930 iput(inode);
Al Viro4f522a22013-02-11 23:20:37 -05001931 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001932}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001933EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001935/*
1936 * Do the slow-case of the dentry name compare.
1937 *
1938 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07001939 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001940 * filesystem can rely on them, and can use the 'name' and
1941 * 'len' information without worrying about walking off the
1942 * end of memory etc.
1943 *
1944 * Thus the read_seqcount_retry() and the "duplicate" info
1945 * in arguments (the low-level filesystem should not look
1946 * at the dentry inode or name contents directly, since
1947 * rename can change them while we're in RCU mode).
1948 */
1949enum slow_d_compare {
1950 D_COMP_OK,
1951 D_COMP_NOMATCH,
1952 D_COMP_SEQRETRY,
1953};
1954
1955static noinline enum slow_d_compare slow_dentry_cmp(
1956 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001957 struct dentry *dentry,
1958 unsigned int seq,
1959 const struct qstr *name)
1960{
1961 int tlen = dentry->d_name.len;
1962 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001963
1964 if (read_seqcount_retry(&dentry->d_seq, seq)) {
1965 cpu_relax();
1966 return D_COMP_SEQRETRY;
1967 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07001968 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001969 return D_COMP_NOMATCH;
1970 return D_COMP_OK;
1971}
1972
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973/**
Nick Piggin31e6b012011-01-07 17:49:52 +11001974 * __d_lookup_rcu - search for a dentry (racy, store-free)
1975 * @parent: parent dentry
1976 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07001977 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11001978 * Returns: dentry, or NULL
1979 *
1980 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
1981 * resolution (store-free path walking) design described in
1982 * Documentation/filesystems/path-lookup.txt.
1983 *
1984 * This is not to be used outside core vfs.
1985 *
1986 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
1987 * held, and rcu_read_lock held. The returned dentry must not be stored into
1988 * without taking d_lock and checking d_seq sequence count against @seq
1989 * returned here.
1990 *
Linus Torvalds15570082013-09-02 11:38:06 -07001991 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11001992 * function.
1993 *
1994 * Alternatively, __d_lookup_rcu may be called again to look up the child of
1995 * the returned dentry, so long as its parent's seqlock is checked after the
1996 * child is looked up. Thus, an interlocking stepping of sequence lock checks
1997 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001998 *
1999 * NOTE! The caller *has* to check the resulting dentry against the sequence
2000 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002001 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002002struct dentry *__d_lookup_rcu(const struct dentry *parent,
2003 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002004 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002005{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002006 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002007 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002008 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002009 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002010 struct dentry *dentry;
2011
2012 /*
2013 * Note: There is significant duplication with __d_lookup_rcu which is
2014 * required to prevent single threaded performance regressions
2015 * especially on architectures where smp_rmb (in seqcounts) are costly.
2016 * Keep the two functions in sync.
2017 */
2018
2019 /*
2020 * The hash list is protected using RCU.
2021 *
2022 * Carefully use d_seq when comparing a candidate dentry, to avoid
2023 * races with d_move().
2024 *
2025 * It is possible that concurrent renames can mess up our list
2026 * walk here and result in missing our dentry, resulting in the
2027 * false-negative result. d_lookup() protects against concurrent
2028 * renames using rename_lock seqlock.
2029 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002030 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002031 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002032 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002033 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002034
Nick Piggin31e6b012011-01-07 17:49:52 +11002035seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002036 /*
2037 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002038 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002039 *
2040 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002041 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002042 *
2043 * NOTE! We do a "raw" seqcount_begin here. That means that
2044 * we don't wait for the sequence count to stabilize if it
2045 * is in the middle of a sequence change. If we do the slow
2046 * dentry compare, we will do seqretries until it is stable,
2047 * and if we end up with a successful lookup, we actually
2048 * want to exit RCU lookup anyway.
2049 */
2050 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002051 if (dentry->d_parent != parent)
2052 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002053 if (d_unhashed(dentry))
2054 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002055
2056 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002057 if (dentry->d_name.hash != hashlen_hash(hashlen))
2058 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002059 *seqp = seq;
2060 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002061 case D_COMP_OK:
2062 return dentry;
2063 case D_COMP_NOMATCH:
2064 continue;
2065 default:
2066 goto seqretry;
2067 }
2068 }
2069
Linus Torvalds26fe5752012-05-10 13:14:12 -07002070 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002071 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002072 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002073 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002074 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002075 }
2076 return NULL;
2077}
2078
2079/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 * d_lookup - search for a dentry
2081 * @parent: parent dentry
2082 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002083 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002085 * d_lookup searches the children of the parent dentry for the name in
2086 * question. If the dentry is found its reference count is incremented and the
2087 * dentry is returned. The caller must use dput to free the entry when it has
2088 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 */
Al Viroda2d8452013-01-24 18:29:34 -05002090struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091{
Nick Piggin31e6b012011-01-07 17:49:52 +11002092 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002093 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094
2095 do {
2096 seq = read_seqbegin(&rename_lock);
2097 dentry = __d_lookup(parent, name);
2098 if (dentry)
2099 break;
2100 } while (read_seqretry(&rename_lock, seq));
2101 return dentry;
2102}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002103EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104
Nick Piggin31e6b012011-01-07 17:49:52 +11002105/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002106 * __d_lookup - search for a dentry (racy)
2107 * @parent: parent dentry
2108 * @name: qstr of name we wish to find
2109 * Returns: dentry, or NULL
2110 *
2111 * __d_lookup is like d_lookup, however it may (rarely) return a
2112 * false-negative result due to unrelated rename activity.
2113 *
2114 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2115 * however it must be used carefully, eg. with a following d_lookup in
2116 * the case of failure.
2117 *
2118 * __d_lookup callers must be commented.
2119 */
Al Viroa713ca22013-01-24 18:27:00 -05002120struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121{
2122 unsigned int len = name->len;
2123 unsigned int hash = name->hash;
2124 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002125 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002126 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002127 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002128 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129
Nick Pigginb04f7842010-08-18 04:37:34 +10002130 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002131 * Note: There is significant duplication with __d_lookup_rcu which is
2132 * required to prevent single threaded performance regressions
2133 * especially on architectures where smp_rmb (in seqcounts) are costly.
2134 * Keep the two functions in sync.
2135 */
2136
2137 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002138 * The hash list is protected using RCU.
2139 *
2140 * Take d_lock when comparing a candidate dentry, to avoid races
2141 * with d_move().
2142 *
2143 * It is possible that concurrent renames can mess up our list
2144 * walk here and result in missing our dentry, resulting in the
2145 * false-negative result. d_lookup() protects against concurrent
2146 * renames using rename_lock seqlock.
2147 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002148 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002149 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 rcu_read_lock();
2151
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002152 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 if (dentry->d_name.hash != hash)
2155 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156
2157 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 if (dentry->d_parent != parent)
2159 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002160 if (d_unhashed(dentry))
2161 goto next;
2162
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163 /*
2164 * It is safe to compare names since d_move() cannot
2165 * change the qstr (protected by d_lock).
2166 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002167 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002168 int tlen = dentry->d_name.len;
2169 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002170 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 goto next;
2172 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002173 if (dentry->d_name.len != len)
2174 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002175 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176 goto next;
2177 }
2178
Waiman Long98474232013-08-28 18:24:59 -07002179 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002180 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 spin_unlock(&dentry->d_lock);
2182 break;
2183next:
2184 spin_unlock(&dentry->d_lock);
2185 }
2186 rcu_read_unlock();
2187
2188 return found;
2189}
2190
2191/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002192 * d_hash_and_lookup - hash the qstr then search for a dentry
2193 * @dir: Directory to search in
2194 * @name: qstr of name we wish to find
2195 *
Al Viro4f522a22013-02-11 23:20:37 -05002196 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002197 */
2198struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2199{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002200 /*
2201 * Check for a fs-specific hash function. Note that we must
2202 * calculate the standard hash first, as the d_op->d_hash()
2203 * routine may choose to leave the hash value unchanged.
2204 */
2205 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002206 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002207 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002208 if (unlikely(err < 0))
2209 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002210 }
Al Viro4f522a22013-02-11 23:20:37 -05002211 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002212}
Al Viro4f522a22013-02-11 23:20:37 -05002213EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002214
2215/**
Nick Piggin786a5e12011-01-07 17:49:16 +11002216 * d_validate - verify dentry provided from insecure source (deprecated)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 * @dentry: The dentry alleged to be valid child of @dparent
Randy Dunlapff5fdb62011-01-22 20:16:06 -08002218 * @dparent: The parent dentry (known to be valid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219 *
2220 * An insecure source has sent us a dentry, here we verify it and dget() it.
2221 * This is used by ncpfs in its readdir implementation.
2222 * Zero is returned in the dentry is invalid.
Nick Piggin786a5e12011-01-07 17:49:16 +11002223 *
2224 * This function is slow for big directories, and deprecated, do not use it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225 */
Nick Piggind3a23e12011-01-05 20:01:21 +11002226int d_validate(struct dentry *dentry, struct dentry *dparent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227{
Nick Piggin786a5e12011-01-07 17:49:16 +11002228 struct dentry *child;
Nick Piggind3a23e12011-01-05 20:01:21 +11002229
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002230 spin_lock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002231 list_for_each_entry(child, &dparent->d_subdirs, d_u.d_child) {
2232 if (dentry == child) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002233 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Nick Piggindc0474b2011-01-07 17:49:43 +11002234 __dget_dlock(dentry);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002235 spin_unlock(&dentry->d_lock);
2236 spin_unlock(&dparent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237 return 1;
2238 }
2239 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002240 spin_unlock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002241
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 return 0;
2243}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002244EXPORT_SYMBOL(d_validate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245
2246/*
2247 * When a file is deleted, we have two options:
2248 * - turn this dentry into a negative dentry
2249 * - unhash this dentry and free it.
2250 *
2251 * Usually, we want to just turn this into
2252 * a negative dentry, but if anybody else is
2253 * currently using the dentry or the inode
2254 * we can't do that and we fall back on removing
2255 * it from the hash queues and waiting for
2256 * it to be deleted later when it has no users
2257 */
2258
2259/**
2260 * d_delete - delete a dentry
2261 * @dentry: The dentry to delete
2262 *
2263 * Turn the dentry into a negative dentry if possible, otherwise
2264 * remove it from the hash queues so it can be deleted later
2265 */
2266
2267void d_delete(struct dentry * dentry)
2268{
Nick Piggin873feea2011-01-07 17:50:06 +11002269 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002270 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271 /*
2272 * Are we the only user?
2273 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002274again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002276 inode = dentry->d_inode;
2277 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002278 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002279 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002280 spin_unlock(&dentry->d_lock);
2281 cpu_relax();
2282 goto again;
2283 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002284 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002285 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002286 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 return;
2288 }
2289
2290 if (!d_unhashed(dentry))
2291 __d_drop(dentry);
2292
2293 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002294
2295 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002297EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002299static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002301 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002302 hlist_bl_lock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -07002303 entry->d_flags |= DCACHE_RCUACCESS;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002304 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002305 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306}
2307
David Howells770bfad2006-08-22 20:06:07 -04002308static void _d_rehash(struct dentry * entry)
2309{
2310 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2311}
2312
Linus Torvalds1da177e2005-04-16 15:20:36 -07002313/**
2314 * d_rehash - add an entry back to the hash
2315 * @entry: dentry to add to the hash
2316 *
2317 * Adds a dentry to the hash according to its name.
2318 */
2319
2320void d_rehash(struct dentry * entry)
2321{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002323 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002326EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002328/**
2329 * dentry_update_name_case - update case insensitive dentry with a new name
2330 * @dentry: dentry to be updated
2331 * @name: new name
2332 *
2333 * Update a case insensitive dentry with new case of name.
2334 *
2335 * dentry must have been returned by d_lookup with name @name. Old and new
2336 * name lengths must match (ie. no d_compare which allows mismatched name
2337 * lengths).
2338 *
2339 * Parent inode i_mutex must be held over d_lookup and into this call (to
2340 * keep renames and concurrent inserts, and readdir(2) away).
2341 */
2342void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2343{
Linus Torvalds7ebfa572011-04-15 07:34:26 -07002344 BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002345 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2346
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002347 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002348 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002349 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002350 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002351 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002352}
2353EXPORT_SYMBOL(dentry_update_name_case);
2354
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355static void switch_names(struct dentry *dentry, struct dentry *target)
2356{
2357 if (dname_external(target)) {
2358 if (dname_external(dentry)) {
2359 /*
2360 * Both external: swap the pointers
2361 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002362 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363 } else {
2364 /*
2365 * dentry:internal, target:external. Steal target's
2366 * storage and make target internal.
2367 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002368 memcpy(target->d_iname, dentry->d_name.name,
2369 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370 dentry->d_name.name = target->d_name.name;
2371 target->d_name.name = target->d_iname;
2372 }
2373 } else {
2374 if (dname_external(dentry)) {
2375 /*
2376 * dentry:external, target:internal. Give dentry's
2377 * storage to target and make dentry internal
2378 */
2379 memcpy(dentry->d_iname, target->d_name.name,
2380 target->d_name.len + 1);
2381 target->d_name.name = dentry->d_name.name;
2382 dentry->d_name.name = dentry->d_iname;
2383 } else {
2384 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002385 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002387 unsigned int i;
2388 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2389 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2390 swap(((long *) &dentry->d_iname)[i],
2391 ((long *) &target->d_iname)[i]);
2392 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393 }
2394 }
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002395 swap(dentry->d_name.len, target->d_name.len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396}
2397
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002398static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2399{
2400 /*
2401 * XXXX: do we really need to take target->d_lock?
2402 */
2403 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2404 spin_lock(&target->d_parent->d_lock);
2405 else {
2406 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2407 spin_lock(&dentry->d_parent->d_lock);
2408 spin_lock_nested(&target->d_parent->d_lock,
2409 DENTRY_D_LOCK_NESTED);
2410 } else {
2411 spin_lock(&target->d_parent->d_lock);
2412 spin_lock_nested(&dentry->d_parent->d_lock,
2413 DENTRY_D_LOCK_NESTED);
2414 }
2415 }
2416 if (target < dentry) {
2417 spin_lock_nested(&target->d_lock, 2);
2418 spin_lock_nested(&dentry->d_lock, 3);
2419 } else {
2420 spin_lock_nested(&dentry->d_lock, 2);
2421 spin_lock_nested(&target->d_lock, 3);
2422 }
2423}
2424
2425static void dentry_unlock_parents_for_move(struct dentry *dentry,
2426 struct dentry *target)
2427{
2428 if (target->d_parent != dentry->d_parent)
2429 spin_unlock(&dentry->d_parent->d_lock);
2430 if (target->d_parent != target)
2431 spin_unlock(&target->d_parent->d_lock);
2432}
2433
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002435 * When switching names, the actual string doesn't strictly have to
2436 * be preserved in the target - because we're dropping the target
2437 * anyway. As such, we can just do a simple memcpy() to copy over
2438 * the new name before we switch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439 *
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002440 * Note that we have to be a lot more careful about getting the hash
2441 * switched - we have to switch the hash value properly even if it
2442 * then no longer matches the actual (corrupted) string of the target.
2443 * The hash value has to match the hash queue that the dentry is on..
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002445/*
Al Viro18367502011-07-12 21:42:24 -04002446 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 * @dentry: entry to move
2448 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002449 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450 *
2451 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002452 * dcache entries should not be moved in this way. Caller must hold
2453 * rename_lock, the i_mutex of the source and target directories,
2454 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002456static void __d_move(struct dentry *dentry, struct dentry *target,
2457 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002458{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459 if (!dentry->d_inode)
2460 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2461
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002462 BUG_ON(d_ancestor(dentry, target));
2463 BUG_ON(d_ancestor(target, dentry));
2464
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002465 dentry_lock_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002466
Nick Piggin31e6b012011-01-07 17:49:52 +11002467 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002468 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002469
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002470 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2471
2472 /*
2473 * Move the dentry to the target hash queue. Don't bother checking
2474 * for the same hash queue because of how unlikely it is.
2475 */
2476 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002477 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478
Miklos Szeredida1ce062014-04-01 17:08:43 +02002479 /*
2480 * Unhash the target (d_delete() is not usable here). If exchanging
2481 * the two dentries, then rehash onto the other's hash queue.
2482 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483 __d_drop(target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002484 if (exchange) {
2485 __d_rehash(target,
2486 d_hash(dentry->d_parent, dentry->d_name.hash));
2487 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488
Eric Dumazet5160ee62006-01-08 01:03:32 -08002489 list_del(&dentry->d_u.d_child);
2490 list_del(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491
2492 /* Switch the names.. */
2493 switch_names(dentry, target);
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002494 swap(dentry->d_name.hash, target->d_name.hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002495
2496 /* ... and switch the parents */
2497 if (IS_ROOT(dentry)) {
2498 dentry->d_parent = target->d_parent;
2499 target->d_parent = target;
Eric Dumazet5160ee62006-01-08 01:03:32 -08002500 INIT_LIST_HEAD(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501 } else {
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002502 swap(dentry->d_parent, target->d_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002503
2504 /* And add them back to the (new) parent lists */
Eric Dumazet5160ee62006-01-08 01:03:32 -08002505 list_add(&target->d_u.d_child, &target->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506 }
2507
Eric Dumazet5160ee62006-01-08 01:03:32 -08002508 list_add(&dentry->d_u.d_child, &dentry->d_parent->d_subdirs);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002509
Nick Piggin31e6b012011-01-07 17:49:52 +11002510 write_seqcount_end(&target->d_seq);
2511 write_seqcount_end(&dentry->d_seq);
2512
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002513 dentry_unlock_parents_for_move(dentry, target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002514 if (exchange)
2515 fsnotify_d_move(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002516 spin_unlock(&target->d_lock);
Nick Pigginc32ccd82006-03-25 03:07:09 -08002517 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002519}
2520
2521/*
2522 * d_move - move a dentry
2523 * @dentry: entry to move
2524 * @target: new dentry
2525 *
2526 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002527 * dcache entries should not be moved in this way. See the locking
2528 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002529 */
2530void d_move(struct dentry *dentry, struct dentry *target)
2531{
2532 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002533 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002535}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002536EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537
Miklos Szeredida1ce062014-04-01 17:08:43 +02002538/*
2539 * d_exchange - exchange two dentries
2540 * @dentry1: first dentry
2541 * @dentry2: second dentry
2542 */
2543void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2544{
2545 write_seqlock(&rename_lock);
2546
2547 WARN_ON(!dentry1->d_inode);
2548 WARN_ON(!dentry2->d_inode);
2549 WARN_ON(IS_ROOT(dentry1));
2550 WARN_ON(IS_ROOT(dentry2));
2551
2552 __d_move(dentry1, dentry2, true);
2553
2554 write_sequnlock(&rename_lock);
2555}
2556
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002557/**
2558 * d_ancestor - search for an ancestor
2559 * @p1: ancestor dentry
2560 * @p2: child dentry
2561 *
2562 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2563 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002564 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002565struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002566{
2567 struct dentry *p;
2568
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002569 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002570 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002571 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002572 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002573 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002574}
2575
2576/*
2577 * This helper attempts to cope with remotely renamed directories
2578 *
2579 * It assumes that the caller is already holding
Al Viro18367502011-07-12 21:42:24 -04002580 * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002581 *
2582 * Note: If ever the locking in lock_rename() changes, then please
2583 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002584 */
Nick Piggin873feea2011-01-07 17:50:06 +11002585static struct dentry *__d_unalias(struct inode *inode,
2586 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002587{
2588 struct mutex *m1 = NULL, *m2 = NULL;
Al Viroee3efa92012-06-08 15:59:33 -04002589 struct dentry *ret = ERR_PTR(-EBUSY);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002590
2591 /* If alias and dentry share a parent, then no extra locks required */
2592 if (alias->d_parent == dentry->d_parent)
2593 goto out_unalias;
2594
Trond Myklebust9eaef272006-10-21 10:24:20 -07002595 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002596 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2597 goto out_err;
2598 m1 = &dentry->d_sb->s_vfs_rename_mutex;
2599 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
2600 goto out_err;
2601 m2 = &alias->d_parent->d_inode->i_mutex;
2602out_unalias:
Al Viroee3efa92012-06-08 15:59:33 -04002603 if (likely(!d_mountpoint(alias))) {
Miklos Szeredida1ce062014-04-01 17:08:43 +02002604 __d_move(alias, dentry, false);
Al Viroee3efa92012-06-08 15:59:33 -04002605 ret = alias;
2606 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002607out_err:
Nick Piggin873feea2011-01-07 17:50:06 +11002608 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002609 if (m2)
2610 mutex_unlock(m2);
2611 if (m1)
2612 mutex_unlock(m1);
2613 return ret;
2614}
2615
2616/*
David Howells770bfad2006-08-22 20:06:07 -04002617 * Prepare an anonymous dentry for life in the superblock's dentry tree as a
2618 * named dentry in place of the dentry to be replaced.
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002619 * returns with anon->d_lock held!
David Howells770bfad2006-08-22 20:06:07 -04002620 */
2621static void __d_materialise_dentry(struct dentry *dentry, struct dentry *anon)
2622{
Al Viro740da422013-01-30 10:13:38 -05002623 struct dentry *dparent;
David Howells770bfad2006-08-22 20:06:07 -04002624
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002625 dentry_lock_for_move(anon, dentry);
David Howells770bfad2006-08-22 20:06:07 -04002626
Nick Piggin31e6b012011-01-07 17:49:52 +11002627 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002628 write_seqcount_begin_nested(&anon->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002629
David Howells770bfad2006-08-22 20:06:07 -04002630 dparent = dentry->d_parent;
David Howells770bfad2006-08-22 20:06:07 -04002631
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002632 switch_names(dentry, anon);
2633 swap(dentry->d_name.hash, anon->d_name.hash);
2634
Al Viro740da422013-01-30 10:13:38 -05002635 dentry->d_parent = dentry;
2636 list_del_init(&dentry->d_u.d_child);
2637 anon->d_parent = dparent;
Wei Yongjun9ed53b12013-03-12 00:10:50 +08002638 list_move(&anon->d_u.d_child, &dparent->d_subdirs);
David Howells770bfad2006-08-22 20:06:07 -04002639
Nick Piggin31e6b012011-01-07 17:49:52 +11002640 write_seqcount_end(&dentry->d_seq);
2641 write_seqcount_end(&anon->d_seq);
2642
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002643 dentry_unlock_parents_for_move(anon, dentry);
2644 spin_unlock(&dentry->d_lock);
2645
2646 /* anon->d_lock still locked, returns locked */
David Howells770bfad2006-08-22 20:06:07 -04002647}
2648
2649/**
2650 * d_materialise_unique - introduce an inode into the tree
2651 * @dentry: candidate dentry
2652 * @inode: inode to bind to the dentry, to which aliases may be attached
2653 *
2654 * Introduces an dentry into the tree, substituting an extant disconnected
Jeff Laytonc46c8872011-07-26 13:33:16 -04002655 * root directory alias in its place if there is one. Caller must hold the
2656 * i_mutex of the parent directory.
David Howells770bfad2006-08-22 20:06:07 -04002657 */
2658struct dentry *d_materialise_unique(struct dentry *dentry, struct inode *inode)
2659{
Trond Myklebust9eaef272006-10-21 10:24:20 -07002660 struct dentry *actual;
David Howells770bfad2006-08-22 20:06:07 -04002661
2662 BUG_ON(!d_unhashed(dentry));
2663
David Howells770bfad2006-08-22 20:06:07 -04002664 if (!inode) {
2665 actual = dentry;
OGAWA Hirofumi360da902008-10-16 07:50:28 +09002666 __d_instantiate(dentry, NULL);
Nick Piggin357f8e62011-01-07 17:49:42 +11002667 d_rehash(actual);
2668 goto out_nolock;
David Howells770bfad2006-08-22 20:06:07 -04002669 }
2670
Nick Piggin873feea2011-01-07 17:50:06 +11002671 spin_lock(&inode->i_lock);
Nick Piggin357f8e62011-01-07 17:49:42 +11002672
Trond Myklebust9eaef272006-10-21 10:24:20 -07002673 if (S_ISDIR(inode->i_mode)) {
2674 struct dentry *alias;
David Howells770bfad2006-08-22 20:06:07 -04002675
Trond Myklebust9eaef272006-10-21 10:24:20 -07002676 /* Does an aliased dentry already exist? */
Linus Torvalds32ba9c32012-06-08 10:34:03 -07002677 alias = __d_find_alias(inode, 0);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002678 if (alias) {
2679 actual = alias;
Al Viro18367502011-07-12 21:42:24 -04002680 write_seqlock(&rename_lock);
2681
2682 if (d_ancestor(alias, dentry)) {
2683 /* Check for loops */
2684 actual = ERR_PTR(-ELOOP);
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002685 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002686 } else if (IS_ROOT(alias)) {
2687 /* Is this an anonymous mountpoint that we
2688 * could splice into our tree? */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002689 __d_materialise_dentry(dentry, alias);
Al Viro18367502011-07-12 21:42:24 -04002690 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002691 __d_drop(alias);
2692 goto found;
Al Viro18367502011-07-12 21:42:24 -04002693 } else {
2694 /* Nope, but we must(!) avoid directory
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002695 * aliasing. This drops inode->i_lock */
Al Viro18367502011-07-12 21:42:24 -04002696 actual = __d_unalias(inode, dentry, alias);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002697 }
Al Viro18367502011-07-12 21:42:24 -04002698 write_sequnlock(&rename_lock);
David Howellsdd179942011-08-16 15:31:30 +01002699 if (IS_ERR(actual)) {
2700 if (PTR_ERR(actual) == -ELOOP)
2701 pr_warn_ratelimited(
2702 "VFS: Lookup of '%s' in %s %s"
2703 " would have caused loop\n",
2704 dentry->d_name.name,
2705 inode->i_sb->s_type->name,
2706 inode->i_sb->s_id);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002707 dput(alias);
David Howellsdd179942011-08-16 15:31:30 +01002708 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002709 goto out_nolock;
2710 }
David Howells770bfad2006-08-22 20:06:07 -04002711 }
2712
2713 /* Add a unique reference */
2714 actual = __d_instantiate_unique(dentry, inode);
2715 if (!actual)
2716 actual = dentry;
Nick Piggin357f8e62011-01-07 17:49:42 +11002717 else
2718 BUG_ON(!d_unhashed(actual));
David Howells770bfad2006-08-22 20:06:07 -04002719
David Howells770bfad2006-08-22 20:06:07 -04002720 spin_lock(&actual->d_lock);
2721found:
2722 _d_rehash(actual);
2723 spin_unlock(&actual->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002724 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002725out_nolock:
David Howells770bfad2006-08-22 20:06:07 -04002726 if (actual == dentry) {
2727 security_d_instantiate(dentry, inode);
2728 return NULL;
2729 }
2730
2731 iput(inode);
2732 return actual;
David Howells770bfad2006-08-22 20:06:07 -04002733}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002734EXPORT_SYMBOL_GPL(d_materialise_unique);
David Howells770bfad2006-08-22 20:06:07 -04002735
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002736static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002737{
2738 *buflen -= namelen;
2739 if (*buflen < 0)
2740 return -ENAMETOOLONG;
2741 *buffer -= namelen;
2742 memcpy(*buffer, str, namelen);
2743 return 0;
2744}
2745
Waiman Long232d2d62013-09-09 12:18:13 -04002746/**
2747 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04002748 * @buffer: buffer pointer
2749 * @buflen: allocated length of the buffer
2750 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04002751 *
2752 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
2753 * make sure that either the old or the new name pointer and length are
2754 * fetched. However, there may be mismatch between length and pointer.
2755 * The length cannot be trusted, we need to copy it byte-by-byte until
2756 * the length is reached or a null byte is found. It also prepends "/" at
2757 * the beginning of the name. The sequence number check at the caller will
2758 * retry it again when a d_move() does happen. So any garbage in the buffer
2759 * due to mismatched pointer and length will be discarded.
2760 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002761static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2762{
Waiman Long232d2d62013-09-09 12:18:13 -04002763 const char *dname = ACCESS_ONCE(name->name);
2764 u32 dlen = ACCESS_ONCE(name->len);
2765 char *p;
2766
Waiman Long232d2d62013-09-09 12:18:13 -04002767 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04002768 if (*buflen < 0)
2769 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04002770 p = *buffer -= dlen + 1;
2771 *p++ = '/';
2772 while (dlen--) {
2773 char c = *dname++;
2774 if (!c)
2775 break;
2776 *p++ = c;
2777 }
2778 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002779}
2780
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781/**
Randy Dunlap208898c2010-11-18 15:02:49 -08002782 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002783 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002784 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002785 * @buffer: pointer to the end of the buffer
2786 * @buflen: pointer to buffer length
2787 *
Waiman Long18129972013-09-12 10:55:35 -04002788 * The function will first try to write out the pathname without taking any
2789 * lock other than the RCU read lock to make sure that dentries won't go away.
2790 * It only checks the sequence number of the global rename_lock as any change
2791 * in the dentry's d_seq will be preceded by changes in the rename_lock
2792 * sequence number. If the sequence number had been changed, it will restart
2793 * the whole pathname back-tracing sequence again by taking the rename_lock.
2794 * In this case, there is no need to take the RCU read lock as the recursive
2795 * parent pointer references will keep the dentry chain alive as long as no
2796 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002797 */
Al Viro02125a82011-12-05 08:43:34 -05002798static int prepend_path(const struct path *path,
2799 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002800 char **buffer, int *buflen)
2801{
Al Viroede4ceb2013-11-13 07:45:40 -05002802 struct dentry *dentry;
2803 struct vfsmount *vfsmnt;
2804 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002805 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04002806 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04002807 char *bptr;
2808 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002809
Al Viro48f5ec22013-09-09 15:22:25 -04002810 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04002811restart_mnt:
2812 read_seqbegin_or_lock(&mount_lock, &m_seq);
2813 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002814 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002815restart:
2816 bptr = *buffer;
2817 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04002818 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05002819 dentry = path->dentry;
2820 vfsmnt = path->mnt;
2821 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04002822 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002823 while (dentry != root->dentry || vfsmnt != root->mnt) {
2824 struct dentry * parent;
2825
2826 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04002827 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002828 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04002829 if (mnt != parent) {
2830 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
2831 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04002832 vfsmnt = &mnt->mnt;
2833 continue;
2834 }
2835 /*
2836 * Filesystems needing to implement special "root names"
2837 * should do so with ->d_dname()
2838 */
2839 if (IS_ROOT(dentry) &&
2840 (dentry->d_name.len != 1 ||
2841 dentry->d_name.name[0] != '/')) {
2842 WARN(1, "Root dentry has weird name <%.*s>\n",
2843 (int) dentry->d_name.len,
2844 dentry->d_name.name);
2845 }
2846 if (!error)
2847 error = is_mounted(vfsmnt) ? 1 : 2;
2848 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002849 }
2850 parent = dentry->d_parent;
2851 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002852 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002853 if (error)
2854 break;
2855
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002856 dentry = parent;
2857 }
Al Viro48f5ec22013-09-09 15:22:25 -04002858 if (!(seq & 1))
2859 rcu_read_unlock();
2860 if (need_seqretry(&rename_lock, seq)) {
2861 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04002862 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002863 }
Al Viro48f5ec22013-09-09 15:22:25 -04002864 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002865
2866 if (!(m_seq & 1))
2867 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04002868 if (need_seqretry(&mount_lock, m_seq)) {
2869 m_seq = 1;
2870 goto restart_mnt;
2871 }
2872 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002873
Waiman Long232d2d62013-09-09 12:18:13 -04002874 if (error >= 0 && bptr == *buffer) {
2875 if (--blen < 0)
2876 error = -ENAMETOOLONG;
2877 else
2878 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002879 }
Waiman Long232d2d62013-09-09 12:18:13 -04002880 *buffer = bptr;
2881 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04002882 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002883}
2884
2885/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002886 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002887 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002888 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07002889 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07002890 * @buflen: buffer length
2891 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002892 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002893 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002894 * Returns a pointer into the buffer or an error code if the
2895 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08002896 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04002897 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002898 *
Al Viro02125a82011-12-05 08:43:34 -05002899 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002900 */
Al Viro02125a82011-12-05 08:43:34 -05002901char *__d_path(const struct path *path,
2902 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002903 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002904{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002905 char *res = buf + buflen;
2906 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002907
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002908 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002909 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002910
Al Viro02125a82011-12-05 08:43:34 -05002911 if (error < 0)
2912 return ERR_PTR(error);
2913 if (error > 0)
2914 return NULL;
2915 return res;
2916}
2917
2918char *d_absolute_path(const struct path *path,
2919 char *buf, int buflen)
2920{
2921 struct path root = {};
2922 char *res = buf + buflen;
2923 int error;
2924
2925 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05002926 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05002927
2928 if (error > 1)
2929 error = -EINVAL;
2930 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002931 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002932 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002933}
2934
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002935/*
2936 * same as __d_path but appends "(deleted)" for unlinked files.
2937 */
Al Viro02125a82011-12-05 08:43:34 -05002938static int path_with_deleted(const struct path *path,
2939 const struct path *root,
2940 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002941{
2942 prepend(buf, buflen, "\0", 1);
2943 if (d_unlinked(path->dentry)) {
2944 int error = prepend(buf, buflen, " (deleted)", 10);
2945 if (error)
2946 return error;
2947 }
2948
2949 return prepend_path(path, root, buf, buflen);
2950}
2951
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002952static int prepend_unreachable(char **buffer, int *buflen)
2953{
2954 return prepend(buffer, buflen, "(unreachable)", 13);
2955}
2956
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07002957static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
2958{
2959 unsigned seq;
2960
2961 do {
2962 seq = read_seqcount_begin(&fs->seq);
2963 *root = fs->root;
2964 } while (read_seqcount_retry(&fs->seq, seq));
2965}
2966
Jan Bluncka03a8a702008-02-14 19:38:32 -08002967/**
2968 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08002969 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08002970 * @buf: buffer to return value in
2971 * @buflen: buffer length
2972 *
2973 * Convert a dentry into an ASCII path name. If the entry has been deleted
2974 * the string " (deleted)" is appended. Note that this is ambiguous.
2975 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002976 * Returns a pointer into the buffer or an error code if the path was
2977 * too long. Note: Callers should use the returned pointer, not the passed
2978 * in buffer, to use the name! The implementation often starts at an offset
2979 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002980 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002981 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002982 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07002983char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002984{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002985 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08002986 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002987 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002988
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002989 /*
2990 * We have various synthetic filesystems that never get mounted. On
2991 * these filesystems dentries are never used for lookup purposes, and
2992 * thus don't need to be hashed. They also don't need a name until a
2993 * user wants to identify the object in /proc/pid/fd/. The little hack
2994 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08002995 *
2996 * Some pseudo inodes are mountable. When they are mounted
2997 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
2998 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002999 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003000 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3001 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003002 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003003
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003004 rcu_read_lock();
3005 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003006 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003007 rcu_read_unlock();
3008
Al Viro02125a82011-12-05 08:43:34 -05003009 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003010 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003011 return res;
3012}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003013EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003014
3015/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003016 * Helper function for dentry_operations.d_dname() members
3017 */
3018char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3019 const char *fmt, ...)
3020{
3021 va_list args;
3022 char temp[64];
3023 int sz;
3024
3025 va_start(args, fmt);
3026 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3027 va_end(args);
3028
3029 if (sz > sizeof(temp) || sz > buflen)
3030 return ERR_PTR(-ENAMETOOLONG);
3031
3032 buffer += buflen - sz;
3033 return memcpy(buffer, temp, sz);
3034}
3035
Al Viro118b2302013-08-24 12:08:17 -04003036char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3037{
3038 char *end = buffer + buflen;
3039 /* these dentries are never renamed, so d_lock is not needed */
3040 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003041 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003042 prepend(&end, &buflen, "/", 1))
3043 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003044 return end;
Al Viro118b2302013-08-24 12:08:17 -04003045}
David Herrmann31bbe162014-01-03 14:09:47 +01003046EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003047
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003048/*
Ram Pai6092d042008-03-27 13:06:20 +01003049 * Write full pathname from the root of the filesystem into the buffer.
3050 */
Al Virof6500802014-01-26 12:37:55 -05003051static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003052{
Al Virof6500802014-01-26 12:37:55 -05003053 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003054 char *end, *retval;
3055 int len, seq = 0;
3056 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003057
Al Virof6500802014-01-26 12:37:55 -05003058 if (buflen < 2)
3059 goto Elong;
3060
Al Viro48f5ec22013-09-09 15:22:25 -04003061 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003062restart:
Al Virof6500802014-01-26 12:37:55 -05003063 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003064 end = buf + buflen;
3065 len = buflen;
3066 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003067 /* Get '/' right */
3068 retval = end-1;
3069 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003070 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003071 while (!IS_ROOT(dentry)) {
3072 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003073
Ram Pai6092d042008-03-27 13:06:20 +01003074 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003075 error = prepend_name(&end, &len, &dentry->d_name);
3076 if (error)
3077 break;
Ram Pai6092d042008-03-27 13:06:20 +01003078
3079 retval = end;
3080 dentry = parent;
3081 }
Al Viro48f5ec22013-09-09 15:22:25 -04003082 if (!(seq & 1))
3083 rcu_read_unlock();
3084 if (need_seqretry(&rename_lock, seq)) {
3085 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003086 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003087 }
3088 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003089 if (error)
3090 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003091 return retval;
3092Elong:
3093 return ERR_PTR(-ENAMETOOLONG);
3094}
Nick Pigginec2447c2011-01-07 17:49:29 +11003095
3096char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3097{
Waiman Long232d2d62013-09-09 12:18:13 -04003098 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003099}
3100EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003101
3102char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3103{
3104 char *p = NULL;
3105 char *retval;
3106
Al Viroc1031352010-06-06 22:31:14 -04003107 if (d_unlinked(dentry)) {
3108 p = buf + buflen;
3109 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3110 goto Elong;
3111 buflen++;
3112 }
3113 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003114 if (!IS_ERR(retval) && p)
3115 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003116 return retval;
3117Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003118 return ERR_PTR(-ENAMETOOLONG);
3119}
3120
Linus Torvalds8b19e342013-09-12 10:35:47 -07003121static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3122 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003123{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003124 unsigned seq;
3125
3126 do {
3127 seq = read_seqcount_begin(&fs->seq);
3128 *root = fs->root;
3129 *pwd = fs->pwd;
3130 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003131}
3132
Ram Pai6092d042008-03-27 13:06:20 +01003133/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003134 * NOTE! The user-level library version returns a
3135 * character pointer. The kernel system call just
3136 * returns the length of the buffer filled (which
3137 * includes the ending '\0' character), or a negative
3138 * error value. So libc would do something like
3139 *
3140 * char *getcwd(char * buf, size_t size)
3141 * {
3142 * int retval;
3143 *
3144 * retval = sys_getcwd(buf, size);
3145 * if (retval >= 0)
3146 * return buf;
3147 * errno = -retval;
3148 * return NULL;
3149 * }
3150 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003151SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003152{
Linus Torvalds552ce542007-02-13 12:08:18 -08003153 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003154 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003155 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003156
3157 if (!page)
3158 return -ENOMEM;
3159
Linus Torvalds8b19e342013-09-12 10:35:47 -07003160 rcu_read_lock();
3161 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003162
Linus Torvalds552ce542007-02-13 12:08:18 -08003163 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003164 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003165 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003166 char *cwd = page + PATH_MAX;
3167 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003168
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003169 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003170 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003171 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003172
Al Viro02125a82011-12-05 08:43:34 -05003173 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003174 goto out;
3175
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003176 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003177 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003178 error = prepend_unreachable(&cwd, &buflen);
3179 if (error)
3180 goto out;
3181 }
3182
Linus Torvalds552ce542007-02-13 12:08:18 -08003183 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003184 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003185 if (len <= size) {
3186 error = len;
3187 if (copy_to_user(buf, cwd, len))
3188 error = -EFAULT;
3189 }
Nick Piggin949854d2011-01-07 17:49:37 +11003190 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003191 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003192 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003193
3194out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003195 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003196 return error;
3197}
3198
3199/*
3200 * Test whether new_dentry is a subdirectory of old_dentry.
3201 *
3202 * Trivially implemented using the dcache structure
3203 */
3204
3205/**
3206 * is_subdir - is new dentry a subdirectory of old_dentry
3207 * @new_dentry: new dentry
3208 * @old_dentry: old dentry
3209 *
3210 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
3211 * Returns 0 otherwise.
3212 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3213 */
3214
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003215int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003216{
3217 int result;
Nick Piggin949854d2011-01-07 17:49:37 +11003218 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003219
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003220 if (new_dentry == old_dentry)
3221 return 1;
3222
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003223 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003224 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003225 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003226 /*
3227 * Need rcu_readlock to protect against the d_parent trashing
3228 * due to d_move
3229 */
3230 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003231 if (d_ancestor(old_dentry, new_dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003232 result = 1;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003233 else
3234 result = 0;
Nick Piggin949854d2011-01-07 17:49:37 +11003235 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003236 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003237
3238 return result;
3239}
3240
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003241static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003242{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003243 struct dentry *root = data;
3244 if (dentry != root) {
3245 if (d_unhashed(dentry) || !dentry->d_inode)
3246 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003247
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003248 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3249 dentry->d_flags |= DCACHE_GENOCIDE;
3250 dentry->d_lockref.count--;
3251 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003252 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003253 return D_WALK_CONTINUE;
3254}
Nick Piggin58db63d2011-01-07 17:49:39 +11003255
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003256void d_genocide(struct dentry *parent)
3257{
3258 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003259}
3260
Al Viro60545d02013-06-07 01:20:27 -04003261void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003262{
Al Viro60545d02013-06-07 01:20:27 -04003263 inode_dec_link_count(inode);
3264 BUG_ON(dentry->d_name.name != dentry->d_iname ||
3265 !hlist_unhashed(&dentry->d_alias) ||
3266 !d_unlinked(dentry));
3267 spin_lock(&dentry->d_parent->d_lock);
3268 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3269 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3270 (unsigned long long)inode->i_ino);
3271 spin_unlock(&dentry->d_lock);
3272 spin_unlock(&dentry->d_parent->d_lock);
3273 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003274}
Al Viro60545d02013-06-07 01:20:27 -04003275EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003276
3277static __initdata unsigned long dhash_entries;
3278static int __init set_dhash_entries(char *str)
3279{
3280 if (!str)
3281 return 0;
3282 dhash_entries = simple_strtoul(str, &str, 0);
3283 return 1;
3284}
3285__setup("dhash_entries=", set_dhash_entries);
3286
3287static void __init dcache_init_early(void)
3288{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003289 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003290
3291 /* If hashes are distributed across NUMA nodes, defer
3292 * hash allocation until vmalloc space is available.
3293 */
3294 if (hashdist)
3295 return;
3296
3297 dentry_hashtable =
3298 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003299 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003300 dhash_entries,
3301 13,
3302 HASH_EARLY,
3303 &d_hash_shift,
3304 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003305 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003306 0);
3307
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003308 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003309 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003310}
3311
Denis Cheng74bf17c2007-10-16 23:26:30 -07003312static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003313{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003314 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003315
3316 /*
3317 * A constructor could be added for stable state like the lists,
3318 * but it is probably not worth it because of the cache nature
3319 * of the dcache.
3320 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003321 dentry_cache = KMEM_CACHE(dentry,
3322 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003323
3324 /* Hash may have been set up in dcache_init_early */
3325 if (!hashdist)
3326 return;
3327
3328 dentry_hashtable =
3329 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003330 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003331 dhash_entries,
3332 13,
3333 0,
3334 &d_hash_shift,
3335 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003336 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003337 0);
3338
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003339 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003340 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003341}
3342
3343/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003344struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003345EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003346
Linus Torvalds1da177e2005-04-16 15:20:36 -07003347EXPORT_SYMBOL(d_genocide);
3348
Linus Torvalds1da177e2005-04-16 15:20:36 -07003349void __init vfs_caches_init_early(void)
3350{
3351 dcache_init_early();
3352 inode_init_early();
3353}
3354
3355void __init vfs_caches_init(unsigned long mempages)
3356{
3357 unsigned long reserve;
3358
3359 /* Base hash sizes on available memory, with a reserve equal to
3360 150% of current kernel size */
3361
3362 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
3363 mempages -= reserve;
3364
3365 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003366 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003367
Denis Cheng74bf17c2007-10-16 23:26:30 -07003368 dcache_init();
3369 inode_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003370 files_init(mempages);
Denis Cheng74bf17c2007-10-16 23:26:30 -07003371 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003372 bdev_cache_init();
3373 chrdev_init();
3374}