blob: c23f78a9d156cc0c7165e624870d45f178ab800f [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)) {
Al Viroff2fde92014-05-28 13:59:13 -0400804 struct inode *inode;
Miklos Szeredi60942f22014-05-02 15:38:39 -0400805 dentry = list_entry(list->prev, struct dentry, d_lru);
Nick Pigginec336792011-01-07 17:49:47 +1100806 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 /*
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000808 * The dispose list is isolated and dentries are not accounted
809 * to the LRU here, so we can simply remove it from the list
810 * here regardless of whether it is referenced or not.
811 */
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400812 d_shrink_del(dentry);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000813
814 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 * We found an inuse dentry which was not removed from
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000816 * the LRU because of laziness during lookup. Do not free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 */
Al Viro41edf272014-05-01 10:30:00 -0400818 if ((int)dentry->d_lockref.count > 0) {
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700819 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 continue;
821 }
Nick Piggin77812a12011-01-07 17:49:48 +1100822
Al Viro64fd72e2014-05-28 09:48:44 -0400823
824 if (unlikely(dentry->d_flags & DCACHE_DENTRY_KILLED)) {
825 bool can_free = dentry->d_flags & DCACHE_MAY_FREE;
826 spin_unlock(&dentry->d_lock);
827 if (can_free)
828 dentry_free(dentry);
829 continue;
830 }
831
Al Viroff2fde92014-05-28 13:59:13 -0400832 inode = dentry->d_inode;
833 if (inode && unlikely(!spin_trylock(&inode->i_lock))) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400834 d_shrink_add(dentry, list);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000835 spin_unlock(&dentry->d_lock);
Al Viro5c47e6d2014-04-29 16:13:18 -0400836 continue;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000837 }
Al Viroff2fde92014-05-28 13:59:13 -0400838
839 parent = NULL;
840 if (!IS_ROOT(dentry)) {
841 parent = dentry->d_parent;
842 if (unlikely(!spin_trylock(&parent->d_lock))) {
843 if (inode)
844 spin_unlock(&inode->i_lock);
845 d_shrink_add(dentry, list);
846 spin_unlock(&dentry->d_lock);
847 continue;
848 }
849 }
850
851 __dentry_kill(dentry);
Al Viro5c47e6d2014-04-29 16:13:18 -0400852 /*
853 * We need to prune ancestors too. This is necessary to prevent
854 * quadratic behavior of shrink_dcache_parent(), but is also
855 * expected to be beneficial in reducing dentry cache
856 * fragmentation.
857 */
858 dentry = parent;
859 while (dentry && !lockref_put_or_lock(&dentry->d_lockref))
860 dentry = dentry_kill(dentry, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400862}
863
Dave Chinnerf6041562013-08-28 10:18:00 +1000864static enum lru_status
865dentry_lru_isolate(struct list_head *item, spinlock_t *lru_lock, void *arg)
866{
867 struct list_head *freeable = arg;
868 struct dentry *dentry = container_of(item, struct dentry, d_lru);
869
870
871 /*
872 * we are inverting the lru lock/dentry->d_lock here,
873 * so use a trylock. If we fail to get the lock, just skip
874 * it
875 */
876 if (!spin_trylock(&dentry->d_lock))
877 return LRU_SKIP;
878
879 /*
880 * Referenced dentries are still in use. If they have active
881 * counts, just remove them from the LRU. Otherwise give them
882 * another pass through the LRU.
883 */
884 if (dentry->d_lockref.count) {
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400885 d_lru_isolate(dentry);
Dave Chinnerf6041562013-08-28 10:18:00 +1000886 spin_unlock(&dentry->d_lock);
887 return LRU_REMOVED;
888 }
889
890 if (dentry->d_flags & DCACHE_REFERENCED) {
891 dentry->d_flags &= ~DCACHE_REFERENCED;
892 spin_unlock(&dentry->d_lock);
893
894 /*
895 * The list move itself will be made by the common LRU code. At
896 * this point, we've dropped the dentry->d_lock but keep the
897 * lru lock. This is safe to do, since every list movement is
898 * protected by the lru lock even if both locks are held.
899 *
900 * This is guaranteed by the fact that all LRU management
901 * functions are intermediated by the LRU API calls like
902 * list_lru_add and list_lru_del. List movement in this file
903 * only ever occur through this functions or through callbacks
904 * like this one, that are called from the LRU API.
905 *
906 * The only exceptions to this are functions like
907 * shrink_dentry_list, and code that first checks for the
908 * DCACHE_SHRINK_LIST flag. Those are guaranteed to be
909 * operating only with stack provided lists after they are
910 * properly isolated from the main list. It is thus, always a
911 * local access.
912 */
913 return LRU_ROTATE;
914 }
915
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400916 d_lru_shrink_move(dentry, freeable);
Dave Chinnerf6041562013-08-28 10:18:00 +1000917 spin_unlock(&dentry->d_lock);
918
919 return LRU_REMOVED;
920}
921
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400922/**
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000923 * prune_dcache_sb - shrink the dcache
924 * @sb: superblock
Dave Chinnerf6041562013-08-28 10:18:00 +1000925 * @nr_to_scan : number of entries to try to free
Dave Chinner9b17c622013-08-28 10:18:05 +1000926 * @nid: which node to scan for freeable entities
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400927 *
Dave Chinnerf6041562013-08-28 10:18:00 +1000928 * Attempt to shrink the superblock dcache LRU by @nr_to_scan entries. This is
Dave Chinnerb48f03b2011-08-23 18:56:24 +1000929 * done when we need more memory an called from the superblock shrinker
930 * function.
931 *
932 * This function may fail to free any resources if all the dentries are in
933 * use.
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400934 */
Dave Chinner9b17c622013-08-28 10:18:05 +1000935long prune_dcache_sb(struct super_block *sb, unsigned long nr_to_scan,
936 int nid)
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400937{
Dave Chinnerf6041562013-08-28 10:18:00 +1000938 LIST_HEAD(dispose);
939 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400940
Dave Chinner9b17c622013-08-28 10:18:05 +1000941 freed = list_lru_walk_node(&sb->s_dentry_lru, nid, dentry_lru_isolate,
942 &dispose, &nr_to_scan);
Dave Chinnerf6041562013-08-28 10:18:00 +1000943 shrink_dentry_list(&dispose);
Dave Chinner0a234c62013-08-28 10:17:57 +1000944 return freed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945}
946
Glauber Costa4e717f52013-08-28 10:18:03 +1000947static enum lru_status dentry_lru_isolate_shrink(struct list_head *item,
948 spinlock_t *lru_lock, void *arg)
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000949{
Glauber Costa4e717f52013-08-28 10:18:03 +1000950 struct list_head *freeable = arg;
951 struct dentry *dentry = container_of(item, struct dentry, d_lru);
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000952
Glauber Costa4e717f52013-08-28 10:18:03 +1000953 /*
954 * we are inverting the lru lock/dentry->d_lock here,
955 * so use a trylock. If we fail to get the lock, just skip
956 * it
957 */
958 if (!spin_trylock(&dentry->d_lock))
959 return LRU_SKIP;
960
Linus Torvalds89dc77b2013-09-13 22:55:10 -0400961 d_lru_shrink_move(dentry, freeable);
Glauber Costa4e717f52013-08-28 10:18:03 +1000962 spin_unlock(&dentry->d_lock);
963
964 return LRU_REMOVED;
Dave Chinnerdd1f6b22013-08-28 10:17:55 +1000965}
966
Glauber Costa4e717f52013-08-28 10:18:03 +1000967
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700968/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 * shrink_dcache_sb - shrink dcache for a superblock
970 * @sb: superblock
971 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400972 * Shrink the dcache for the specified super block. This is used to free
973 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400975void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976{
Glauber Costa4e717f52013-08-28 10:18:03 +1000977 long freed;
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400978
Glauber Costa4e717f52013-08-28 10:18:03 +1000979 do {
980 LIST_HEAD(dispose);
981
982 freed = list_lru_walk(&sb->s_dentry_lru,
983 dentry_lru_isolate_shrink, &dispose, UINT_MAX);
984
985 this_cpu_sub(nr_dentry_unused, freed);
986 shrink_dentry_list(&dispose);
987 } while (freed > 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700989EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991/**
Miklos Szeredidb14fc32013-09-05 11:44:35 +0200992 * enum d_walk_ret - action to talke during tree walk
993 * @D_WALK_CONTINUE: contrinue walk
994 * @D_WALK_QUIT: quit walk
995 * @D_WALK_NORETRY: quit when retry is needed
996 * @D_WALK_SKIP: skip this dentry and its children
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +0200998enum d_walk_ret {
999 D_WALK_CONTINUE,
1000 D_WALK_QUIT,
1001 D_WALK_NORETRY,
1002 D_WALK_SKIP,
1003};
1004
1005/**
1006 * d_walk - walk the dentry tree
1007 * @parent: start of walk
1008 * @data: data passed to @enter() and @finish()
1009 * @enter: callback when first entering the dentry
1010 * @finish: callback when successfully finished the walk
1011 *
1012 * The @enter() and @finish() callbacks are called with d_lock held.
1013 */
1014static void d_walk(struct dentry *parent, void *data,
1015 enum d_walk_ret (*enter)(void *, struct dentry *),
1016 void (*finish)(void *))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017{
Nick Piggin949854d2011-01-07 17:49:37 +11001018 struct dentry *this_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 struct list_head *next;
Al Viro48f5ec22013-09-09 15:22:25 -04001020 unsigned seq = 0;
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001021 enum d_walk_ret ret;
1022 bool retry = true;
Nick Piggin949854d2011-01-07 17:49:37 +11001023
Nick Piggin58db63d2011-01-07 17:49:39 +11001024again:
Al Viro48f5ec22013-09-09 15:22:25 -04001025 read_seqbegin_or_lock(&rename_lock, &seq);
Nick Piggin58db63d2011-01-07 17:49:39 +11001026 this_parent = parent;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001027 spin_lock(&this_parent->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001028
1029 ret = enter(data, this_parent);
1030 switch (ret) {
1031 case D_WALK_CONTINUE:
1032 break;
1033 case D_WALK_QUIT:
1034 case D_WALK_SKIP:
1035 goto out_unlock;
1036 case D_WALK_NORETRY:
1037 retry = false;
1038 break;
1039 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040repeat:
1041 next = this_parent->d_subdirs.next;
1042resume:
1043 while (next != &this_parent->d_subdirs) {
1044 struct list_head *tmp = next;
Eric Dumazet5160ee62006-01-08 01:03:32 -08001045 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 next = tmp->next;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001047
1048 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001049
1050 ret = enter(data, dentry);
1051 switch (ret) {
1052 case D_WALK_CONTINUE:
1053 break;
1054 case D_WALK_QUIT:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001055 spin_unlock(&dentry->d_lock);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001056 goto out_unlock;
1057 case D_WALK_NORETRY:
1058 retry = false;
1059 break;
1060 case D_WALK_SKIP:
1061 spin_unlock(&dentry->d_lock);
1062 continue;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001063 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001064
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 if (!list_empty(&dentry->d_subdirs)) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001066 spin_unlock(&this_parent->d_lock);
1067 spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 this_parent = dentry;
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001069 spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 goto repeat;
1071 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001072 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 }
1074 /*
1075 * All done at this level ... ascend and resume the search.
1076 */
1077 if (this_parent != parent) {
Linus Torvaldsc826cb72011-03-15 15:29:21 -07001078 struct dentry *child = this_parent;
Al Viro31dec132013-10-25 17:04:27 -04001079 this_parent = child->d_parent;
1080
1081 rcu_read_lock();
1082 spin_unlock(&child->d_lock);
1083 spin_lock(&this_parent->d_lock);
1084
1085 /*
1086 * might go back up the wrong parent if we have had a rename
1087 * or deletion
1088 */
1089 if (this_parent != child->d_parent ||
1090 (child->d_flags & DCACHE_DENTRY_KILLED) ||
1091 need_seqretry(&rename_lock, seq)) {
1092 spin_unlock(&this_parent->d_lock);
1093 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11001094 goto rename_retry;
Al Viro31dec132013-10-25 17:04:27 -04001095 }
1096 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11001097 next = child->d_u.d_child.next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 goto resume;
1099 }
Al Viro48f5ec22013-09-09 15:22:25 -04001100 if (need_seqretry(&rename_lock, seq)) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001101 spin_unlock(&this_parent->d_lock);
1102 goto rename_retry;
1103 }
1104 if (finish)
1105 finish(data);
1106
1107out_unlock:
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001108 spin_unlock(&this_parent->d_lock);
Al Viro48f5ec22013-09-09 15:22:25 -04001109 done_seqretry(&rename_lock, seq);
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001110 return;
Nick Piggin58db63d2011-01-07 17:49:39 +11001111
1112rename_retry:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001113 if (!retry)
1114 return;
Al Viro48f5ec22013-09-09 15:22:25 -04001115 seq = 1;
Nick Piggin58db63d2011-01-07 17:49:39 +11001116 goto again;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117}
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001118
1119/*
1120 * Search for at least 1 mount point in the dentry's subdirs.
1121 * We descend to the next level whenever the d_subdirs
1122 * list is non-empty and continue searching.
1123 */
1124
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001125static enum d_walk_ret check_mount(void *data, struct dentry *dentry)
1126{
1127 int *ret = data;
1128 if (d_mountpoint(dentry)) {
1129 *ret = 1;
1130 return D_WALK_QUIT;
1131 }
1132 return D_WALK_CONTINUE;
1133}
1134
Randy Dunlap69c88dc2013-10-19 14:57:07 -07001135/**
1136 * have_submounts - check for mounts over a dentry
1137 * @parent: dentry to check.
1138 *
1139 * Return true if the parent or its subdirectories contain
1140 * a mount point
1141 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001142int have_submounts(struct dentry *parent)
1143{
1144 int ret = 0;
1145
1146 d_walk(parent, &ret, check_mount, NULL);
1147
1148 return ret;
1149}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001150EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151
1152/*
Miklos Szeredieed81002013-09-05 14:39:11 +02001153 * Called by mount code to set a mountpoint and check if the mountpoint is
1154 * reachable (e.g. NFS can unhash a directory dentry and then the complete
1155 * subtree can become unreachable).
1156 *
1157 * Only one of check_submounts_and_drop() and d_set_mounted() must succeed. For
1158 * this reason take rename_lock and d_lock on dentry and ancestors.
1159 */
1160int d_set_mounted(struct dentry *dentry)
1161{
1162 struct dentry *p;
1163 int ret = -ENOENT;
1164 write_seqlock(&rename_lock);
1165 for (p = dentry->d_parent; !IS_ROOT(p); p = p->d_parent) {
1166 /* Need exclusion wrt. check_submounts_and_drop() */
1167 spin_lock(&p->d_lock);
1168 if (unlikely(d_unhashed(p))) {
1169 spin_unlock(&p->d_lock);
1170 goto out;
1171 }
1172 spin_unlock(&p->d_lock);
1173 }
1174 spin_lock(&dentry->d_lock);
1175 if (!d_unlinked(dentry)) {
1176 dentry->d_flags |= DCACHE_MOUNTED;
1177 ret = 0;
1178 }
1179 spin_unlock(&dentry->d_lock);
1180out:
1181 write_sequnlock(&rename_lock);
1182 return ret;
1183}
1184
1185/*
J. Bruce Fieldsfd517902012-09-18 16:35:51 -04001186 * Search the dentry child list of the specified parent,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 * and move any unused dentries to the end of the unused
1188 * list for prune_dcache(). We descend to the next level
1189 * whenever the d_subdirs list is non-empty and continue
1190 * searching.
1191 *
1192 * It returns zero iff there are no unused children,
1193 * otherwise it returns the number of children moved to
1194 * the end of the unused list. This may not be the total
1195 * number of unused children, because select_parent can
1196 * drop the lock and return early due to latency
1197 * constraints.
1198 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001199
1200struct select_data {
1201 struct dentry *start;
1202 struct list_head dispose;
1203 int found;
1204};
1205
1206static enum d_walk_ret select_collect(void *_data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001208 struct select_data *data = _data;
1209 enum d_walk_ret ret = D_WALK_CONTINUE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001211 if (data->start == dentry)
1212 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213
Al Virofe915222014-05-03 00:02:25 -04001214 if (dentry->d_flags & DCACHE_SHRINK_LIST) {
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001215 data->found++;
Al Virofe915222014-05-03 00:02:25 -04001216 } else {
1217 if (dentry->d_flags & DCACHE_LRU_LIST)
1218 d_lru_del(dentry);
1219 if (!dentry->d_lockref.count) {
1220 d_shrink_add(dentry, &data->dispose);
1221 data->found++;
1222 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 }
1224 /*
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001225 * We can return to the caller if we have found some (this
1226 * ensures forward progress). We'll be coming back to find
1227 * the rest.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 */
Al Virofe915222014-05-03 00:02:25 -04001229 if (!list_empty(&data->dispose))
1230 ret = need_resched() ? D_WALK_QUIT : D_WALK_NORETRY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231out:
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001232 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233}
1234
1235/**
1236 * shrink_dcache_parent - prune dcache
1237 * @parent: parent of entries to prune
1238 *
1239 * Prune the dcache to remove unused children of the parent dentry.
1240 */
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001241void shrink_dcache_parent(struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001243 for (;;) {
1244 struct select_data data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245
Miklos Szeredidb14fc32013-09-05 11:44:35 +02001246 INIT_LIST_HEAD(&data.dispose);
1247 data.start = parent;
1248 data.found = 0;
1249
1250 d_walk(parent, &data, select_collect, NULL);
1251 if (!data.found)
1252 break;
1253
1254 shrink_dentry_list(&data.dispose);
Greg Thelen421348f2013-04-30 15:26:48 -07001255 cond_resched();
1256 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001258EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259
Al Viro9c8c10e2014-05-02 20:36:10 -04001260static enum d_walk_ret umount_check(void *_data, struct dentry *dentry)
Al Viro42c32602013-11-08 12:31:16 -05001261{
Al Viro9c8c10e2014-05-02 20:36:10 -04001262 /* it has busy descendents; complain about those instead */
1263 if (!list_empty(&dentry->d_subdirs))
1264 return D_WALK_CONTINUE;
Al Viro42c32602013-11-08 12:31:16 -05001265
Al Viro9c8c10e2014-05-02 20:36:10 -04001266 /* root with refcount 1 is fine */
1267 if (dentry == _data && dentry->d_lockref.count == 1)
1268 return D_WALK_CONTINUE;
1269
1270 printk(KERN_ERR "BUG: Dentry %p{i=%lx,n=%pd} "
1271 " still in use (%d) [unmount of %s %s]\n",
Al Viro42c32602013-11-08 12:31:16 -05001272 dentry,
1273 dentry->d_inode ?
1274 dentry->d_inode->i_ino : 0UL,
Al Viro9c8c10e2014-05-02 20:36:10 -04001275 dentry,
Al Viro42c32602013-11-08 12:31:16 -05001276 dentry->d_lockref.count,
1277 dentry->d_sb->s_type->name,
1278 dentry->d_sb->s_id);
Al Viro9c8c10e2014-05-02 20:36:10 -04001279 WARN_ON(1);
1280 return D_WALK_CONTINUE;
1281}
1282
1283static void do_one_tree(struct dentry *dentry)
1284{
1285 shrink_dcache_parent(dentry);
1286 d_walk(dentry, dentry, umount_check, NULL);
1287 d_drop(dentry);
1288 dput(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001289}
1290
1291/*
1292 * destroy the dentries attached to a superblock on unmounting
1293 */
1294void shrink_dcache_for_umount(struct super_block *sb)
1295{
1296 struct dentry *dentry;
1297
Al Viro9c8c10e2014-05-02 20:36:10 -04001298 WARN(down_read_trylock(&sb->s_umount), "s_umount should've been locked");
Al Viro42c32602013-11-08 12:31:16 -05001299
1300 dentry = sb->s_root;
1301 sb->s_root = NULL;
Al Viro9c8c10e2014-05-02 20:36:10 -04001302 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001303
1304 while (!hlist_bl_empty(&sb->s_anon)) {
Al Viro9c8c10e2014-05-02 20:36:10 -04001305 dentry = dget(hlist_bl_entry(hlist_bl_first(&sb->s_anon), struct dentry, d_hash));
1306 do_one_tree(dentry);
Al Viro42c32602013-11-08 12:31:16 -05001307 }
1308}
1309
Miklos Szeredi848ac1142013-09-05 11:44:36 +02001310static enum d_walk_ret check_and_collect(void *_data, struct dentry *dentry)
1311{
1312 struct select_data *data = _data;
1313
1314 if (d_mountpoint(dentry)) {
1315 data->found = -EBUSY;
1316 return D_WALK_QUIT;
1317 }
1318
1319 return select_collect(_data, dentry);
1320}
1321
1322static void check_and_drop(void *_data)
1323{
1324 struct select_data *data = _data;
1325
1326 if (d_mountpoint(data->start))
1327 data->found = -EBUSY;
1328 if (!data->found)
1329 __d_drop(data->start);
1330}
1331
1332/**
1333 * check_submounts_and_drop - prune dcache, check for submounts and drop
1334 *
1335 * All done as a single atomic operation relative to has_unlinked_ancestor().
1336 * Returns 0 if successfully unhashed @parent. If there were submounts then
1337 * return -EBUSY.
1338 *
1339 * @dentry: dentry to prune and drop
1340 */
1341int check_submounts_and_drop(struct dentry *dentry)
1342{
1343 int ret = 0;
1344
1345 /* Negative dentries can be dropped without further checks */
1346 if (!dentry->d_inode) {
1347 d_drop(dentry);
1348 goto out;
1349 }
1350
1351 for (;;) {
1352 struct select_data data;
1353
1354 INIT_LIST_HEAD(&data.dispose);
1355 data.start = dentry;
1356 data.found = 0;
1357
1358 d_walk(dentry, &data, check_and_collect, check_and_drop);
1359 ret = data.found;
1360
1361 if (!list_empty(&data.dispose))
1362 shrink_dentry_list(&data.dispose);
1363
1364 if (ret <= 0)
1365 break;
1366
1367 cond_resched();
1368 }
1369
1370out:
1371 return ret;
1372}
1373EXPORT_SYMBOL(check_submounts_and_drop);
1374
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375/**
Al Viroa4464db2011-07-07 15:03:58 -04001376 * __d_alloc - allocate a dcache entry
1377 * @sb: filesystem it will belong to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 * @name: qstr of the name
1379 *
1380 * Allocates a dentry. It returns %NULL if there is insufficient memory
1381 * available. On a success the dentry is returned. The name passed in is
1382 * copied and the copy passed in may be reused after this call.
1383 */
1384
Al Viroa4464db2011-07-07 15:03:58 -04001385struct dentry *__d_alloc(struct super_block *sb, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386{
1387 struct dentry *dentry;
1388 char *dname;
1389
Mel Gormane12ba742007-10-16 01:25:52 -07001390 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 if (!dentry)
1392 return NULL;
1393
Linus Torvalds6326c712012-05-21 16:14:04 -07001394 /*
1395 * We guarantee that the inline name is always NUL-terminated.
1396 * This way the memcpy() done by the name switching in rename
1397 * will still always have a NUL at the end, even if we might
1398 * be overwriting an internal NUL character
1399 */
1400 dentry->d_iname[DNAME_INLINE_LEN-1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 if (name->len > DNAME_INLINE_LEN-1) {
1402 dname = kmalloc(name->len + 1, GFP_KERNEL);
1403 if (!dname) {
1404 kmem_cache_free(dentry_cache, dentry);
1405 return NULL;
1406 }
1407 } else {
1408 dname = dentry->d_iname;
1409 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410
1411 dentry->d_name.len = name->len;
1412 dentry->d_name.hash = name->hash;
1413 memcpy(dname, name->name, name->len);
1414 dname[name->len] = 0;
1415
Linus Torvalds6326c712012-05-21 16:14:04 -07001416 /* Make sure we always see the terminating NUL character */
1417 smp_wmb();
1418 dentry->d_name.name = dname;
1419
Waiman Long98474232013-08-28 18:24:59 -07001420 dentry->d_lockref.count = 1;
Linus Torvaldsdea36672011-04-24 07:58:46 -07001421 dentry->d_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 spin_lock_init(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11001423 seqcount_init(&dentry->d_seq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 dentry->d_inode = NULL;
Al Viroa4464db2011-07-07 15:03:58 -04001425 dentry->d_parent = dentry;
1426 dentry->d_sb = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 dentry->d_op = NULL;
1428 dentry->d_fsdata = NULL;
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001429 INIT_HLIST_BL_NODE(&dentry->d_hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 INIT_LIST_HEAD(&dentry->d_lru);
1431 INIT_LIST_HEAD(&dentry->d_subdirs);
Al Virob3d9b7a2012-06-09 13:51:19 -04001432 INIT_HLIST_NODE(&dentry->d_alias);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11001433 INIT_LIST_HEAD(&dentry->d_u.d_child);
Al Viroa4464db2011-07-07 15:03:58 -04001434 d_set_d_op(dentry, dentry->d_sb->s_d_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435
Nick Piggin3e880fb2011-01-07 17:49:19 +11001436 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04001437
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 return dentry;
1439}
Al Viroa4464db2011-07-07 15:03:58 -04001440
1441/**
1442 * d_alloc - allocate a dcache entry
1443 * @parent: parent of entry to allocate
1444 * @name: qstr of the name
1445 *
1446 * Allocates a dentry. It returns %NULL if there is insufficient memory
1447 * available. On a success the dentry is returned. The name passed in is
1448 * copied and the copy passed in may be reused after this call.
1449 */
1450struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
1451{
1452 struct dentry *dentry = __d_alloc(parent->d_sb, name);
1453 if (!dentry)
1454 return NULL;
1455
1456 spin_lock(&parent->d_lock);
1457 /*
1458 * don't need child lock because it is not subject
1459 * to concurrency here
1460 */
1461 __dget_dlock(parent);
1462 dentry->d_parent = parent;
1463 list_add(&dentry->d_u.d_child, &parent->d_subdirs);
1464 spin_unlock(&parent->d_lock);
1465
1466 return dentry;
1467}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001468EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001470/**
1471 * d_alloc_pseudo - allocate a dentry (for lookup-less filesystems)
1472 * @sb: the superblock
1473 * @name: qstr of the name
1474 *
1475 * For a filesystem that just pins its dentries in memory and never
1476 * performs lookups at all, return an unhashed IS_ROOT dentry.
1477 */
Nick Piggin4b936882011-01-07 17:50:07 +11001478struct dentry *d_alloc_pseudo(struct super_block *sb, const struct qstr *name)
1479{
J. Bruce Fieldse1a24bb2012-06-29 16:20:47 -04001480 return __d_alloc(sb, name);
Nick Piggin4b936882011-01-07 17:50:07 +11001481}
1482EXPORT_SYMBOL(d_alloc_pseudo);
1483
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484struct dentry *d_alloc_name(struct dentry *parent, const char *name)
1485{
1486 struct qstr q;
1487
1488 q.name = name;
1489 q.len = strlen(name);
1490 q.hash = full_name_hash(q.name, q.len);
1491 return d_alloc(parent, &q);
1492}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001493EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494
Nick Pigginfb045ad2011-01-07 17:49:55 +11001495void d_set_d_op(struct dentry *dentry, const struct dentry_operations *op)
1496{
Linus Torvalds6f7f7ca2011-01-14 13:26:18 -08001497 WARN_ON_ONCE(dentry->d_op);
1498 WARN_ON_ONCE(dentry->d_flags & (DCACHE_OP_HASH |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001499 DCACHE_OP_COMPARE |
1500 DCACHE_OP_REVALIDATE |
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001501 DCACHE_OP_WEAK_REVALIDATE |
Nick Pigginfb045ad2011-01-07 17:49:55 +11001502 DCACHE_OP_DELETE ));
1503 dentry->d_op = op;
1504 if (!op)
1505 return;
1506 if (op->d_hash)
1507 dentry->d_flags |= DCACHE_OP_HASH;
1508 if (op->d_compare)
1509 dentry->d_flags |= DCACHE_OP_COMPARE;
1510 if (op->d_revalidate)
1511 dentry->d_flags |= DCACHE_OP_REVALIDATE;
Jeff Laytonecf3d1f2013-02-20 11:19:05 -05001512 if (op->d_weak_revalidate)
1513 dentry->d_flags |= DCACHE_OP_WEAK_REVALIDATE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001514 if (op->d_delete)
1515 dentry->d_flags |= DCACHE_OP_DELETE;
Sage Weilf0023bc2011-10-28 10:02:42 -07001516 if (op->d_prune)
1517 dentry->d_flags |= DCACHE_OP_PRUNE;
Nick Pigginfb045ad2011-01-07 17:49:55 +11001518
1519}
1520EXPORT_SYMBOL(d_set_d_op);
1521
David Howellsb18825a2013-09-12 19:22:53 +01001522static unsigned d_flags_for_inode(struct inode *inode)
1523{
1524 unsigned add_flags = DCACHE_FILE_TYPE;
1525
1526 if (!inode)
1527 return DCACHE_MISS_TYPE;
1528
1529 if (S_ISDIR(inode->i_mode)) {
1530 add_flags = DCACHE_DIRECTORY_TYPE;
1531 if (unlikely(!(inode->i_opflags & IOP_LOOKUP))) {
1532 if (unlikely(!inode->i_op->lookup))
1533 add_flags = DCACHE_AUTODIR_TYPE;
1534 else
1535 inode->i_opflags |= IOP_LOOKUP;
1536 }
1537 } else if (unlikely(!(inode->i_opflags & IOP_NOFOLLOW))) {
1538 if (unlikely(inode->i_op->follow_link))
1539 add_flags = DCACHE_SYMLINK_TYPE;
1540 else
1541 inode->i_opflags |= IOP_NOFOLLOW;
1542 }
1543
1544 if (unlikely(IS_AUTOMOUNT(inode)))
1545 add_flags |= DCACHE_NEED_AUTOMOUNT;
1546 return add_flags;
1547}
1548
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001549static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1550{
David Howellsb18825a2013-09-12 19:22:53 +01001551 unsigned add_flags = d_flags_for_inode(inode);
1552
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001553 spin_lock(&dentry->d_lock);
Al Viro22213312014-04-19 12:30:58 -04001554 __d_set_type(dentry, add_flags);
David Howellsb18825a2013-09-12 19:22:53 +01001555 if (inode)
Al Virob3d9b7a2012-06-09 13:51:19 -04001556 hlist_add_head(&dentry->d_alias, &inode->i_dentry);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001557 dentry->d_inode = inode;
Nick Piggin31e6b012011-01-07 17:49:52 +11001558 dentry_rcuwalk_barrier(dentry);
Nick Pigginb23fb0a2011-01-07 17:49:35 +11001559 spin_unlock(&dentry->d_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001560 fsnotify_d_instantiate(dentry, inode);
1561}
1562
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563/**
1564 * d_instantiate - fill in inode information for a dentry
1565 * @entry: dentry to complete
1566 * @inode: inode to attach to this dentry
1567 *
1568 * Fill in inode information in the entry.
1569 *
1570 * This turns negative dentries into productive full members
1571 * of society.
1572 *
1573 * NOTE! This assumes that the inode count has been incremented
1574 * (or otherwise set) by the caller to indicate that it is now
1575 * in use by the dcache.
1576 */
1577
1578void d_instantiate(struct dentry *entry, struct inode * inode)
1579{
Al Virob3d9b7a2012-06-09 13:51:19 -04001580 BUG_ON(!hlist_unhashed(&entry->d_alias));
Nick Piggin873feea2011-01-07 17:50:06 +11001581 if (inode)
1582 spin_lock(&inode->i_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001583 __d_instantiate(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001584 if (inode)
1585 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 security_d_instantiate(entry, inode);
1587}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001588EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589
1590/**
1591 * d_instantiate_unique - instantiate a non-aliased dentry
1592 * @entry: dentry to instantiate
1593 * @inode: inode to attach to this dentry
1594 *
1595 * Fill in inode information in the entry. On success, it returns NULL.
1596 * If an unhashed alias of "entry" already exists, then we return the
Oleg Drokine866cfa2006-01-09 20:52:51 -08001597 * aliased dentry instead and drop one reference to inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 *
1599 * Note that in order to avoid conflicts with rename() etc, the caller
1600 * had better be holding the parent directory semaphore.
Oleg Drokine866cfa2006-01-09 20:52:51 -08001601 *
1602 * This also assumes that the inode count has been incremented
1603 * (or otherwise set) by the caller to indicate that it is now
1604 * in use by the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 */
David Howells770bfad2006-08-22 20:06:07 -04001606static struct dentry *__d_instantiate_unique(struct dentry *entry,
1607 struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608{
1609 struct dentry *alias;
1610 int len = entry->d_name.len;
1611 const char *name = entry->d_name.name;
1612 unsigned int hash = entry->d_name.hash;
1613
David Howells770bfad2006-08-22 20:06:07 -04001614 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001615 __d_instantiate(entry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001616 return NULL;
1617 }
1618
Sasha Levinb67bfe02013-02-27 17:06:00 -08001619 hlist_for_each_entry(alias, &inode->i_dentry, d_alias) {
Nick Piggin9abca362011-01-07 17:49:36 +11001620 /*
1621 * Don't need alias->d_lock here, because aliases with
1622 * d_parent == entry->d_parent are not subject to name or
1623 * parent changes, because the parent inode i_mutex is held.
1624 */
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001625 if (alias->d_name.hash != hash)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 continue;
1627 if (alias->d_parent != entry->d_parent)
1628 continue;
Linus Torvaldsee983e82012-05-10 12:37:10 -07001629 if (alias->d_name.len != len)
1630 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001631 if (dentry_cmp(alias, name, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632 continue;
Nick Piggindc0474b2011-01-07 17:49:43 +11001633 __dget(alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 return alias;
1635 }
David Howells770bfad2006-08-22 20:06:07 -04001636
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001637 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 return NULL;
1639}
David Howells770bfad2006-08-22 20:06:07 -04001640
1641struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1642{
1643 struct dentry *result;
1644
Al Virob3d9b7a2012-06-09 13:51:19 -04001645 BUG_ON(!hlist_unhashed(&entry->d_alias));
David Howells770bfad2006-08-22 20:06:07 -04001646
Nick Piggin873feea2011-01-07 17:50:06 +11001647 if (inode)
1648 spin_lock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001649 result = __d_instantiate_unique(entry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001650 if (inode)
1651 spin_unlock(&inode->i_lock);
David Howells770bfad2006-08-22 20:06:07 -04001652
1653 if (!result) {
1654 security_d_instantiate(entry, inode);
1655 return NULL;
1656 }
1657
1658 BUG_ON(!d_unhashed(result));
1659 iput(inode);
1660 return result;
1661}
1662
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663EXPORT_SYMBOL(d_instantiate_unique);
1664
Miklos Szeredib70a80e2013-10-01 16:44:54 +02001665/**
1666 * d_instantiate_no_diralias - instantiate a non-aliased dentry
1667 * @entry: dentry to complete
1668 * @inode: inode to attach to this dentry
1669 *
1670 * Fill in inode information in the entry. If a directory alias is found, then
1671 * return an error (and drop inode). Together with d_materialise_unique() this
1672 * guarantees that a directory inode may never have more than one alias.
1673 */
1674int d_instantiate_no_diralias(struct dentry *entry, struct inode *inode)
1675{
1676 BUG_ON(!hlist_unhashed(&entry->d_alias));
1677
1678 spin_lock(&inode->i_lock);
1679 if (S_ISDIR(inode->i_mode) && !hlist_empty(&inode->i_dentry)) {
1680 spin_unlock(&inode->i_lock);
1681 iput(inode);
1682 return -EBUSY;
1683 }
1684 __d_instantiate(entry, inode);
1685 spin_unlock(&inode->i_lock);
1686 security_d_instantiate(entry, inode);
1687
1688 return 0;
1689}
1690EXPORT_SYMBOL(d_instantiate_no_diralias);
1691
Al Viroadc0e912012-01-08 16:49:21 -05001692struct dentry *d_make_root(struct inode *root_inode)
1693{
1694 struct dentry *res = NULL;
1695
1696 if (root_inode) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07001697 static const struct qstr name = QSTR_INIT("/", 1);
Al Viroadc0e912012-01-08 16:49:21 -05001698
1699 res = __d_alloc(root_inode->i_sb, &name);
1700 if (res)
1701 d_instantiate(res, root_inode);
1702 else
1703 iput(root_inode);
1704 }
1705 return res;
1706}
1707EXPORT_SYMBOL(d_make_root);
1708
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001709static struct dentry * __d_find_any_alias(struct inode *inode)
1710{
1711 struct dentry *alias;
1712
Al Virob3d9b7a2012-06-09 13:51:19 -04001713 if (hlist_empty(&inode->i_dentry))
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001714 return NULL;
Al Virob3d9b7a2012-06-09 13:51:19 -04001715 alias = hlist_entry(inode->i_dentry.first, struct dentry, d_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001716 __dget(alias);
1717 return alias;
1718}
1719
Sage Weil46f72b32012-01-10 09:04:37 -08001720/**
1721 * d_find_any_alias - find any alias for a given inode
1722 * @inode: inode to find an alias for
1723 *
1724 * If any aliases exist for the given inode, take and return a
1725 * reference for one of them. If no aliases exist, return %NULL.
1726 */
1727struct dentry *d_find_any_alias(struct inode *inode)
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001728{
1729 struct dentry *de;
1730
1731 spin_lock(&inode->i_lock);
1732 de = __d_find_any_alias(inode);
1733 spin_unlock(&inode->i_lock);
1734 return de;
1735}
Sage Weil46f72b32012-01-10 09:04:37 -08001736EXPORT_SYMBOL(d_find_any_alias);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001737
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738/**
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001739 * d_obtain_alias - find or allocate a dentry for a given inode
1740 * @inode: inode to allocate the dentry for
1741 *
1742 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1743 * similar open by handle operations. The returned dentry may be anonymous,
1744 * or may have a full name (if the inode was already in the cache).
1745 *
1746 * When called on a directory inode, we must ensure that the inode only ever
1747 * has one dentry. If a dentry is found, that is returned instead of
1748 * allocating a new one.
1749 *
1750 * On successful return, the reference to the inode has been transferred
Christoph Hellwig44003722008-08-11 15:49:04 +02001751 * to the dentry. In case of an error the reference on the inode is released.
1752 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1753 * be passed in and will be the error will be propagate to the return value,
1754 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001755 */
1756struct dentry *d_obtain_alias(struct inode *inode)
1757{
NeilBrownb911a6b2012-11-08 16:09:37 -08001758 static const struct qstr anonstring = QSTR_INIT("/", 1);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001759 struct dentry *tmp;
1760 struct dentry *res;
David Howellsb18825a2013-09-12 19:22:53 +01001761 unsigned add_flags;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001762
1763 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001764 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001765 if (IS_ERR(inode))
1766 return ERR_CAST(inode);
1767
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001768 res = d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001769 if (res)
1770 goto out_iput;
1771
Al Viroa4464db2011-07-07 15:03:58 -04001772 tmp = __d_alloc(inode->i_sb, &anonstring);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001773 if (!tmp) {
1774 res = ERR_PTR(-ENOMEM);
1775 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001776 }
Nick Pigginb5c84bf2011-01-07 17:49:38 +11001777
Nick Piggin873feea2011-01-07 17:50:06 +11001778 spin_lock(&inode->i_lock);
J. Bruce Fieldsd891eed2011-01-18 15:45:09 -05001779 res = __d_find_any_alias(inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001780 if (res) {
Nick Piggin873feea2011-01-07 17:50:06 +11001781 spin_unlock(&inode->i_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001782 dput(tmp);
1783 goto out_iput;
1784 }
1785
1786 /* attach a disconnected dentry */
David Howellsb18825a2013-09-12 19:22:53 +01001787 add_flags = d_flags_for_inode(inode) | DCACHE_DISCONNECTED;
1788
Christoph Hellwig9308a612008-08-11 15:49:12 +02001789 spin_lock(&tmp->d_lock);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001790 tmp->d_inode = inode;
David Howellsb18825a2013-09-12 19:22:53 +01001791 tmp->d_flags |= add_flags;
Al Virob3d9b7a2012-06-09 13:51:19 -04001792 hlist_add_head(&tmp->d_alias, &inode->i_dentry);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001793 hlist_bl_lock(&tmp->d_sb->s_anon);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001794 hlist_bl_add_head(&tmp->d_hash, &tmp->d_sb->s_anon);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04001795 hlist_bl_unlock(&tmp->d_sb->s_anon);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001796 spin_unlock(&tmp->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11001797 spin_unlock(&inode->i_lock);
Josef Bacik24ff6662010-11-18 20:52:55 -05001798 security_d_instantiate(tmp, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001799
Christoph Hellwig9308a612008-08-11 15:49:12 +02001800 return tmp;
1801
1802 out_iput:
Josef Bacik24ff6662010-11-18 20:52:55 -05001803 if (res && !IS_ERR(res))
1804 security_d_instantiate(res, inode);
Christoph Hellwig9308a612008-08-11 15:49:12 +02001805 iput(inode);
1806 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001807}
Benny Halevyadc48722009-02-27 14:02:59 -08001808EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809
1810/**
1811 * d_splice_alias - splice a disconnected dentry into the tree if one exists
1812 * @inode: the inode which may have a disconnected dentry
1813 * @dentry: a negative dentry which we want to point to the inode.
1814 *
1815 * If inode is a directory and has a 'disconnected' dentry (i.e. IS_ROOT and
1816 * DCACHE_DISCONNECTED), then d_move that in place of the given dentry
1817 * and return it, else simply d_add the inode to the dentry and return NULL.
1818 *
1819 * This is needed in the lookup routine of any filesystem that is exportable
1820 * (via knfsd) so that we can build dcache paths to directories effectively.
1821 *
1822 * If a dentry was found and moved, then it is returned. Otherwise NULL
1823 * is returned. This matches the expected return value of ->lookup.
1824 *
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001825 * Cluster filesystems may call this function with a negative, hashed dentry.
1826 * In that case, we know that the inode will be a regular file, and also this
1827 * will only occur during atomic_open. So we need to check for the dentry
1828 * being already hashed only in the final case.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 */
1830struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
1831{
1832 struct dentry *new = NULL;
1833
Al Viroa9049372011-07-08 21:20:11 -04001834 if (IS_ERR(inode))
1835 return ERR_CAST(inode);
1836
NeilBrown21c0d8f2006-10-04 02:16:16 -07001837 if (inode && S_ISDIR(inode->i_mode)) {
Nick Piggin873feea2011-01-07 17:50:06 +11001838 spin_lock(&inode->i_lock);
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001839 new = __d_find_alias(inode, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 if (new) {
Linus Torvalds32ba9c32012-06-08 10:34:03 -07001841 BUG_ON(!(new->d_flags & DCACHE_DISCONNECTED));
Nick Piggin873feea2011-01-07 17:50:06 +11001842 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 security_d_instantiate(new, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 d_move(new, dentry);
1845 iput(inode);
1846 } else {
Nick Piggin873feea2011-01-07 17:50:06 +11001847 /* already taking inode->i_lock, so d_add() by hand */
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001848 __d_instantiate(dentry, inode);
Nick Piggin873feea2011-01-07 17:50:06 +11001849 spin_unlock(&inode->i_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850 security_d_instantiate(dentry, inode);
1851 d_rehash(dentry);
1852 }
Steven Whitehouse6d4ade92013-06-14 11:17:15 +01001853 } else {
1854 d_instantiate(dentry, inode);
1855 if (d_unhashed(dentry))
1856 d_rehash(dentry);
1857 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 return new;
1859}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001860EXPORT_SYMBOL(d_splice_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861
Barry Naujok94035402008-05-21 16:50:46 +10001862/**
1863 * d_add_ci - lookup or allocate new dentry with case-exact name
1864 * @inode: the inode case-insensitive lookup has found
1865 * @dentry: the negative dentry that was passed to the parent's lookup func
1866 * @name: the case-exact name to be associated with the returned dentry
1867 *
1868 * This is to avoid filling the dcache with case-insensitive names to the
1869 * same inode, only the actual correct case is stored in the dcache for
1870 * case-insensitive filesystems.
1871 *
1872 * For a case-insensitive lookup match and if the the case-exact dentry
1873 * already exists in in the dcache, use it and return it.
1874 *
1875 * If no entry exists with the exact case name, allocate new dentry with
1876 * the exact case, and return the spliced entry.
1877 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001878struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001879 struct qstr *name)
1880{
Barry Naujok94035402008-05-21 16:50:46 +10001881 struct dentry *found;
1882 struct dentry *new;
1883
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001884 /*
1885 * First check if a dentry matching the name already exists,
1886 * if not go ahead and create it now.
1887 */
Barry Naujok94035402008-05-21 16:50:46 +10001888 found = d_hash_and_lookup(dentry->d_parent, name);
Al Viro4f522a22013-02-11 23:20:37 -05001889 if (unlikely(IS_ERR(found)))
1890 goto err_out;
Barry Naujok94035402008-05-21 16:50:46 +10001891 if (!found) {
1892 new = d_alloc(dentry->d_parent, name);
1893 if (!new) {
Al Viro4f522a22013-02-11 23:20:37 -05001894 found = ERR_PTR(-ENOMEM);
Barry Naujok94035402008-05-21 16:50:46 +10001895 goto err_out;
1896 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001897
Barry Naujok94035402008-05-21 16:50:46 +10001898 found = d_splice_alias(inode, new);
1899 if (found) {
1900 dput(new);
1901 return found;
1902 }
1903 return new;
1904 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001905
1906 /*
1907 * If a matching dentry exists, and it's not negative use it.
1908 *
1909 * Decrement the reference count to balance the iget() done
1910 * earlier on.
1911 */
Barry Naujok94035402008-05-21 16:50:46 +10001912 if (found->d_inode) {
1913 if (unlikely(found->d_inode != inode)) {
1914 /* This can't happen because bad inodes are unhashed. */
1915 BUG_ON(!is_bad_inode(inode));
1916 BUG_ON(!is_bad_inode(found->d_inode));
1917 }
Barry Naujok94035402008-05-21 16:50:46 +10001918 iput(inode);
1919 return found;
1920 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001921
Barry Naujok94035402008-05-21 16:50:46 +10001922 /*
1923 * Negative dentry: instantiate it unless the inode is a directory and
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001924 * already has a dentry.
Barry Naujok94035402008-05-21 16:50:46 +10001925 */
Al Viro4513d892011-07-17 10:52:14 -04001926 new = d_splice_alias(inode, found);
1927 if (new) {
1928 dput(found);
1929 found = new;
Barry Naujok94035402008-05-21 16:50:46 +10001930 }
Al Viro4513d892011-07-17 10:52:14 -04001931 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001932
1933err_out:
1934 iput(inode);
Al Viro4f522a22013-02-11 23:20:37 -05001935 return found;
Barry Naujok94035402008-05-21 16:50:46 +10001936}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001937EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001939/*
1940 * Do the slow-case of the dentry name compare.
1941 *
1942 * Unlike the dentry_cmp() function, we need to atomically
Linus Torvaldsda53be12013-05-21 15:22:44 -07001943 * load the name and length information, so that the
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001944 * filesystem can rely on them, and can use the 'name' and
1945 * 'len' information without worrying about walking off the
1946 * end of memory etc.
1947 *
1948 * Thus the read_seqcount_retry() and the "duplicate" info
1949 * in arguments (the low-level filesystem should not look
1950 * at the dentry inode or name contents directly, since
1951 * rename can change them while we're in RCU mode).
1952 */
1953enum slow_d_compare {
1954 D_COMP_OK,
1955 D_COMP_NOMATCH,
1956 D_COMP_SEQRETRY,
1957};
1958
1959static noinline enum slow_d_compare slow_dentry_cmp(
1960 const struct dentry *parent,
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001961 struct dentry *dentry,
1962 unsigned int seq,
1963 const struct qstr *name)
1964{
1965 int tlen = dentry->d_name.len;
1966 const char *tname = dentry->d_name.name;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001967
1968 if (read_seqcount_retry(&dentry->d_seq, seq)) {
1969 cpu_relax();
1970 return D_COMP_SEQRETRY;
1971 }
Linus Torvaldsda53be12013-05-21 15:22:44 -07001972 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07001973 return D_COMP_NOMATCH;
1974 return D_COMP_OK;
1975}
1976
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977/**
Nick Piggin31e6b012011-01-07 17:49:52 +11001978 * __d_lookup_rcu - search for a dentry (racy, store-free)
1979 * @parent: parent dentry
1980 * @name: qstr of name we wish to find
Randy Dunlap1f1e6e52012-03-18 21:23:05 -07001981 * @seqp: returns d_seq value at the point where the dentry was found
Nick Piggin31e6b012011-01-07 17:49:52 +11001982 * Returns: dentry, or NULL
1983 *
1984 * __d_lookup_rcu is the dcache lookup function for rcu-walk name
1985 * resolution (store-free path walking) design described in
1986 * Documentation/filesystems/path-lookup.txt.
1987 *
1988 * This is not to be used outside core vfs.
1989 *
1990 * __d_lookup_rcu must only be used in rcu-walk mode, ie. with vfsmount lock
1991 * held, and rcu_read_lock held. The returned dentry must not be stored into
1992 * without taking d_lock and checking d_seq sequence count against @seq
1993 * returned here.
1994 *
Linus Torvalds15570082013-09-02 11:38:06 -07001995 * A refcount may be taken on the found dentry with the d_rcu_to_refcount
Nick Piggin31e6b012011-01-07 17:49:52 +11001996 * function.
1997 *
1998 * Alternatively, __d_lookup_rcu may be called again to look up the child of
1999 * the returned dentry, so long as its parent's seqlock is checked after the
2000 * child is looked up. Thus, an interlocking stepping of sequence lock checks
2001 * is formed, giving integrity down the path walk.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002002 *
2003 * NOTE! The caller *has* to check the resulting dentry against the sequence
2004 * number we've returned before using any of the resulting dentry state!
Nick Piggin31e6b012011-01-07 17:49:52 +11002005 */
Linus Torvalds8966be92012-03-02 14:23:30 -08002006struct dentry *__d_lookup_rcu(const struct dentry *parent,
2007 const struct qstr *name,
Linus Torvaldsda53be12013-05-21 15:22:44 -07002008 unsigned *seqp)
Nick Piggin31e6b012011-01-07 17:49:52 +11002009{
Linus Torvalds26fe5752012-05-10 13:14:12 -07002010 u64 hashlen = name->hash_len;
Nick Piggin31e6b012011-01-07 17:49:52 +11002011 const unsigned char *str = name->name;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002012 struct hlist_bl_head *b = d_hash(parent, hashlen_hash(hashlen));
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002013 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002014 struct dentry *dentry;
2015
2016 /*
2017 * Note: There is significant duplication with __d_lookup_rcu which is
2018 * required to prevent single threaded performance regressions
2019 * especially on architectures where smp_rmb (in seqcounts) are costly.
2020 * Keep the two functions in sync.
2021 */
2022
2023 /*
2024 * The hash list is protected using RCU.
2025 *
2026 * Carefully use d_seq when comparing a candidate dentry, to avoid
2027 * races with d_move().
2028 *
2029 * It is possible that concurrent renames can mess up our list
2030 * walk here and result in missing our dentry, resulting in the
2031 * false-negative result. d_lookup() protects against concurrent
2032 * renames using rename_lock seqlock.
2033 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002034 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Piggin31e6b012011-01-07 17:49:52 +11002035 */
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002036 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds8966be92012-03-02 14:23:30 -08002037 unsigned seq;
Nick Piggin31e6b012011-01-07 17:49:52 +11002038
Nick Piggin31e6b012011-01-07 17:49:52 +11002039seqretry:
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002040 /*
2041 * The dentry sequence count protects us from concurrent
Linus Torvaldsda53be12013-05-21 15:22:44 -07002042 * renames, and thus protects parent and name fields.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002043 *
2044 * The caller must perform a seqcount check in order
Linus Torvaldsda53be12013-05-21 15:22:44 -07002045 * to do anything useful with the returned dentry.
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002046 *
2047 * NOTE! We do a "raw" seqcount_begin here. That means that
2048 * we don't wait for the sequence count to stabilize if it
2049 * is in the middle of a sequence change. If we do the slow
2050 * dentry compare, we will do seqretries until it is stable,
2051 * and if we end up with a successful lookup, we actually
2052 * want to exit RCU lookup anyway.
2053 */
2054 seq = raw_seqcount_begin(&dentry->d_seq);
Nick Piggin31e6b012011-01-07 17:49:52 +11002055 if (dentry->d_parent != parent)
2056 continue;
Linus Torvalds2e321802012-05-21 18:48:10 -07002057 if (d_unhashed(dentry))
2058 continue;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002059
2060 if (unlikely(parent->d_flags & DCACHE_OP_COMPARE)) {
Linus Torvalds26fe5752012-05-10 13:14:12 -07002061 if (dentry->d_name.hash != hashlen_hash(hashlen))
2062 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002063 *seqp = seq;
2064 switch (slow_dentry_cmp(parent, dentry, seq, name)) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002065 case D_COMP_OK:
2066 return dentry;
2067 case D_COMP_NOMATCH:
2068 continue;
2069 default:
2070 goto seqretry;
2071 }
2072 }
2073
Linus Torvalds26fe5752012-05-10 13:14:12 -07002074 if (dentry->d_name.hash_len != hashlen)
Linus Torvaldsee983e82012-05-10 12:37:10 -07002075 continue;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002076 *seqp = seq;
Linus Torvalds26fe5752012-05-10 13:14:12 -07002077 if (!dentry_cmp(dentry, str, hashlen_len(hashlen)))
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002078 return dentry;
Nick Piggin31e6b012011-01-07 17:49:52 +11002079 }
2080 return NULL;
2081}
2082
2083/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 * d_lookup - search for a dentry
2085 * @parent: parent dentry
2086 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10002087 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088 *
Nick Pigginb04f7842010-08-18 04:37:34 +10002089 * d_lookup searches the children of the parent dentry for the name in
2090 * question. If the dentry is found its reference count is incremented and the
2091 * dentry is returned. The caller must use dput to free the entry when it has
2092 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 */
Al Viroda2d8452013-01-24 18:29:34 -05002094struct dentry *d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095{
Nick Piggin31e6b012011-01-07 17:49:52 +11002096 struct dentry *dentry;
Nick Piggin949854d2011-01-07 17:49:37 +11002097 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098
2099 do {
2100 seq = read_seqbegin(&rename_lock);
2101 dentry = __d_lookup(parent, name);
2102 if (dentry)
2103 break;
2104 } while (read_seqretry(&rename_lock, seq));
2105 return dentry;
2106}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002107EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108
Nick Piggin31e6b012011-01-07 17:49:52 +11002109/**
Nick Pigginb04f7842010-08-18 04:37:34 +10002110 * __d_lookup - search for a dentry (racy)
2111 * @parent: parent dentry
2112 * @name: qstr of name we wish to find
2113 * Returns: dentry, or NULL
2114 *
2115 * __d_lookup is like d_lookup, however it may (rarely) return a
2116 * false-negative result due to unrelated rename activity.
2117 *
2118 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
2119 * however it must be used carefully, eg. with a following d_lookup in
2120 * the case of failure.
2121 *
2122 * __d_lookup callers must be commented.
2123 */
Al Viroa713ca22013-01-24 18:27:00 -05002124struct dentry *__d_lookup(const struct dentry *parent, const struct qstr *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125{
2126 unsigned int len = name->len;
2127 unsigned int hash = name->hash;
2128 const unsigned char *str = name->name;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002129 struct hlist_bl_head *b = d_hash(parent, hash);
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002130 struct hlist_bl_node *node;
Nick Piggin31e6b012011-01-07 17:49:52 +11002131 struct dentry *found = NULL;
Paul E. McKenney665a7582005-11-07 00:59:17 -08002132 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133
Nick Pigginb04f7842010-08-18 04:37:34 +10002134 /*
Nick Piggin31e6b012011-01-07 17:49:52 +11002135 * Note: There is significant duplication with __d_lookup_rcu which is
2136 * required to prevent single threaded performance regressions
2137 * especially on architectures where smp_rmb (in seqcounts) are costly.
2138 * Keep the two functions in sync.
2139 */
2140
2141 /*
Nick Pigginb04f7842010-08-18 04:37:34 +10002142 * The hash list is protected using RCU.
2143 *
2144 * Take d_lock when comparing a candidate dentry, to avoid races
2145 * with d_move().
2146 *
2147 * It is possible that concurrent renames can mess up our list
2148 * walk here and result in missing our dentry, resulting in the
2149 * false-negative result. d_lookup() protects against concurrent
2150 * renames using rename_lock seqlock.
2151 *
Namhyung Kimb0a4bb82011-01-22 15:31:32 +09002152 * See Documentation/filesystems/path-lookup.txt for more details.
Nick Pigginb04f7842010-08-18 04:37:34 +10002153 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 rcu_read_lock();
2155
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002156 hlist_bl_for_each_entry_rcu(dentry, node, b, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 if (dentry->d_name.hash != hash)
2159 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160
2161 spin_lock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 if (dentry->d_parent != parent)
2163 goto next;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002164 if (d_unhashed(dentry))
2165 goto next;
2166
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167 /*
2168 * It is safe to compare names since d_move() cannot
2169 * change the qstr (protected by d_lock).
2170 */
Nick Pigginfb045ad2011-01-07 17:49:55 +11002171 if (parent->d_flags & DCACHE_OP_COMPARE) {
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002172 int tlen = dentry->d_name.len;
2173 const char *tname = dentry->d_name.name;
Linus Torvaldsda53be12013-05-21 15:22:44 -07002174 if (parent->d_op->d_compare(parent, dentry, tlen, tname, name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 goto next;
2176 } else {
Linus Torvaldsee983e82012-05-10 12:37:10 -07002177 if (dentry->d_name.len != len)
2178 goto next;
Linus Torvalds12f8ad42012-05-04 14:59:14 -07002179 if (dentry_cmp(dentry, str, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 goto next;
2181 }
2182
Waiman Long98474232013-08-28 18:24:59 -07002183 dentry->d_lockref.count++;
Linus Torvaldsd0185c02008-09-29 07:42:57 -07002184 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185 spin_unlock(&dentry->d_lock);
2186 break;
2187next:
2188 spin_unlock(&dentry->d_lock);
2189 }
2190 rcu_read_unlock();
2191
2192 return found;
2193}
2194
2195/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002196 * d_hash_and_lookup - hash the qstr then search for a dentry
2197 * @dir: Directory to search in
2198 * @name: qstr of name we wish to find
2199 *
Al Viro4f522a22013-02-11 23:20:37 -05002200 * On lookup failure NULL is returned; on bad name - ERR_PTR(-error)
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002201 */
2202struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
2203{
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002204 /*
2205 * Check for a fs-specific hash function. Note that we must
2206 * calculate the standard hash first, as the d_op->d_hash()
2207 * routine may choose to leave the hash value unchanged.
2208 */
2209 name->hash = full_name_hash(name->name, name->len);
Nick Pigginfb045ad2011-01-07 17:49:55 +11002210 if (dir->d_flags & DCACHE_OP_HASH) {
Linus Torvaldsda53be12013-05-21 15:22:44 -07002211 int err = dir->d_op->d_hash(dir, name);
Al Viro4f522a22013-02-11 23:20:37 -05002212 if (unlikely(err < 0))
2213 return ERR_PTR(err);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002214 }
Al Viro4f522a22013-02-11 23:20:37 -05002215 return d_lookup(dir, name);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002216}
Al Viro4f522a22013-02-11 23:20:37 -05002217EXPORT_SYMBOL(d_hash_and_lookup);
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002218
2219/**
Nick Piggin786a5e12011-01-07 17:49:16 +11002220 * d_validate - verify dentry provided from insecure source (deprecated)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 * @dentry: The dentry alleged to be valid child of @dparent
Randy Dunlapff5fdb62011-01-22 20:16:06 -08002222 * @dparent: The parent dentry (known to be valid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 *
2224 * An insecure source has sent us a dentry, here we verify it and dget() it.
2225 * This is used by ncpfs in its readdir implementation.
2226 * Zero is returned in the dentry is invalid.
Nick Piggin786a5e12011-01-07 17:49:16 +11002227 *
2228 * This function is slow for big directories, and deprecated, do not use it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229 */
Nick Piggind3a23e12011-01-05 20:01:21 +11002230int d_validate(struct dentry *dentry, struct dentry *dparent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231{
Nick Piggin786a5e12011-01-07 17:49:16 +11002232 struct dentry *child;
Nick Piggind3a23e12011-01-05 20:01:21 +11002233
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002234 spin_lock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002235 list_for_each_entry(child, &dparent->d_subdirs, d_u.d_child) {
2236 if (dentry == child) {
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002237 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Nick Piggindc0474b2011-01-07 17:49:43 +11002238 __dget_dlock(dentry);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002239 spin_unlock(&dentry->d_lock);
2240 spin_unlock(&dparent->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241 return 1;
2242 }
2243 }
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002244 spin_unlock(&dparent->d_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11002245
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246 return 0;
2247}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002248EXPORT_SYMBOL(d_validate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249
2250/*
2251 * When a file is deleted, we have two options:
2252 * - turn this dentry into a negative dentry
2253 * - unhash this dentry and free it.
2254 *
2255 * Usually, we want to just turn this into
2256 * a negative dentry, but if anybody else is
2257 * currently using the dentry or the inode
2258 * we can't do that and we fall back on removing
2259 * it from the hash queues and waiting for
2260 * it to be deleted later when it has no users
2261 */
2262
2263/**
2264 * d_delete - delete a dentry
2265 * @dentry: The dentry to delete
2266 *
2267 * Turn the dentry into a negative dentry if possible, otherwise
2268 * remove it from the hash queues so it can be deleted later
2269 */
2270
2271void d_delete(struct dentry * dentry)
2272{
Nick Piggin873feea2011-01-07 17:50:06 +11002273 struct inode *inode;
John McCutchan7a91bf72005-08-08 13:52:16 -04002274 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 /*
2276 * Are we the only user?
2277 */
Nick Piggin357f8e62011-01-07 17:49:42 +11002278again:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279 spin_lock(&dentry->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002280 inode = dentry->d_inode;
2281 isdir = S_ISDIR(inode->i_mode);
Waiman Long98474232013-08-28 18:24:59 -07002282 if (dentry->d_lockref.count == 1) {
Alan Cox1fe0c022012-09-19 15:49:51 +01002283 if (!spin_trylock(&inode->i_lock)) {
Nick Piggin357f8e62011-01-07 17:49:42 +11002284 spin_unlock(&dentry->d_lock);
2285 cpu_relax();
2286 goto again;
2287 }
Al Viro13e3c5e2010-05-21 16:11:04 -04002288 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Nick Piggin31e6b012011-01-07 17:49:52 +11002289 dentry_unlink_inode(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04002290 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 return;
2292 }
2293
2294 if (!d_unhashed(dentry))
2295 __d_drop(dentry);
2296
2297 spin_unlock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04002298
2299 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002301EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002303static void __d_rehash(struct dentry * entry, struct hlist_bl_head *b)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304{
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002305 BUG_ON(!d_unhashed(entry));
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002306 hlist_bl_lock(b);
Linus Torvaldsdea36672011-04-24 07:58:46 -07002307 entry->d_flags |= DCACHE_RCUACCESS;
Linus Torvaldsb07ad992011-04-23 22:32:03 -07002308 hlist_bl_add_head_rcu(&entry->d_hash, b);
Christoph Hellwig1879fd62011-04-25 14:01:36 -04002309 hlist_bl_unlock(b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310}
2311
David Howells770bfad2006-08-22 20:06:07 -04002312static void _d_rehash(struct dentry * entry)
2313{
2314 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
2315}
2316
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317/**
2318 * d_rehash - add an entry back to the hash
2319 * @entry: dentry to add to the hash
2320 *
2321 * Adds a dentry to the hash according to its name.
2322 */
2323
2324void d_rehash(struct dentry * entry)
2325{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04002327 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328 spin_unlock(&entry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002330EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002332/**
2333 * dentry_update_name_case - update case insensitive dentry with a new name
2334 * @dentry: dentry to be updated
2335 * @name: new name
2336 *
2337 * Update a case insensitive dentry with new case of name.
2338 *
2339 * dentry must have been returned by d_lookup with name @name. Old and new
2340 * name lengths must match (ie. no d_compare which allows mismatched name
2341 * lengths).
2342 *
2343 * Parent inode i_mutex must be held over d_lookup and into this call (to
2344 * keep renames and concurrent inserts, and readdir(2) away).
2345 */
2346void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
2347{
Linus Torvalds7ebfa572011-04-15 07:34:26 -07002348 BUG_ON(!mutex_is_locked(&dentry->d_parent->d_inode->i_mutex));
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002349 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
2350
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002351 spin_lock(&dentry->d_lock);
Nick Piggin31e6b012011-01-07 17:49:52 +11002352 write_seqcount_begin(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002353 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
Nick Piggin31e6b012011-01-07 17:49:52 +11002354 write_seqcount_end(&dentry->d_seq);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002355 spin_unlock(&dentry->d_lock);
Nick Pigginfb2d5b82011-01-07 17:49:26 +11002356}
2357EXPORT_SYMBOL(dentry_update_name_case);
2358
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359static void switch_names(struct dentry *dentry, struct dentry *target)
2360{
2361 if (dname_external(target)) {
2362 if (dname_external(dentry)) {
2363 /*
2364 * Both external: swap the pointers
2365 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002366 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367 } else {
2368 /*
2369 * dentry:internal, target:external. Steal target's
2370 * storage and make target internal.
2371 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07002372 memcpy(target->d_iname, dentry->d_name.name,
2373 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 dentry->d_name.name = target->d_name.name;
2375 target->d_name.name = target->d_iname;
2376 }
2377 } else {
2378 if (dname_external(dentry)) {
2379 /*
2380 * dentry:external, target:internal. Give dentry's
2381 * storage to target and make dentry internal
2382 */
2383 memcpy(dentry->d_iname, target->d_name.name,
2384 target->d_name.len + 1);
2385 target->d_name.name = dentry->d_name.name;
2386 dentry->d_name.name = dentry->d_iname;
2387 } else {
2388 /*
Miklos Szeredida1ce062014-04-01 17:08:43 +02002389 * Both are internal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002391 unsigned int i;
2392 BUILD_BUG_ON(!IS_ALIGNED(DNAME_INLINE_LEN, sizeof(long)));
2393 for (i = 0; i < DNAME_INLINE_LEN / sizeof(long); i++) {
2394 swap(((long *) &dentry->d_iname)[i],
2395 ((long *) &target->d_iname)[i]);
2396 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397 }
2398 }
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002399 swap(dentry->d_name.len, target->d_name.len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400}
2401
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002402static void dentry_lock_for_move(struct dentry *dentry, struct dentry *target)
2403{
2404 /*
2405 * XXXX: do we really need to take target->d_lock?
2406 */
2407 if (IS_ROOT(dentry) || dentry->d_parent == target->d_parent)
2408 spin_lock(&target->d_parent->d_lock);
2409 else {
2410 if (d_ancestor(dentry->d_parent, target->d_parent)) {
2411 spin_lock(&dentry->d_parent->d_lock);
2412 spin_lock_nested(&target->d_parent->d_lock,
2413 DENTRY_D_LOCK_NESTED);
2414 } else {
2415 spin_lock(&target->d_parent->d_lock);
2416 spin_lock_nested(&dentry->d_parent->d_lock,
2417 DENTRY_D_LOCK_NESTED);
2418 }
2419 }
2420 if (target < dentry) {
2421 spin_lock_nested(&target->d_lock, 2);
2422 spin_lock_nested(&dentry->d_lock, 3);
2423 } else {
2424 spin_lock_nested(&dentry->d_lock, 2);
2425 spin_lock_nested(&target->d_lock, 3);
2426 }
2427}
2428
2429static void dentry_unlock_parents_for_move(struct dentry *dentry,
2430 struct dentry *target)
2431{
2432 if (target->d_parent != dentry->d_parent)
2433 spin_unlock(&dentry->d_parent->d_lock);
2434 if (target->d_parent != target)
2435 spin_unlock(&target->d_parent->d_lock);
2436}
2437
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438/*
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002439 * When switching names, the actual string doesn't strictly have to
2440 * be preserved in the target - because we're dropping the target
2441 * anyway. As such, we can just do a simple memcpy() to copy over
2442 * the new name before we switch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443 *
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002444 * Note that we have to be a lot more careful about getting the hash
2445 * switched - we have to switch the hash value properly even if it
2446 * then no longer matches the actual (corrupted) string of the target.
2447 * The hash value has to match the hash queue that the dentry is on..
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002449/*
Al Viro18367502011-07-12 21:42:24 -04002450 * __d_move - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07002451 * @dentry: entry to move
2452 * @target: new dentry
Miklos Szeredida1ce062014-04-01 17:08:43 +02002453 * @exchange: exchange the two dentries
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454 *
2455 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002456 * dcache entries should not be moved in this way. Caller must hold
2457 * rename_lock, the i_mutex of the source and target directories,
2458 * and the sb->s_vfs_rename_mutex if they differ. See lock_rename().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459 */
Miklos Szeredida1ce062014-04-01 17:08:43 +02002460static void __d_move(struct dentry *dentry, struct dentry *target,
2461 bool exchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 if (!dentry->d_inode)
2464 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
2465
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002466 BUG_ON(d_ancestor(dentry, target));
2467 BUG_ON(d_ancestor(target, dentry));
2468
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002469 dentry_lock_for_move(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470
Nick Piggin31e6b012011-01-07 17:49:52 +11002471 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002472 write_seqcount_begin_nested(&target->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002473
Nick Pigginceb5bdc2011-01-07 17:50:05 +11002474 /* __d_drop does write_seqcount_barrier, but they're OK to nest. */
2475
2476 /*
2477 * Move the dentry to the target hash queue. Don't bother checking
2478 * for the same hash queue because of how unlikely it is.
2479 */
2480 __d_drop(dentry);
Nick Piggin789680d2011-01-07 17:49:30 +11002481 __d_rehash(dentry, d_hash(target->d_parent, target->d_name.hash));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482
Miklos Szeredida1ce062014-04-01 17:08:43 +02002483 /*
2484 * Unhash the target (d_delete() is not usable here). If exchanging
2485 * the two dentries, then rehash onto the other's hash queue.
2486 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002487 __d_drop(target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002488 if (exchange) {
2489 __d_rehash(target,
2490 d_hash(dentry->d_parent, dentry->d_name.hash));
2491 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492
Eric Dumazet5160ee62006-01-08 01:03:32 -08002493 list_del(&dentry->d_u.d_child);
2494 list_del(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002495
2496 /* Switch the names.. */
2497 switch_names(dentry, target);
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002498 swap(dentry->d_name.hash, target->d_name.hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002499
2500 /* ... and switch the parents */
2501 if (IS_ROOT(dentry)) {
2502 dentry->d_parent = target->d_parent;
2503 target->d_parent = target;
Eric Dumazet5160ee62006-01-08 01:03:32 -08002504 INIT_LIST_HEAD(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002505 } else {
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08002506 swap(dentry->d_parent, target->d_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507
2508 /* And add them back to the (new) parent lists */
Eric Dumazet5160ee62006-01-08 01:03:32 -08002509 list_add(&target->d_u.d_child, &target->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510 }
2511
Eric Dumazet5160ee62006-01-08 01:03:32 -08002512 list_add(&dentry->d_u.d_child, &dentry->d_parent->d_subdirs);
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002513
Nick Piggin31e6b012011-01-07 17:49:52 +11002514 write_seqcount_end(&target->d_seq);
2515 write_seqcount_end(&dentry->d_seq);
2516
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002517 dentry_unlock_parents_for_move(dentry, target);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002518 if (exchange)
2519 fsnotify_d_move(target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520 spin_unlock(&target->d_lock);
Nick Pigginc32ccd82006-03-25 03:07:09 -08002521 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522 spin_unlock(&dentry->d_lock);
Al Viro18367502011-07-12 21:42:24 -04002523}
2524
2525/*
2526 * d_move - move a dentry
2527 * @dentry: entry to move
2528 * @target: new dentry
2529 *
2530 * Update the dcache to reflect the move of a file name. Negative
Jeff Laytonc46c8872011-07-26 13:33:16 -04002531 * dcache entries should not be moved in this way. See the locking
2532 * requirements for __d_move.
Al Viro18367502011-07-12 21:42:24 -04002533 */
2534void d_move(struct dentry *dentry, struct dentry *target)
2535{
2536 write_seqlock(&rename_lock);
Miklos Szeredida1ce062014-04-01 17:08:43 +02002537 __d_move(dentry, target, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002538 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002539}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002540EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002541
Miklos Szeredida1ce062014-04-01 17:08:43 +02002542/*
2543 * d_exchange - exchange two dentries
2544 * @dentry1: first dentry
2545 * @dentry2: second dentry
2546 */
2547void d_exchange(struct dentry *dentry1, struct dentry *dentry2)
2548{
2549 write_seqlock(&rename_lock);
2550
2551 WARN_ON(!dentry1->d_inode);
2552 WARN_ON(!dentry2->d_inode);
2553 WARN_ON(IS_ROOT(dentry1));
2554 WARN_ON(IS_ROOT(dentry2));
2555
2556 __d_move(dentry1, dentry2, true);
2557
2558 write_sequnlock(&rename_lock);
2559}
2560
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002561/**
2562 * d_ancestor - search for an ancestor
2563 * @p1: ancestor dentry
2564 * @p2: child dentry
2565 *
2566 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
2567 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07002568 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002569struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002570{
2571 struct dentry *p;
2572
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09002573 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07002574 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002575 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002576 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002577 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07002578}
2579
2580/*
2581 * This helper attempts to cope with remotely renamed directories
2582 *
2583 * It assumes that the caller is already holding
Al Viro18367502011-07-12 21:42:24 -04002584 * dentry->d_parent->d_inode->i_mutex, inode->i_lock and rename_lock
Trond Myklebust9eaef272006-10-21 10:24:20 -07002585 *
2586 * Note: If ever the locking in lock_rename() changes, then please
2587 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07002588 */
Nick Piggin873feea2011-01-07 17:50:06 +11002589static struct dentry *__d_unalias(struct inode *inode,
2590 struct dentry *dentry, struct dentry *alias)
Trond Myklebust9eaef272006-10-21 10:24:20 -07002591{
2592 struct mutex *m1 = NULL, *m2 = NULL;
Al Viroee3efa92012-06-08 15:59:33 -04002593 struct dentry *ret = ERR_PTR(-EBUSY);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002594
2595 /* If alias and dentry share a parent, then no extra locks required */
2596 if (alias->d_parent == dentry->d_parent)
2597 goto out_unalias;
2598
Trond Myklebust9eaef272006-10-21 10:24:20 -07002599 /* See lock_rename() */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002600 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
2601 goto out_err;
2602 m1 = &dentry->d_sb->s_vfs_rename_mutex;
2603 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
2604 goto out_err;
2605 m2 = &alias->d_parent->d_inode->i_mutex;
2606out_unalias:
Al Viroee3efa92012-06-08 15:59:33 -04002607 if (likely(!d_mountpoint(alias))) {
Miklos Szeredida1ce062014-04-01 17:08:43 +02002608 __d_move(alias, dentry, false);
Al Viroee3efa92012-06-08 15:59:33 -04002609 ret = alias;
2610 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002611out_err:
Nick Piggin873feea2011-01-07 17:50:06 +11002612 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002613 if (m2)
2614 mutex_unlock(m2);
2615 if (m1)
2616 mutex_unlock(m1);
2617 return ret;
2618}
2619
2620/*
David Howells770bfad2006-08-22 20:06:07 -04002621 * Prepare an anonymous dentry for life in the superblock's dentry tree as a
2622 * named dentry in place of the dentry to be replaced.
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002623 * returns with anon->d_lock held!
David Howells770bfad2006-08-22 20:06:07 -04002624 */
2625static void __d_materialise_dentry(struct dentry *dentry, struct dentry *anon)
2626{
Al Viro740da422013-01-30 10:13:38 -05002627 struct dentry *dparent;
David Howells770bfad2006-08-22 20:06:07 -04002628
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002629 dentry_lock_for_move(anon, dentry);
David Howells770bfad2006-08-22 20:06:07 -04002630
Nick Piggin31e6b012011-01-07 17:49:52 +11002631 write_seqcount_begin(&dentry->d_seq);
John Stultz1ca7d672013-10-07 15:51:59 -07002632 write_seqcount_begin_nested(&anon->d_seq, DENTRY_D_LOCK_NESTED);
Nick Piggin31e6b012011-01-07 17:49:52 +11002633
David Howells770bfad2006-08-22 20:06:07 -04002634 dparent = dentry->d_parent;
David Howells770bfad2006-08-22 20:06:07 -04002635
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002636 switch_names(dentry, anon);
2637 swap(dentry->d_name.hash, anon->d_name.hash);
2638
Al Viro740da422013-01-30 10:13:38 -05002639 dentry->d_parent = dentry;
2640 list_del_init(&dentry->d_u.d_child);
2641 anon->d_parent = dparent;
Wei Yongjun9ed53b12013-03-12 00:10:50 +08002642 list_move(&anon->d_u.d_child, &dparent->d_subdirs);
David Howells770bfad2006-08-22 20:06:07 -04002643
Nick Piggin31e6b012011-01-07 17:49:52 +11002644 write_seqcount_end(&dentry->d_seq);
2645 write_seqcount_end(&anon->d_seq);
2646
Nick Piggin2fd6b7f2011-01-07 17:49:34 +11002647 dentry_unlock_parents_for_move(anon, dentry);
2648 spin_unlock(&dentry->d_lock);
2649
2650 /* anon->d_lock still locked, returns locked */
David Howells770bfad2006-08-22 20:06:07 -04002651}
2652
2653/**
2654 * d_materialise_unique - introduce an inode into the tree
2655 * @dentry: candidate dentry
2656 * @inode: inode to bind to the dentry, to which aliases may be attached
2657 *
2658 * Introduces an dentry into the tree, substituting an extant disconnected
Jeff Laytonc46c8872011-07-26 13:33:16 -04002659 * root directory alias in its place if there is one. Caller must hold the
2660 * i_mutex of the parent directory.
David Howells770bfad2006-08-22 20:06:07 -04002661 */
2662struct dentry *d_materialise_unique(struct dentry *dentry, struct inode *inode)
2663{
Trond Myklebust9eaef272006-10-21 10:24:20 -07002664 struct dentry *actual;
David Howells770bfad2006-08-22 20:06:07 -04002665
2666 BUG_ON(!d_unhashed(dentry));
2667
David Howells770bfad2006-08-22 20:06:07 -04002668 if (!inode) {
2669 actual = dentry;
OGAWA Hirofumi360da902008-10-16 07:50:28 +09002670 __d_instantiate(dentry, NULL);
Nick Piggin357f8e62011-01-07 17:49:42 +11002671 d_rehash(actual);
2672 goto out_nolock;
David Howells770bfad2006-08-22 20:06:07 -04002673 }
2674
Nick Piggin873feea2011-01-07 17:50:06 +11002675 spin_lock(&inode->i_lock);
Nick Piggin357f8e62011-01-07 17:49:42 +11002676
Trond Myklebust9eaef272006-10-21 10:24:20 -07002677 if (S_ISDIR(inode->i_mode)) {
2678 struct dentry *alias;
David Howells770bfad2006-08-22 20:06:07 -04002679
Trond Myklebust9eaef272006-10-21 10:24:20 -07002680 /* Does an aliased dentry already exist? */
Linus Torvalds32ba9c32012-06-08 10:34:03 -07002681 alias = __d_find_alias(inode, 0);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002682 if (alias) {
2683 actual = alias;
Al Viro18367502011-07-12 21:42:24 -04002684 write_seqlock(&rename_lock);
2685
2686 if (d_ancestor(alias, dentry)) {
2687 /* Check for loops */
2688 actual = ERR_PTR(-ELOOP);
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002689 spin_unlock(&inode->i_lock);
Al Viro18367502011-07-12 21:42:24 -04002690 } else if (IS_ROOT(alias)) {
2691 /* Is this an anonymous mountpoint that we
2692 * could splice into our tree? */
Trond Myklebust9eaef272006-10-21 10:24:20 -07002693 __d_materialise_dentry(dentry, alias);
Al Viro18367502011-07-12 21:42:24 -04002694 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002695 __d_drop(alias);
2696 goto found;
Al Viro18367502011-07-12 21:42:24 -04002697 } else {
2698 /* Nope, but we must(!) avoid directory
Michel Lespinasseb18dafc2012-03-26 17:32:44 -07002699 * aliasing. This drops inode->i_lock */
Al Viro18367502011-07-12 21:42:24 -04002700 actual = __d_unalias(inode, dentry, alias);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002701 }
Al Viro18367502011-07-12 21:42:24 -04002702 write_sequnlock(&rename_lock);
David Howellsdd179942011-08-16 15:31:30 +01002703 if (IS_ERR(actual)) {
2704 if (PTR_ERR(actual) == -ELOOP)
2705 pr_warn_ratelimited(
2706 "VFS: Lookup of '%s' in %s %s"
2707 " would have caused loop\n",
2708 dentry->d_name.name,
2709 inode->i_sb->s_type->name,
2710 inode->i_sb->s_id);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002711 dput(alias);
David Howellsdd179942011-08-16 15:31:30 +01002712 }
Trond Myklebust9eaef272006-10-21 10:24:20 -07002713 goto out_nolock;
2714 }
David Howells770bfad2006-08-22 20:06:07 -04002715 }
2716
2717 /* Add a unique reference */
2718 actual = __d_instantiate_unique(dentry, inode);
2719 if (!actual)
2720 actual = dentry;
Nick Piggin357f8e62011-01-07 17:49:42 +11002721 else
2722 BUG_ON(!d_unhashed(actual));
David Howells770bfad2006-08-22 20:06:07 -04002723
David Howells770bfad2006-08-22 20:06:07 -04002724 spin_lock(&actual->d_lock);
2725found:
2726 _d_rehash(actual);
2727 spin_unlock(&actual->d_lock);
Nick Piggin873feea2011-01-07 17:50:06 +11002728 spin_unlock(&inode->i_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07002729out_nolock:
David Howells770bfad2006-08-22 20:06:07 -04002730 if (actual == dentry) {
2731 security_d_instantiate(dentry, inode);
2732 return NULL;
2733 }
2734
2735 iput(inode);
2736 return actual;
David Howells770bfad2006-08-22 20:06:07 -04002737}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002738EXPORT_SYMBOL_GPL(d_materialise_unique);
David Howells770bfad2006-08-22 20:06:07 -04002739
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002740static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01002741{
2742 *buflen -= namelen;
2743 if (*buflen < 0)
2744 return -ENAMETOOLONG;
2745 *buffer -= namelen;
2746 memcpy(*buffer, str, namelen);
2747 return 0;
2748}
2749
Waiman Long232d2d62013-09-09 12:18:13 -04002750/**
2751 * prepend_name - prepend a pathname in front of current buffer pointer
Waiman Long18129972013-09-12 10:55:35 -04002752 * @buffer: buffer pointer
2753 * @buflen: allocated length of the buffer
2754 * @name: name string and length qstr structure
Waiman Long232d2d62013-09-09 12:18:13 -04002755 *
2756 * With RCU path tracing, it may race with d_move(). Use ACCESS_ONCE() to
2757 * make sure that either the old or the new name pointer and length are
2758 * fetched. However, there may be mismatch between length and pointer.
2759 * The length cannot be trusted, we need to copy it byte-by-byte until
2760 * the length is reached or a null byte is found. It also prepends "/" at
2761 * the beginning of the name. The sequence number check at the caller will
2762 * retry it again when a d_move() does happen. So any garbage in the buffer
2763 * due to mismatched pointer and length will be discarded.
2764 */
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002765static int prepend_name(char **buffer, int *buflen, struct qstr *name)
2766{
Waiman Long232d2d62013-09-09 12:18:13 -04002767 const char *dname = ACCESS_ONCE(name->name);
2768 u32 dlen = ACCESS_ONCE(name->len);
2769 char *p;
2770
Waiman Long232d2d62013-09-09 12:18:13 -04002771 *buflen -= dlen + 1;
Al Viroe8251962014-03-23 00:28:40 -04002772 if (*buflen < 0)
2773 return -ENAMETOOLONG;
Waiman Long232d2d62013-09-09 12:18:13 -04002774 p = *buffer -= dlen + 1;
2775 *p++ = '/';
2776 while (dlen--) {
2777 char c = *dname++;
2778 if (!c)
2779 break;
2780 *p++ = c;
2781 }
2782 return 0;
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002783}
2784
Linus Torvalds1da177e2005-04-16 15:20:36 -07002785/**
Randy Dunlap208898c2010-11-18 15:02:49 -08002786 * prepend_path - Prepend path string to a buffer
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002787 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002788 * @root: root vfsmnt/dentry
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002789 * @buffer: pointer to the end of the buffer
2790 * @buflen: pointer to buffer length
2791 *
Waiman Long18129972013-09-12 10:55:35 -04002792 * The function will first try to write out the pathname without taking any
2793 * lock other than the RCU read lock to make sure that dentries won't go away.
2794 * It only checks the sequence number of the global rename_lock as any change
2795 * in the dentry's d_seq will be preceded by changes in the rename_lock
2796 * sequence number. If the sequence number had been changed, it will restart
2797 * the whole pathname back-tracing sequence again by taking the rename_lock.
2798 * In this case, there is no need to take the RCU read lock as the recursive
2799 * parent pointer references will keep the dentry chain alive as long as no
2800 * rename operation is performed.
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002801 */
Al Viro02125a82011-12-05 08:43:34 -05002802static int prepend_path(const struct path *path,
2803 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002804 char **buffer, int *buflen)
2805{
Al Viroede4ceb2013-11-13 07:45:40 -05002806 struct dentry *dentry;
2807 struct vfsmount *vfsmnt;
2808 struct mount *mnt;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002809 int error = 0;
Al Viro48a066e2013-09-29 22:06:07 -04002810 unsigned seq, m_seq = 0;
Waiman Long232d2d62013-09-09 12:18:13 -04002811 char *bptr;
2812 int blen;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002813
Al Viro48f5ec22013-09-09 15:22:25 -04002814 rcu_read_lock();
Al Viro48a066e2013-09-29 22:06:07 -04002815restart_mnt:
2816 read_seqbegin_or_lock(&mount_lock, &m_seq);
2817 seq = 0;
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002818 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04002819restart:
2820 bptr = *buffer;
2821 blen = *buflen;
Al Viro48a066e2013-09-29 22:06:07 -04002822 error = 0;
Al Viroede4ceb2013-11-13 07:45:40 -05002823 dentry = path->dentry;
2824 vfsmnt = path->mnt;
2825 mnt = real_mount(vfsmnt);
Waiman Long232d2d62013-09-09 12:18:13 -04002826 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002827 while (dentry != root->dentry || vfsmnt != root->mnt) {
2828 struct dentry * parent;
2829
2830 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
Al Viro48a066e2013-09-29 22:06:07 -04002831 struct mount *parent = ACCESS_ONCE(mnt->mnt_parent);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002832 /* Global root? */
Al Viro48a066e2013-09-29 22:06:07 -04002833 if (mnt != parent) {
2834 dentry = ACCESS_ONCE(mnt->mnt_mountpoint);
2835 mnt = parent;
Waiman Long232d2d62013-09-09 12:18:13 -04002836 vfsmnt = &mnt->mnt;
2837 continue;
2838 }
2839 /*
2840 * Filesystems needing to implement special "root names"
2841 * should do so with ->d_dname()
2842 */
2843 if (IS_ROOT(dentry) &&
2844 (dentry->d_name.len != 1 ||
2845 dentry->d_name.name[0] != '/')) {
2846 WARN(1, "Root dentry has weird name <%.*s>\n",
2847 (int) dentry->d_name.len,
2848 dentry->d_name.name);
2849 }
2850 if (!error)
2851 error = is_mounted(vfsmnt) ? 1 : 2;
2852 break;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002853 }
2854 parent = dentry->d_parent;
2855 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04002856 error = prepend_name(&bptr, &blen, &dentry->d_name);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002857 if (error)
2858 break;
2859
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002860 dentry = parent;
2861 }
Al Viro48f5ec22013-09-09 15:22:25 -04002862 if (!(seq & 1))
2863 rcu_read_unlock();
2864 if (need_seqretry(&rename_lock, seq)) {
2865 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04002866 goto restart;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002867 }
Al Viro48f5ec22013-09-09 15:22:25 -04002868 done_seqretry(&rename_lock, seq);
Li Zhong4ec6c2a2013-11-13 15:21:51 +08002869
2870 if (!(m_seq & 1))
2871 rcu_read_unlock();
Al Viro48a066e2013-09-29 22:06:07 -04002872 if (need_seqretry(&mount_lock, m_seq)) {
2873 m_seq = 1;
2874 goto restart_mnt;
2875 }
2876 done_seqretry(&mount_lock, m_seq);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002877
Waiman Long232d2d62013-09-09 12:18:13 -04002878 if (error >= 0 && bptr == *buffer) {
2879 if (--blen < 0)
2880 error = -ENAMETOOLONG;
2881 else
2882 *--bptr = '/';
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002883 }
Waiman Long232d2d62013-09-09 12:18:13 -04002884 *buffer = bptr;
2885 *buflen = blen;
Al Viro7ea600b2013-03-26 18:25:57 -04002886 return error;
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002887}
2888
2889/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002890 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002891 * @path: the dentry/vfsmount to report
Al Viro02125a82011-12-05 08:43:34 -05002892 * @root: root vfsmnt/dentry
Randy Dunlapcd956a12010-08-14 13:05:31 -07002893 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07002894 * @buflen: buffer length
2895 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002896 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002897 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002898 * Returns a pointer into the buffer or an error code if the
2899 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08002900 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04002901 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002902 *
Al Viro02125a82011-12-05 08:43:34 -05002903 * If the path is not reachable from the supplied root, return %NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002904 */
Al Viro02125a82011-12-05 08:43:34 -05002905char *__d_path(const struct path *path,
2906 const struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002907 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002908{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002909 char *res = buf + buflen;
2910 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002911
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002912 prepend(&res, &buflen, "\0", 1);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002913 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002914
Al Viro02125a82011-12-05 08:43:34 -05002915 if (error < 0)
2916 return ERR_PTR(error);
2917 if (error > 0)
2918 return NULL;
2919 return res;
2920}
2921
2922char *d_absolute_path(const struct path *path,
2923 char *buf, int buflen)
2924{
2925 struct path root = {};
2926 char *res = buf + buflen;
2927 int error;
2928
2929 prepend(&res, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05002930 error = prepend_path(path, &root, &res, &buflen);
Al Viro02125a82011-12-05 08:43:34 -05002931
2932 if (error > 1)
2933 error = -EINVAL;
2934 if (error < 0)
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002935 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002936 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002937}
2938
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002939/*
2940 * same as __d_path but appends "(deleted)" for unlinked files.
2941 */
Al Viro02125a82011-12-05 08:43:34 -05002942static int path_with_deleted(const struct path *path,
2943 const struct path *root,
2944 char **buf, int *buflen)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002945{
2946 prepend(buf, buflen, "\0", 1);
2947 if (d_unlinked(path->dentry)) {
2948 int error = prepend(buf, buflen, " (deleted)", 10);
2949 if (error)
2950 return error;
2951 }
2952
2953 return prepend_path(path, root, buf, buflen);
2954}
2955
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002956static int prepend_unreachable(char **buffer, int *buflen)
2957{
2958 return prepend(buffer, buflen, "(unreachable)", 13);
2959}
2960
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07002961static void get_fs_root_rcu(struct fs_struct *fs, struct path *root)
2962{
2963 unsigned seq;
2964
2965 do {
2966 seq = read_seqcount_begin(&fs->seq);
2967 *root = fs->root;
2968 } while (read_seqcount_retry(&fs->seq, seq));
2969}
2970
Jan Bluncka03a8a702008-02-14 19:38:32 -08002971/**
2972 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08002973 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08002974 * @buf: buffer to return value in
2975 * @buflen: buffer length
2976 *
2977 * Convert a dentry into an ASCII path name. If the entry has been deleted
2978 * the string " (deleted)" is appended. Note that this is ambiguous.
2979 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002980 * Returns a pointer into the buffer or an error code if the path was
2981 * too long. Note: Callers should use the returned pointer, not the passed
2982 * in buffer, to use the name! The implementation often starts at an offset
2983 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002984 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002985 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002986 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07002987char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002988{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002989 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08002990 struct path root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002991 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002992
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002993 /*
2994 * We have various synthetic filesystems that never get mounted. On
2995 * these filesystems dentries are never used for lookup purposes, and
2996 * thus don't need to be hashed. They also don't need a name until a
2997 * user wants to identify the object in /proc/pid/fd/. The little hack
2998 * below allows us to generate a name for these objects on demand:
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08002999 *
3000 * Some pseudo inodes are mountable. When they are mounted
3001 * path->dentry == path->mnt->mnt_root. In that case don't call d_dname
3002 * and instead have d_path return the mounted path.
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003003 */
Eric W. Biedermanf48cfdd2013-11-08 16:31:29 -08003004 if (path->dentry->d_op && path->dentry->d_op->d_dname &&
3005 (!IS_ROOT(path->dentry) || path->dentry != path->mnt->mnt_root))
Jan Blunckcf28b482008-02-14 19:38:44 -08003006 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003007
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003008 rcu_read_lock();
3009 get_fs_root_rcu(current->fs, &root);
Al Viro02125a82011-12-05 08:43:34 -05003010 error = path_with_deleted(path, &root, &res, &buflen);
Linus Torvalds68f0d9d2013-09-12 13:24:55 -07003011 rcu_read_unlock();
3012
Al Viro02125a82011-12-05 08:43:34 -05003013 if (error < 0)
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02003014 res = ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003015 return res;
3016}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003017EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003018
3019/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003020 * Helper function for dentry_operations.d_dname() members
3021 */
3022char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
3023 const char *fmt, ...)
3024{
3025 va_list args;
3026 char temp[64];
3027 int sz;
3028
3029 va_start(args, fmt);
3030 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
3031 va_end(args);
3032
3033 if (sz > sizeof(temp) || sz > buflen)
3034 return ERR_PTR(-ENAMETOOLONG);
3035
3036 buffer += buflen - sz;
3037 return memcpy(buffer, temp, sz);
3038}
3039
Al Viro118b2302013-08-24 12:08:17 -04003040char *simple_dname(struct dentry *dentry, char *buffer, int buflen)
3041{
3042 char *end = buffer + buflen;
3043 /* these dentries are never renamed, so d_lock is not needed */
3044 if (prepend(&end, &buflen, " (deleted)", 11) ||
Waiman Long232d2d62013-09-09 12:18:13 -04003045 prepend(&end, &buflen, dentry->d_name.name, dentry->d_name.len) ||
Al Viro118b2302013-08-24 12:08:17 -04003046 prepend(&end, &buflen, "/", 1))
3047 end = ERR_PTR(-ENAMETOOLONG);
Waiman Long232d2d62013-09-09 12:18:13 -04003048 return end;
Al Viro118b2302013-08-24 12:08:17 -04003049}
David Herrmann31bbe162014-01-03 14:09:47 +01003050EXPORT_SYMBOL(simple_dname);
Al Viro118b2302013-08-24 12:08:17 -04003051
Eric Dumazetc23fbb62007-05-08 00:26:18 -07003052/*
Ram Pai6092d042008-03-27 13:06:20 +01003053 * Write full pathname from the root of the filesystem into the buffer.
3054 */
Al Virof6500802014-01-26 12:37:55 -05003055static char *__dentry_path(struct dentry *d, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01003056{
Al Virof6500802014-01-26 12:37:55 -05003057 struct dentry *dentry;
Waiman Long232d2d62013-09-09 12:18:13 -04003058 char *end, *retval;
3059 int len, seq = 0;
3060 int error = 0;
Ram Pai6092d042008-03-27 13:06:20 +01003061
Al Virof6500802014-01-26 12:37:55 -05003062 if (buflen < 2)
3063 goto Elong;
3064
Al Viro48f5ec22013-09-09 15:22:25 -04003065 rcu_read_lock();
Waiman Long232d2d62013-09-09 12:18:13 -04003066restart:
Al Virof6500802014-01-26 12:37:55 -05003067 dentry = d;
Waiman Long232d2d62013-09-09 12:18:13 -04003068 end = buf + buflen;
3069 len = buflen;
3070 prepend(&end, &len, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01003071 /* Get '/' right */
3072 retval = end-1;
3073 *retval = '/';
Waiman Long232d2d62013-09-09 12:18:13 -04003074 read_seqbegin_or_lock(&rename_lock, &seq);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02003075 while (!IS_ROOT(dentry)) {
3076 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01003077
Ram Pai6092d042008-03-27 13:06:20 +01003078 prefetch(parent);
Waiman Long232d2d62013-09-09 12:18:13 -04003079 error = prepend_name(&end, &len, &dentry->d_name);
3080 if (error)
3081 break;
Ram Pai6092d042008-03-27 13:06:20 +01003082
3083 retval = end;
3084 dentry = parent;
3085 }
Al Viro48f5ec22013-09-09 15:22:25 -04003086 if (!(seq & 1))
3087 rcu_read_unlock();
3088 if (need_seqretry(&rename_lock, seq)) {
3089 seq = 1;
Waiman Long232d2d62013-09-09 12:18:13 -04003090 goto restart;
Al Viro48f5ec22013-09-09 15:22:25 -04003091 }
3092 done_seqretry(&rename_lock, seq);
Waiman Long232d2d62013-09-09 12:18:13 -04003093 if (error)
3094 goto Elong;
Al Viroc1031352010-06-06 22:31:14 -04003095 return retval;
3096Elong:
3097 return ERR_PTR(-ENAMETOOLONG);
3098}
Nick Pigginec2447c2011-01-07 17:49:29 +11003099
3100char *dentry_path_raw(struct dentry *dentry, char *buf, int buflen)
3101{
Waiman Long232d2d62013-09-09 12:18:13 -04003102 return __dentry_path(dentry, buf, buflen);
Nick Pigginec2447c2011-01-07 17:49:29 +11003103}
3104EXPORT_SYMBOL(dentry_path_raw);
Al Viroc1031352010-06-06 22:31:14 -04003105
3106char *dentry_path(struct dentry *dentry, char *buf, int buflen)
3107{
3108 char *p = NULL;
3109 char *retval;
3110
Al Viroc1031352010-06-06 22:31:14 -04003111 if (d_unlinked(dentry)) {
3112 p = buf + buflen;
3113 if (prepend(&p, &buflen, "//deleted", 10) != 0)
3114 goto Elong;
3115 buflen++;
3116 }
3117 retval = __dentry_path(dentry, buf, buflen);
Al Viroc1031352010-06-06 22:31:14 -04003118 if (!IS_ERR(retval) && p)
3119 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01003120 return retval;
3121Elong:
Ram Pai6092d042008-03-27 13:06:20 +01003122 return ERR_PTR(-ENAMETOOLONG);
3123}
3124
Linus Torvalds8b19e342013-09-12 10:35:47 -07003125static void get_fs_root_and_pwd_rcu(struct fs_struct *fs, struct path *root,
3126 struct path *pwd)
Linus Torvalds57624822013-09-12 10:12:47 -07003127{
Linus Torvalds8b19e342013-09-12 10:35:47 -07003128 unsigned seq;
3129
3130 do {
3131 seq = read_seqcount_begin(&fs->seq);
3132 *root = fs->root;
3133 *pwd = fs->pwd;
3134 } while (read_seqcount_retry(&fs->seq, seq));
Linus Torvalds57624822013-09-12 10:12:47 -07003135}
3136
Ram Pai6092d042008-03-27 13:06:20 +01003137/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003138 * NOTE! The user-level library version returns a
3139 * character pointer. The kernel system call just
3140 * returns the length of the buffer filled (which
3141 * includes the ending '\0' character), or a negative
3142 * error value. So libc would do something like
3143 *
3144 * char *getcwd(char * buf, size_t size)
3145 * {
3146 * int retval;
3147 *
3148 * retval = sys_getcwd(buf, size);
3149 * if (retval >= 0)
3150 * return buf;
3151 * errno = -retval;
3152 * return NULL;
3153 * }
3154 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01003155SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003156{
Linus Torvalds552ce542007-02-13 12:08:18 -08003157 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08003158 struct path pwd, root;
Linus Torvalds3272c542013-09-12 12:40:15 -07003159 char *page = __getname();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003160
3161 if (!page)
3162 return -ENOMEM;
3163
Linus Torvalds8b19e342013-09-12 10:35:47 -07003164 rcu_read_lock();
3165 get_fs_root_and_pwd_rcu(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003166
Linus Torvalds552ce542007-02-13 12:08:18 -08003167 error = -ENOENT;
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04003168 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08003169 unsigned long len;
Linus Torvalds3272c542013-09-12 12:40:15 -07003170 char *cwd = page + PATH_MAX;
3171 int buflen = PATH_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003172
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003173 prepend(&cwd, &buflen, "\0", 1);
Al Viro02125a82011-12-05 08:43:34 -05003174 error = prepend_path(&pwd, &root, &cwd, &buflen);
Linus Torvaldsff812d72013-09-12 11:57:01 -07003175 rcu_read_unlock();
Linus Torvalds552ce542007-02-13 12:08:18 -08003176
Al Viro02125a82011-12-05 08:43:34 -05003177 if (error < 0)
Linus Torvalds552ce542007-02-13 12:08:18 -08003178 goto out;
3179
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003180 /* Unreachable from current root */
Al Viro02125a82011-12-05 08:43:34 -05003181 if (error > 0) {
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02003182 error = prepend_unreachable(&cwd, &buflen);
3183 if (error)
3184 goto out;
3185 }
3186
Linus Torvalds552ce542007-02-13 12:08:18 -08003187 error = -ERANGE;
Linus Torvalds3272c542013-09-12 12:40:15 -07003188 len = PATH_MAX + page - cwd;
Linus Torvalds552ce542007-02-13 12:08:18 -08003189 if (len <= size) {
3190 error = len;
3191 if (copy_to_user(buf, cwd, len))
3192 error = -EFAULT;
3193 }
Nick Piggin949854d2011-01-07 17:49:37 +11003194 } else {
Linus Torvaldsff812d72013-09-12 11:57:01 -07003195 rcu_read_unlock();
Nick Piggin949854d2011-01-07 17:49:37 +11003196 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003197
3198out:
Linus Torvalds3272c542013-09-12 12:40:15 -07003199 __putname(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003200 return error;
3201}
3202
3203/*
3204 * Test whether new_dentry is a subdirectory of old_dentry.
3205 *
3206 * Trivially implemented using the dcache structure
3207 */
3208
3209/**
3210 * is_subdir - is new dentry a subdirectory of old_dentry
3211 * @new_dentry: new dentry
3212 * @old_dentry: old dentry
3213 *
3214 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
3215 * Returns 0 otherwise.
3216 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
3217 */
3218
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003219int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003220{
3221 int result;
Nick Piggin949854d2011-01-07 17:49:37 +11003222 unsigned seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003223
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003224 if (new_dentry == old_dentry)
3225 return 1;
3226
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003227 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003228 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003229 seq = read_seqbegin(&rename_lock);
Nick Piggin949854d2011-01-07 17:49:37 +11003230 /*
3231 * Need rcu_readlock to protect against the d_parent trashing
3232 * due to d_move
3233 */
3234 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003235 if (d_ancestor(old_dentry, new_dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003236 result = 1;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09003237 else
3238 result = 0;
Nick Piggin949854d2011-01-07 17:49:37 +11003239 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003240 } while (read_seqretry(&rename_lock, seq));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003241
3242 return result;
3243}
3244
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003245static enum d_walk_ret d_genocide_kill(void *data, struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003246{
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003247 struct dentry *root = data;
3248 if (dentry != root) {
3249 if (d_unhashed(dentry) || !dentry->d_inode)
3250 return D_WALK_SKIP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003251
Miklos Szeredi01ddc4e2013-09-05 11:44:34 +02003252 if (!(dentry->d_flags & DCACHE_GENOCIDE)) {
3253 dentry->d_flags |= DCACHE_GENOCIDE;
3254 dentry->d_lockref.count--;
3255 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003256 }
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003257 return D_WALK_CONTINUE;
3258}
Nick Piggin58db63d2011-01-07 17:49:39 +11003259
Miklos Szeredidb14fc32013-09-05 11:44:35 +02003260void d_genocide(struct dentry *parent)
3261{
3262 d_walk(parent, parent, d_genocide_kill, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003263}
3264
Al Viro60545d02013-06-07 01:20:27 -04003265void d_tmpfile(struct dentry *dentry, struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003266{
Al Viro60545d02013-06-07 01:20:27 -04003267 inode_dec_link_count(inode);
3268 BUG_ON(dentry->d_name.name != dentry->d_iname ||
3269 !hlist_unhashed(&dentry->d_alias) ||
3270 !d_unlinked(dentry));
3271 spin_lock(&dentry->d_parent->d_lock);
3272 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
3273 dentry->d_name.len = sprintf(dentry->d_iname, "#%llu",
3274 (unsigned long long)inode->i_ino);
3275 spin_unlock(&dentry->d_lock);
3276 spin_unlock(&dentry->d_parent->d_lock);
3277 d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003278}
Al Viro60545d02013-06-07 01:20:27 -04003279EXPORT_SYMBOL(d_tmpfile);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003280
3281static __initdata unsigned long dhash_entries;
3282static int __init set_dhash_entries(char *str)
3283{
3284 if (!str)
3285 return 0;
3286 dhash_entries = simple_strtoul(str, &str, 0);
3287 return 1;
3288}
3289__setup("dhash_entries=", set_dhash_entries);
3290
3291static void __init dcache_init_early(void)
3292{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003293 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003294
3295 /* If hashes are distributed across NUMA nodes, defer
3296 * hash allocation until vmalloc space is available.
3297 */
3298 if (hashdist)
3299 return;
3300
3301 dentry_hashtable =
3302 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003303 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003304 dhash_entries,
3305 13,
3306 HASH_EARLY,
3307 &d_hash_shift,
3308 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003309 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003310 0);
3311
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003312 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003313 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003314}
3315
Denis Cheng74bf17c2007-10-16 23:26:30 -07003316static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003317{
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003318 unsigned int loop;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003319
3320 /*
3321 * A constructor could be added for stable state like the lists,
3322 * but it is probably not worth it because of the cache nature
3323 * of the dcache.
3324 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07003325 dentry_cache = KMEM_CACHE(dentry,
3326 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003327
3328 /* Hash may have been set up in dcache_init_early */
3329 if (!hashdist)
3330 return;
3331
3332 dentry_hashtable =
3333 alloc_large_system_hash("Dentry cache",
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003334 sizeof(struct hlist_bl_head),
Linus Torvalds1da177e2005-04-16 15:20:36 -07003335 dhash_entries,
3336 13,
3337 0,
3338 &d_hash_shift,
3339 &d_hash_mask,
Tim Bird31fe62b2012-05-23 13:33:35 +00003340 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003341 0);
3342
Dimitri Sivanich074b8512012-02-08 12:39:07 -08003343 for (loop = 0; loop < (1U << d_hash_shift); loop++)
Linus Torvaldsb07ad992011-04-23 22:32:03 -07003344 INIT_HLIST_BL_HEAD(dentry_hashtable + loop);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003345}
3346
3347/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08003348struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07003349EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003350
Linus Torvalds1da177e2005-04-16 15:20:36 -07003351EXPORT_SYMBOL(d_genocide);
3352
Linus Torvalds1da177e2005-04-16 15:20:36 -07003353void __init vfs_caches_init_early(void)
3354{
3355 dcache_init_early();
3356 inode_init_early();
3357}
3358
3359void __init vfs_caches_init(unsigned long mempages)
3360{
3361 unsigned long reserve;
3362
3363 /* Base hash sizes on available memory, with a reserve equal to
3364 150% of current kernel size */
3365
3366 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
3367 mempages -= reserve;
3368
3369 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09003370 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003371
Denis Cheng74bf17c2007-10-16 23:26:30 -07003372 dcache_init();
3373 inode_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003374 files_init(mempages);
Denis Cheng74bf17c2007-10-16 23:26:30 -07003375 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003376 bdev_cache_init();
3377 chrdev_init();
3378}