blob: 814e5f491e9c51462802f6408f5bf42a4843528f [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>
26#include <linux/module.h>
27#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>
David Howells07f3f052006-09-30 20:52:18 +020036#include "internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Eric Dumazetfa3536c2006-03-26 01:37:24 -080038int sysctl_vfs_cache_pressure __read_mostly = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -070039EXPORT_SYMBOL_GPL(sysctl_vfs_cache_pressure);
40
41 __cacheline_aligned_in_smp DEFINE_SPINLOCK(dcache_lock);
Al Viro74c3cbe2007-07-22 08:04:18 -040042__cacheline_aligned_in_smp DEFINE_SEQLOCK(rename_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
44EXPORT_SYMBOL(dcache_lock);
45
Christoph Lametere18b8902006-12-06 20:33:20 -080046static struct kmem_cache *dentry_cache __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48#define DNAME_INLINE_LEN (sizeof(struct dentry)-offsetof(struct dentry,d_iname))
49
50/*
51 * This is the single most critical data structure when it comes
52 * to the dcache: the hashtable for lookups. Somebody should try
53 * to make this good - I've just made it work.
54 *
55 * This hash-function tries to avoid losing too many bits of hash
56 * information, yet avoid using a prime hash-size or similar.
57 */
58#define D_HASHBITS d_hash_shift
59#define D_HASHMASK d_hash_mask
60
Eric Dumazetfa3536c2006-03-26 01:37:24 -080061static unsigned int d_hash_mask __read_mostly;
62static unsigned int d_hash_shift __read_mostly;
63static struct hlist_head *dentry_hashtable __read_mostly;
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
65/* Statistics gathering. */
66struct dentry_stat_t dentry_stat = {
67 .age_limit = 45,
68};
69
Nick Piggin3e880fb2011-01-07 17:49:19 +110070static DEFINE_PER_CPU(unsigned int, nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -040071
72#if defined(CONFIG_SYSCTL) && defined(CONFIG_PROC_FS)
Nick Piggin3e880fb2011-01-07 17:49:19 +110073static int get_nr_dentry(void)
74{
75 int i;
76 int sum = 0;
77 for_each_possible_cpu(i)
78 sum += per_cpu(nr_dentry, i);
79 return sum < 0 ? 0 : sum;
80}
81
Christoph Hellwig312d3ca2010-10-10 05:36:23 -040082int proc_nr_dentry(ctl_table *table, int write, void __user *buffer,
83 size_t *lenp, loff_t *ppos)
84{
Nick Piggin3e880fb2011-01-07 17:49:19 +110085 dentry_stat.nr_dentry = get_nr_dentry();
Christoph Hellwig312d3ca2010-10-10 05:36:23 -040086 return proc_dointvec(table, write, buffer, lenp, ppos);
87}
88#endif
89
Christoph Hellwig9c82ab92010-10-10 05:36:22 -040090static void __d_free(struct rcu_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -070091{
Christoph Hellwig9c82ab92010-10-10 05:36:22 -040092 struct dentry *dentry = container_of(head, struct dentry, d_u.d_rcu);
93
Arjan van de Venfd217f42008-10-21 06:47:33 -070094 WARN_ON(!list_empty(&dentry->d_alias));
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 if (dname_external(dentry))
96 kfree(dentry->d_name.name);
97 kmem_cache_free(dentry_cache, dentry);
98}
99
100/*
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400101 * no dcache_lock, please.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 */
103static void d_free(struct dentry *dentry)
104{
Nick Piggin3e880fb2011-01-07 17:49:19 +1100105 this_cpu_dec(nr_dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 if (dentry->d_op && dentry->d_op->d_release)
107 dentry->d_op->d_release(dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400108
Eric Dumazetb3423412006-12-06 20:38:48 -0800109 /* if dentry was never inserted into hash, immediate free is OK */
Akinobu Mitae8462ca2008-02-06 01:37:07 -0800110 if (hlist_unhashed(&dentry->d_hash))
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400111 __d_free(&dentry->d_u.d_rcu);
Eric Dumazetb3423412006-12-06 20:38:48 -0800112 else
Christoph Hellwig9c82ab92010-10-10 05:36:22 -0400113 call_rcu(&dentry->d_u.d_rcu, __d_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114}
115
116/*
117 * Release the dentry's inode, using the filesystem
118 * d_iput() operation if defined.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 */
Arjan van de Ven858119e2006-01-14 13:20:43 -0800120static void dentry_iput(struct dentry * dentry)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200121 __releases(dentry->d_lock)
122 __releases(dcache_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123{
124 struct inode *inode = dentry->d_inode;
125 if (inode) {
126 dentry->d_inode = NULL;
127 list_del_init(&dentry->d_alias);
128 spin_unlock(&dentry->d_lock);
129 spin_unlock(&dcache_lock);
Linus Torvaldsf805fbd2005-09-19 19:54:29 -0700130 if (!inode->i_nlink)
131 fsnotify_inoderemove(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 if (dentry->d_op && dentry->d_op->d_iput)
133 dentry->d_op->d_iput(dentry, inode);
134 else
135 iput(inode);
136 } else {
137 spin_unlock(&dentry->d_lock);
138 spin_unlock(&dcache_lock);
139 }
140}
141
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700142/*
Christoph Hellwiga4633352010-10-10 05:36:26 -0400143 * dentry_lru_(add|del|move_tail) must be called with dcache_lock held.
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700144 */
145static void dentry_lru_add(struct dentry *dentry)
146{
Christoph Hellwiga4633352010-10-10 05:36:26 -0400147 if (list_empty(&dentry->d_lru)) {
148 list_add(&dentry->d_lru, &dentry->d_sb->s_dentry_lru);
149 dentry->d_sb->s_nr_dentry_unused++;
Nick Piggin86c87492011-01-07 17:49:18 +1100150 dentry_stat.nr_unused++;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400151 }
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700152}
153
154static void dentry_lru_del(struct dentry *dentry)
155{
156 if (!list_empty(&dentry->d_lru)) {
Christoph Hellwiga4633352010-10-10 05:36:26 -0400157 list_del_init(&dentry->d_lru);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700158 dentry->d_sb->s_nr_dentry_unused--;
Nick Piggin86c87492011-01-07 17:49:18 +1100159 dentry_stat.nr_unused--;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700160 }
161}
162
Christoph Hellwiga4633352010-10-10 05:36:26 -0400163static void dentry_lru_move_tail(struct dentry *dentry)
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700164{
Christoph Hellwiga4633352010-10-10 05:36:26 -0400165 if (list_empty(&dentry->d_lru)) {
166 list_add_tail(&dentry->d_lru, &dentry->d_sb->s_dentry_lru);
167 dentry->d_sb->s_nr_dentry_unused++;
Nick Piggin86c87492011-01-07 17:49:18 +1100168 dentry_stat.nr_unused++;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400169 } else {
170 list_move_tail(&dentry->d_lru, &dentry->d_sb->s_dentry_lru);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700171 }
172}
173
Miklos Szeredid52b9082007-05-08 00:23:46 -0700174/**
175 * d_kill - kill dentry and return parent
176 * @dentry: dentry to kill
177 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200178 * The dentry must already be unhashed and removed from the LRU.
Miklos Szeredid52b9082007-05-08 00:23:46 -0700179 *
180 * If this is the root of the dentry tree, return NULL.
181 */
182static struct dentry *d_kill(struct dentry *dentry)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200183 __releases(dentry->d_lock)
184 __releases(dcache_lock)
Miklos Szeredid52b9082007-05-08 00:23:46 -0700185{
186 struct dentry *parent;
187
188 list_del(&dentry->d_u.d_child);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700189 /*drops the locks, at that point nobody can reach this dentry */
190 dentry_iput(dentry);
OGAWA Hirofumi871c0062008-10-16 07:50:27 +0900191 if (IS_ROOT(dentry))
192 parent = NULL;
193 else
194 parent = dentry->d_parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700195 d_free(dentry);
OGAWA Hirofumi871c0062008-10-16 07:50:27 +0900196 return parent;
Miklos Szeredid52b9082007-05-08 00:23:46 -0700197}
198
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199/*
200 * This is dput
201 *
202 * This is complicated by the fact that we do not want to put
203 * dentries that are no longer on any hash chain on the unused
204 * list: we'd much rather just get rid of them immediately.
205 *
206 * However, that implies that we have to traverse the dentry
207 * tree upwards to the parents which might _also_ now be
208 * scheduled for deletion (it may have been only waiting for
209 * its last child to go away).
210 *
211 * This tail recursion is done by hand as we don't want to depend
212 * on the compiler to always get this right (gcc generally doesn't).
213 * Real recursion would eat up our stack space.
214 */
215
216/*
217 * dput - release a dentry
218 * @dentry: dentry to release
219 *
220 * Release a dentry. This will drop the usage count and if appropriate
221 * call the dentry unlink method as well as removing it from the queues and
222 * releasing its resources. If the parent dentries were scheduled for release
223 * they too may now get deleted.
224 *
225 * no dcache lock, please.
226 */
227
228void dput(struct dentry *dentry)
229{
230 if (!dentry)
231 return;
232
233repeat:
234 if (atomic_read(&dentry->d_count) == 1)
235 might_sleep();
236 if (!atomic_dec_and_lock(&dentry->d_count, &dcache_lock))
237 return;
238
239 spin_lock(&dentry->d_lock);
240 if (atomic_read(&dentry->d_count)) {
241 spin_unlock(&dentry->d_lock);
242 spin_unlock(&dcache_lock);
243 return;
244 }
245
246 /*
247 * AV: ->d_delete() is _NOT_ allowed to block now.
248 */
249 if (dentry->d_op && dentry->d_op->d_delete) {
250 if (dentry->d_op->d_delete(dentry))
251 goto unhash_it;
252 }
Nick Piggin265ac902010-10-10 05:36:24 -0400253
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 /* Unreachable? Get rid of it */
255 if (d_unhashed(dentry))
256 goto kill_it;
Nick Piggin265ac902010-10-10 05:36:24 -0400257
258 /* Otherwise leave it cached and ensure it's on the LRU */
259 dentry->d_flags |= DCACHE_REFERENCED;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400260 dentry_lru_add(dentry);
Nick Piggin265ac902010-10-10 05:36:24 -0400261
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 spin_unlock(&dentry->d_lock);
263 spin_unlock(&dcache_lock);
264 return;
265
266unhash_it:
267 __d_drop(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700268kill_it:
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700269 /* if dentry was on the d_lru list delete it from there */
270 dentry_lru_del(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700271 dentry = d_kill(dentry);
272 if (dentry)
273 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700275EXPORT_SYMBOL(dput);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
277/**
278 * d_invalidate - invalidate a dentry
279 * @dentry: dentry to invalidate
280 *
281 * Try to invalidate the dentry if it turns out to be
282 * possible. If there are other dentries that can be
283 * reached through this one we can't delete it and we
284 * return -EBUSY. On success we return 0.
285 *
286 * no dcache lock.
287 */
288
289int d_invalidate(struct dentry * dentry)
290{
291 /*
292 * If it's already been dropped, return OK.
293 */
294 spin_lock(&dcache_lock);
295 if (d_unhashed(dentry)) {
296 spin_unlock(&dcache_lock);
297 return 0;
298 }
299 /*
300 * Check whether to do a partial shrink_dcache
301 * to get rid of unused child entries.
302 */
303 if (!list_empty(&dentry->d_subdirs)) {
304 spin_unlock(&dcache_lock);
305 shrink_dcache_parent(dentry);
306 spin_lock(&dcache_lock);
307 }
308
309 /*
310 * Somebody else still using it?
311 *
312 * If it's a directory, we can't drop it
313 * for fear of somebody re-populating it
314 * with children (even though dropping it
315 * would make it unreachable from the root,
316 * we might still populate it if it was a
317 * working directory or similar).
318 */
319 spin_lock(&dentry->d_lock);
320 if (atomic_read(&dentry->d_count) > 1) {
321 if (dentry->d_inode && S_ISDIR(dentry->d_inode->i_mode)) {
322 spin_unlock(&dentry->d_lock);
323 spin_unlock(&dcache_lock);
324 return -EBUSY;
325 }
326 }
327
328 __d_drop(dentry);
329 spin_unlock(&dentry->d_lock);
330 spin_unlock(&dcache_lock);
331 return 0;
332}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700333EXPORT_SYMBOL(d_invalidate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
335/* This should be called _only_ with dcache_lock held */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336static inline struct dentry * __dget_locked(struct dentry *dentry)
337{
338 atomic_inc(&dentry->d_count);
Christoph Hellwiga4633352010-10-10 05:36:26 -0400339 dentry_lru_del(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 return dentry;
341}
342
343struct dentry * dget_locked(struct dentry *dentry)
344{
345 return __dget_locked(dentry);
346}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700347EXPORT_SYMBOL(dget_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349/**
350 * d_find_alias - grab a hashed alias of inode
351 * @inode: inode in question
352 * @want_discon: flag, used by d_splice_alias, to request
353 * that only a DISCONNECTED alias be returned.
354 *
355 * If inode has a hashed alias, or is a directory and has any alias,
356 * acquire the reference to alias and return it. Otherwise return NULL.
357 * Notice that if inode is a directory there can be only one alias and
358 * it can be unhashed only if it has no children, or if it is the root
359 * of a filesystem.
360 *
NeilBrown21c0d8f2006-10-04 02:16:16 -0700361 * If the inode has an IS_ROOT, DCACHE_DISCONNECTED alias, then prefer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 * any other hashed alias over that one unless @want_discon is set,
NeilBrown21c0d8f2006-10-04 02:16:16 -0700363 * in which case only return an IS_ROOT, DCACHE_DISCONNECTED alias.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 */
365
366static struct dentry * __d_find_alias(struct inode *inode, int want_discon)
367{
368 struct list_head *head, *next, *tmp;
369 struct dentry *alias, *discon_alias=NULL;
370
371 head = &inode->i_dentry;
372 next = inode->i_dentry.next;
373 while (next != head) {
374 tmp = next;
375 next = tmp->next;
376 prefetch(next);
377 alias = list_entry(tmp, struct dentry, d_alias);
378 if (S_ISDIR(inode->i_mode) || !d_unhashed(alias)) {
NeilBrown21c0d8f2006-10-04 02:16:16 -0700379 if (IS_ROOT(alias) &&
380 (alias->d_flags & DCACHE_DISCONNECTED))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 discon_alias = alias;
382 else if (!want_discon) {
383 __dget_locked(alias);
384 return alias;
385 }
386 }
387 }
388 if (discon_alias)
389 __dget_locked(discon_alias);
390 return discon_alias;
391}
392
393struct dentry * d_find_alias(struct inode *inode)
394{
David Howells214fda12006-03-25 03:06:36 -0800395 struct dentry *de = NULL;
396
397 if (!list_empty(&inode->i_dentry)) {
398 spin_lock(&dcache_lock);
399 de = __d_find_alias(inode, 0);
400 spin_unlock(&dcache_lock);
401 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 return de;
403}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700404EXPORT_SYMBOL(d_find_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
406/*
407 * Try to kill dentries associated with this inode.
408 * WARNING: you must own a reference to inode.
409 */
410void d_prune_aliases(struct inode *inode)
411{
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700412 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413restart:
414 spin_lock(&dcache_lock);
Domen Puncer0cdca3f2005-09-10 00:27:07 -0700415 list_for_each_entry(dentry, &inode->i_dentry, d_alias) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 spin_lock(&dentry->d_lock);
417 if (!atomic_read(&dentry->d_count)) {
418 __dget_locked(dentry);
419 __d_drop(dentry);
420 spin_unlock(&dentry->d_lock);
421 spin_unlock(&dcache_lock);
422 dput(dentry);
423 goto restart;
424 }
425 spin_unlock(&dentry->d_lock);
426 }
427 spin_unlock(&dcache_lock);
428}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700429EXPORT_SYMBOL(d_prune_aliases);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430
431/*
Andrew Mortond702ccb2006-06-22 14:47:31 -0700432 * Throw away a dentry - free the inode, dput the parent. This requires that
433 * the LRU list has already been removed.
434 *
Miklos Szeredi85864e12007-10-16 23:27:09 -0700435 * Try to prune ancestors as well. This is necessary to prevent
436 * quadratic behavior of shrink_dcache_parent(), but is also expected
437 * to be beneficial in reducing dentry cache fragmentation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 */
Miklos Szeredi85864e12007-10-16 23:27:09 -0700439static void prune_one_dentry(struct dentry * dentry)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +0200440 __releases(dentry->d_lock)
441 __releases(dcache_lock)
442 __acquires(dcache_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 __d_drop(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700445 dentry = d_kill(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700446
447 /*
448 * Prune ancestors. Locking is simpler than in dput(),
449 * because dcache_lock needs to be taken anyway.
450 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 spin_lock(&dcache_lock);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700452 while (dentry) {
453 if (!atomic_dec_and_lock(&dentry->d_count, &dentry->d_lock))
454 return;
455
Christoph Hellwiga4633352010-10-10 05:36:26 -0400456 dentry_lru_del(dentry);
Miklos Szeredid52b9082007-05-08 00:23:46 -0700457 __d_drop(dentry);
458 dentry = d_kill(dentry);
459 spin_lock(&dcache_lock);
460 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461}
462
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400463static void shrink_dentry_list(struct list_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464{
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700465 struct dentry *dentry;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700466
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400467 while (!list_empty(list)) {
468 dentry = list_entry(list->prev, struct dentry, d_lru);
Christoph Hellwiga4633352010-10-10 05:36:26 -0400469 dentry_lru_del(dentry);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400470
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 /*
472 * We found an inuse dentry which was not removed from
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700473 * the LRU because of laziness during lookup. Do not free
474 * it - just keep it off the LRU list.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400476 spin_lock(&dentry->d_lock);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700477 if (atomic_read(&dentry->d_count)) {
478 spin_unlock(&dentry->d_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 continue;
480 }
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700481 prune_one_dentry(dentry);
482 /* dentry->d_lock was dropped in prune_one_dentry() */
483 cond_resched_lock(&dcache_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 }
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400485}
486
487/**
488 * __shrink_dcache_sb - shrink the dentry LRU on a given superblock
489 * @sb: superblock to shrink dentry LRU.
490 * @count: number of entries to prune
491 * @flags: flags to control the dentry processing
492 *
493 * If flags contains DCACHE_REFERENCED reference dentries will not be pruned.
494 */
495static void __shrink_dcache_sb(struct super_block *sb, int *count, int flags)
496{
497 /* called from prune_dcache() and shrink_dcache_parent() */
498 struct dentry *dentry;
499 LIST_HEAD(referenced);
500 LIST_HEAD(tmp);
501 int cnt = *count;
502
503 spin_lock(&dcache_lock);
504 while (!list_empty(&sb->s_dentry_lru)) {
505 dentry = list_entry(sb->s_dentry_lru.prev,
506 struct dentry, d_lru);
507 BUG_ON(dentry->d_sb != sb);
508
509 /*
510 * If we are honouring the DCACHE_REFERENCED flag and the
511 * dentry has this flag set, don't free it. Clear the flag
512 * and put it back on the LRU.
513 */
514 if (flags & DCACHE_REFERENCED) {
515 spin_lock(&dentry->d_lock);
516 if (dentry->d_flags & DCACHE_REFERENCED) {
517 dentry->d_flags &= ~DCACHE_REFERENCED;
518 list_move(&dentry->d_lru, &referenced);
519 spin_unlock(&dentry->d_lock);
520 cond_resched_lock(&dcache_lock);
521 continue;
522 }
523 spin_unlock(&dentry->d_lock);
524 }
525
526 list_move_tail(&dentry->d_lru, &tmp);
527 if (!--cnt)
528 break;
529 cond_resched_lock(&dcache_lock);
530 }
531
532 *count = cnt;
533 shrink_dentry_list(&tmp);
534
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700535 if (!list_empty(&referenced))
536 list_splice(&referenced, &sb->s_dentry_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 spin_unlock(&dcache_lock);
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400538
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539}
540
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700541/**
542 * prune_dcache - shrink the dcache
543 * @count: number of entries to try to free
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 *
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700545 * Shrink the dcache. This is done when we need more memory, or simply when we
546 * need to unmount something (at which point we need to unuse all dentries).
547 *
548 * This function may fail to free any resources if all the dentries are in use.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 */
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700550static void prune_dcache(int count)
551{
Al Virodca33252010-07-25 02:31:46 +0400552 struct super_block *sb, *p = NULL;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700553 int w_count;
Nick Piggin86c87492011-01-07 17:49:18 +1100554 int unused = dentry_stat.nr_unused;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700555 int prune_ratio;
556 int pruned;
557
558 if (unused == 0 || count == 0)
559 return;
560 spin_lock(&dcache_lock);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700561 if (count >= unused)
562 prune_ratio = 1;
563 else
564 prune_ratio = unused / count;
565 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400566 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viro551de6f2010-03-22 19:36:35 -0400567 if (list_empty(&sb->s_instances))
568 continue;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700569 if (sb->s_nr_dentry_unused == 0)
570 continue;
571 sb->s_count++;
572 /* Now, we reclaim unused dentrins with fairness.
573 * We reclaim them same percentage from each superblock.
574 * We calculate number of dentries to scan on this sb
575 * as follows, but the implementation is arranged to avoid
576 * overflows:
577 * number of dentries to scan on this sb =
578 * count * (number of dentries on this sb /
579 * number of dentries in the machine)
580 */
581 spin_unlock(&sb_lock);
582 if (prune_ratio != 1)
583 w_count = (sb->s_nr_dentry_unused / prune_ratio) + 1;
584 else
585 w_count = sb->s_nr_dentry_unused;
586 pruned = w_count;
587 /*
588 * We need to be sure this filesystem isn't being unmounted,
589 * otherwise we could race with generic_shutdown_super(), and
590 * end up holding a reference to an inode while the filesystem
591 * is unmounted. So we try to get s_umount, and make sure
592 * s_root isn't NULL.
593 */
594 if (down_read_trylock(&sb->s_umount)) {
595 if ((sb->s_root != NULL) &&
596 (!list_empty(&sb->s_dentry_lru))) {
597 spin_unlock(&dcache_lock);
598 __shrink_dcache_sb(sb, &w_count,
599 DCACHE_REFERENCED);
600 pruned -= w_count;
601 spin_lock(&dcache_lock);
602 }
603 up_read(&sb->s_umount);
604 }
605 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400606 if (p)
607 __put_super(p);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700608 count -= pruned;
Al Virodca33252010-07-25 02:31:46 +0400609 p = sb;
Al Viro79893c12010-03-22 20:27:55 -0400610 /* more work left to do? */
611 if (count <= 0)
612 break;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700613 }
Al Virodca33252010-07-25 02:31:46 +0400614 if (p)
615 __put_super(p);
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700616 spin_unlock(&sb_lock);
617 spin_unlock(&dcache_lock);
618}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
620/**
621 * shrink_dcache_sb - shrink dcache for a superblock
622 * @sb: superblock
623 *
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400624 * Shrink the dcache for the specified super block. This is used to free
625 * the dcache before unmounting a file system.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 */
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400627void shrink_dcache_sb(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628{
Christoph Hellwig3049cfe2010-10-10 05:36:25 -0400629 LIST_HEAD(tmp);
630
631 spin_lock(&dcache_lock);
632 while (!list_empty(&sb->s_dentry_lru)) {
633 list_splice_init(&sb->s_dentry_lru, &tmp);
634 shrink_dentry_list(&tmp);
635 }
636 spin_unlock(&dcache_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700638EXPORT_SYMBOL(shrink_dcache_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639
640/*
David Howellsc636ebd2006-10-11 01:22:19 -0700641 * destroy a single subtree of dentries for unmount
642 * - see the comments on shrink_dcache_for_umount() for a description of the
643 * locking
644 */
645static void shrink_dcache_for_umount_subtree(struct dentry *dentry)
646{
647 struct dentry *parent;
David Howellsf8713572006-10-28 10:38:46 -0700648 unsigned detached = 0;
David Howellsc636ebd2006-10-11 01:22:19 -0700649
650 BUG_ON(!IS_ROOT(dentry));
651
652 /* detach this root from the system */
653 spin_lock(&dcache_lock);
Christoph Hellwiga4633352010-10-10 05:36:26 -0400654 dentry_lru_del(dentry);
David Howellsc636ebd2006-10-11 01:22:19 -0700655 __d_drop(dentry);
656 spin_unlock(&dcache_lock);
657
658 for (;;) {
659 /* descend to the first leaf in the current subtree */
660 while (!list_empty(&dentry->d_subdirs)) {
661 struct dentry *loop;
662
663 /* this is a branch with children - detach all of them
664 * from the system in one go */
665 spin_lock(&dcache_lock);
666 list_for_each_entry(loop, &dentry->d_subdirs,
667 d_u.d_child) {
Christoph Hellwiga4633352010-10-10 05:36:26 -0400668 dentry_lru_del(loop);
David Howellsc636ebd2006-10-11 01:22:19 -0700669 __d_drop(loop);
670 cond_resched_lock(&dcache_lock);
671 }
672 spin_unlock(&dcache_lock);
673
674 /* move to the first child */
675 dentry = list_entry(dentry->d_subdirs.next,
676 struct dentry, d_u.d_child);
677 }
678
679 /* consume the dentries from this leaf up through its parents
680 * until we find one with children or run out altogether */
681 do {
682 struct inode *inode;
683
684 if (atomic_read(&dentry->d_count) != 0) {
685 printk(KERN_ERR
686 "BUG: Dentry %p{i=%lx,n=%s}"
687 " still in use (%d)"
688 " [unmount of %s %s]\n",
689 dentry,
690 dentry->d_inode ?
691 dentry->d_inode->i_ino : 0UL,
692 dentry->d_name.name,
693 atomic_read(&dentry->d_count),
694 dentry->d_sb->s_type->name,
695 dentry->d_sb->s_id);
696 BUG();
697 }
698
OGAWA Hirofumi871c0062008-10-16 07:50:27 +0900699 if (IS_ROOT(dentry))
David Howellsc636ebd2006-10-11 01:22:19 -0700700 parent = NULL;
OGAWA Hirofumi871c0062008-10-16 07:50:27 +0900701 else {
702 parent = dentry->d_parent;
David Howellsc636ebd2006-10-11 01:22:19 -0700703 atomic_dec(&parent->d_count);
OGAWA Hirofumi871c0062008-10-16 07:50:27 +0900704 }
David Howellsc636ebd2006-10-11 01:22:19 -0700705
706 list_del(&dentry->d_u.d_child);
David Howellsf8713572006-10-28 10:38:46 -0700707 detached++;
David Howellsc636ebd2006-10-11 01:22:19 -0700708
709 inode = dentry->d_inode;
710 if (inode) {
711 dentry->d_inode = NULL;
712 list_del_init(&dentry->d_alias);
713 if (dentry->d_op && dentry->d_op->d_iput)
714 dentry->d_op->d_iput(dentry, inode);
715 else
716 iput(inode);
717 }
718
719 d_free(dentry);
720
721 /* finished when we fall off the top of the tree,
722 * otherwise we ascend to the parent and move to the
723 * next sibling if there is one */
724 if (!parent)
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400725 return;
David Howellsc636ebd2006-10-11 01:22:19 -0700726 dentry = parent;
David Howellsc636ebd2006-10-11 01:22:19 -0700727 } while (list_empty(&dentry->d_subdirs));
728
729 dentry = list_entry(dentry->d_subdirs.next,
730 struct dentry, d_u.d_child);
731 }
732}
733
734/*
735 * destroy the dentries attached to a superblock on unmounting
736 * - we don't need to use dentry->d_lock, and only need dcache_lock when
737 * removing the dentry from the system lists and hashes because:
738 * - the superblock is detached from all mountings and open files, so the
739 * dentry trees will not be rearranged by the VFS
740 * - s_umount is write-locked, so the memory pressure shrinker will ignore
741 * any dentries belonging to this superblock that it comes across
742 * - the filesystem itself is no longer permitted to rearrange the dentries
743 * in this superblock
744 */
745void shrink_dcache_for_umount(struct super_block *sb)
746{
747 struct dentry *dentry;
748
749 if (down_read_trylock(&sb->s_umount))
750 BUG();
751
752 dentry = sb->s_root;
753 sb->s_root = NULL;
754 atomic_dec(&dentry->d_count);
755 shrink_dcache_for_umount_subtree(dentry);
756
757 while (!hlist_empty(&sb->s_anon)) {
758 dentry = hlist_entry(sb->s_anon.first, struct dentry, d_hash);
759 shrink_dcache_for_umount_subtree(dentry);
760 }
761}
762
763/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 * Search for at least 1 mount point in the dentry's subdirs.
765 * We descend to the next level whenever the d_subdirs
766 * list is non-empty and continue searching.
767 */
768
769/**
770 * have_submounts - check for mounts over a dentry
771 * @parent: dentry to check.
772 *
773 * Return true if the parent or its subdirectories contain
774 * a mount point
775 */
776
777int have_submounts(struct dentry *parent)
778{
779 struct dentry *this_parent = parent;
780 struct list_head *next;
781
782 spin_lock(&dcache_lock);
783 if (d_mountpoint(parent))
784 goto positive;
785repeat:
786 next = this_parent->d_subdirs.next;
787resume:
788 while (next != &this_parent->d_subdirs) {
789 struct list_head *tmp = next;
Eric Dumazet5160ee62006-01-08 01:03:32 -0800790 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 next = tmp->next;
792 /* Have we found a mount point ? */
793 if (d_mountpoint(dentry))
794 goto positive;
795 if (!list_empty(&dentry->d_subdirs)) {
796 this_parent = dentry;
797 goto repeat;
798 }
799 }
800 /*
801 * All done at this level ... ascend and resume the search.
802 */
803 if (this_parent != parent) {
Eric Dumazet5160ee62006-01-08 01:03:32 -0800804 next = this_parent->d_u.d_child.next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 this_parent = this_parent->d_parent;
806 goto resume;
807 }
808 spin_unlock(&dcache_lock);
809 return 0; /* No mount points found in tree */
810positive:
811 spin_unlock(&dcache_lock);
812 return 1;
813}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700814EXPORT_SYMBOL(have_submounts);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815
816/*
817 * Search the dentry child list for the specified parent,
818 * and move any unused dentries to the end of the unused
819 * list for prune_dcache(). We descend to the next level
820 * whenever the d_subdirs list is non-empty and continue
821 * searching.
822 *
823 * It returns zero iff there are no unused children,
824 * otherwise it returns the number of children moved to
825 * the end of the unused list. This may not be the total
826 * number of unused children, because select_parent can
827 * drop the lock and return early due to latency
828 * constraints.
829 */
830static int select_parent(struct dentry * parent)
831{
832 struct dentry *this_parent = parent;
833 struct list_head *next;
834 int found = 0;
835
836 spin_lock(&dcache_lock);
837repeat:
838 next = this_parent->d_subdirs.next;
839resume:
840 while (next != &this_parent->d_subdirs) {
841 struct list_head *tmp = next;
Eric Dumazet5160ee62006-01-08 01:03:32 -0800842 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 next = tmp->next;
844
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 /*
846 * move only zero ref count dentries to the end
847 * of the unused list for prune_dcache
848 */
849 if (!atomic_read(&dentry->d_count)) {
Christoph Hellwiga4633352010-10-10 05:36:26 -0400850 dentry_lru_move_tail(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 found++;
Christoph Hellwiga4633352010-10-10 05:36:26 -0400852 } else {
853 dentry_lru_del(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 }
855
856 /*
857 * We can return to the caller if we have found some (this
858 * ensures forward progress). We'll be coming back to find
859 * the rest.
860 */
861 if (found && need_resched())
862 goto out;
863
864 /*
865 * Descend a level if the d_subdirs list is non-empty.
866 */
867 if (!list_empty(&dentry->d_subdirs)) {
868 this_parent = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 goto repeat;
870 }
871 }
872 /*
873 * All done at this level ... ascend and resume the search.
874 */
875 if (this_parent != parent) {
Eric Dumazet5160ee62006-01-08 01:03:32 -0800876 next = this_parent->d_u.d_child.next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 this_parent = this_parent->d_parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 goto resume;
879 }
880out:
881 spin_unlock(&dcache_lock);
882 return found;
883}
884
885/**
886 * shrink_dcache_parent - prune dcache
887 * @parent: parent of entries to prune
888 *
889 * Prune the dcache to remove unused children of the parent dentry.
890 */
891
892void shrink_dcache_parent(struct dentry * parent)
893{
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700894 struct super_block *sb = parent->d_sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 int found;
896
897 while ((found = select_parent(parent)) != 0)
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700898 __shrink_dcache_sb(sb, &found, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700900EXPORT_SYMBOL(shrink_dcache_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902/*
903 * Scan `nr' dentries and return the number which remain.
904 *
905 * We need to avoid reentering the filesystem if the caller is performing a
906 * GFP_NOFS allocation attempt. One example deadlock is:
907 *
908 * ext2_new_block->getblk->GFP->shrink_dcache_memory->prune_dcache->
909 * prune_one_dentry->dput->dentry_iput->iput->inode->i_sb->s_op->put_inode->
910 * ext2_discard_prealloc->ext2_free_blocks->lock_super->DEADLOCK.
911 *
912 * In this case we return -1 to tell the caller that we baled.
913 */
Dave Chinner7f8275d2010-07-19 14:56:17 +1000914static int shrink_dcache_memory(struct shrinker *shrink, int nr, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915{
916 if (nr) {
917 if (!(gfp_mask & __GFP_FS))
918 return -1;
Kentaro Makitada3bbdd2008-07-23 21:27:13 -0700919 prune_dcache(nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 }
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400921
Nick Piggin86c87492011-01-07 17:49:18 +1100922 return (dentry_stat.nr_unused / 100) * sysctl_vfs_cache_pressure;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923}
924
Rusty Russell8e1f9362007-07-17 04:03:17 -0700925static struct shrinker dcache_shrinker = {
926 .shrink = shrink_dcache_memory,
927 .seeks = DEFAULT_SEEKS,
928};
929
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930/**
931 * d_alloc - allocate a dcache entry
932 * @parent: parent of entry to allocate
933 * @name: qstr of the name
934 *
935 * Allocates a dentry. It returns %NULL if there is insufficient memory
936 * available. On a success the dentry is returned. The name passed in is
937 * copied and the copy passed in may be reused after this call.
938 */
939
940struct dentry *d_alloc(struct dentry * parent, const struct qstr *name)
941{
942 struct dentry *dentry;
943 char *dname;
944
Mel Gormane12ba742007-10-16 01:25:52 -0700945 dentry = kmem_cache_alloc(dentry_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 if (!dentry)
947 return NULL;
948
949 if (name->len > DNAME_INLINE_LEN-1) {
950 dname = kmalloc(name->len + 1, GFP_KERNEL);
951 if (!dname) {
952 kmem_cache_free(dentry_cache, dentry);
953 return NULL;
954 }
955 } else {
956 dname = dentry->d_iname;
957 }
958 dentry->d_name.name = dname;
959
960 dentry->d_name.len = name->len;
961 dentry->d_name.hash = name->hash;
962 memcpy(dname, name->name, name->len);
963 dname[name->len] = 0;
964
965 atomic_set(&dentry->d_count, 1);
966 dentry->d_flags = DCACHE_UNHASHED;
967 spin_lock_init(&dentry->d_lock);
968 dentry->d_inode = NULL;
969 dentry->d_parent = NULL;
970 dentry->d_sb = NULL;
971 dentry->d_op = NULL;
972 dentry->d_fsdata = NULL;
973 dentry->d_mounted = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 INIT_HLIST_NODE(&dentry->d_hash);
975 INIT_LIST_HEAD(&dentry->d_lru);
976 INIT_LIST_HEAD(&dentry->d_subdirs);
977 INIT_LIST_HEAD(&dentry->d_alias);
978
979 if (parent) {
980 dentry->d_parent = dget(parent);
981 dentry->d_sb = parent->d_sb;
982 } else {
Eric Dumazet5160ee62006-01-08 01:03:32 -0800983 INIT_LIST_HEAD(&dentry->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 }
985
986 spin_lock(&dcache_lock);
987 if (parent)
Eric Dumazet5160ee62006-01-08 01:03:32 -0800988 list_add(&dentry->d_u.d_child, &parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 spin_unlock(&dcache_lock);
990
Nick Piggin3e880fb2011-01-07 17:49:19 +1100991 this_cpu_inc(nr_dentry);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -0400992
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 return dentry;
994}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -0700995EXPORT_SYMBOL(d_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996
997struct dentry *d_alloc_name(struct dentry *parent, const char *name)
998{
999 struct qstr q;
1000
1001 q.name = name;
1002 q.len = strlen(name);
1003 q.hash = full_name_hash(q.name, q.len);
1004 return d_alloc(parent, &q);
1005}
H Hartley Sweetenef26ca92009-09-29 20:09:42 -04001006EXPORT_SYMBOL(d_alloc_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001008/* the caller must hold dcache_lock */
1009static void __d_instantiate(struct dentry *dentry, struct inode *inode)
1010{
1011 if (inode)
1012 list_add(&dentry->d_alias, &inode->i_dentry);
1013 dentry->d_inode = inode;
1014 fsnotify_d_instantiate(dentry, inode);
1015}
1016
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017/**
1018 * d_instantiate - fill in inode information for a dentry
1019 * @entry: dentry to complete
1020 * @inode: inode to attach to this dentry
1021 *
1022 * Fill in inode information in the entry.
1023 *
1024 * This turns negative dentries into productive full members
1025 * of society.
1026 *
1027 * NOTE! This assumes that the inode count has been incremented
1028 * (or otherwise set) by the caller to indicate that it is now
1029 * in use by the dcache.
1030 */
1031
1032void d_instantiate(struct dentry *entry, struct inode * inode)
1033{
Eric Sesterhenn28133c72006-03-26 18:25:39 +02001034 BUG_ON(!list_empty(&entry->d_alias));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 spin_lock(&dcache_lock);
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001036 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 spin_unlock(&dcache_lock);
1038 security_d_instantiate(entry, inode);
1039}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001040EXPORT_SYMBOL(d_instantiate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041
1042/**
1043 * d_instantiate_unique - instantiate a non-aliased dentry
1044 * @entry: dentry to instantiate
1045 * @inode: inode to attach to this dentry
1046 *
1047 * Fill in inode information in the entry. On success, it returns NULL.
1048 * If an unhashed alias of "entry" already exists, then we return the
Oleg Drokine866cfa2006-01-09 20:52:51 -08001049 * aliased dentry instead and drop one reference to inode.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 *
1051 * Note that in order to avoid conflicts with rename() etc, the caller
1052 * had better be holding the parent directory semaphore.
Oleg Drokine866cfa2006-01-09 20:52:51 -08001053 *
1054 * This also assumes that the inode count has been incremented
1055 * (or otherwise set) by the caller to indicate that it is now
1056 * in use by the dcache.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 */
David Howells770bfad2006-08-22 20:06:07 -04001058static struct dentry *__d_instantiate_unique(struct dentry *entry,
1059 struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060{
1061 struct dentry *alias;
1062 int len = entry->d_name.len;
1063 const char *name = entry->d_name.name;
1064 unsigned int hash = entry->d_name.hash;
1065
David Howells770bfad2006-08-22 20:06:07 -04001066 if (!inode) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001067 __d_instantiate(entry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001068 return NULL;
1069 }
1070
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 list_for_each_entry(alias, &inode->i_dentry, d_alias) {
1072 struct qstr *qstr = &alias->d_name;
1073
1074 if (qstr->hash != hash)
1075 continue;
1076 if (alias->d_parent != entry->d_parent)
1077 continue;
1078 if (qstr->len != len)
1079 continue;
1080 if (memcmp(qstr->name, name, len))
1081 continue;
1082 dget_locked(alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 return alias;
1084 }
David Howells770bfad2006-08-22 20:06:07 -04001085
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001086 __d_instantiate(entry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 return NULL;
1088}
David Howells770bfad2006-08-22 20:06:07 -04001089
1090struct dentry *d_instantiate_unique(struct dentry *entry, struct inode *inode)
1091{
1092 struct dentry *result;
1093
1094 BUG_ON(!list_empty(&entry->d_alias));
1095
1096 spin_lock(&dcache_lock);
1097 result = __d_instantiate_unique(entry, inode);
1098 spin_unlock(&dcache_lock);
1099
1100 if (!result) {
1101 security_d_instantiate(entry, inode);
1102 return NULL;
1103 }
1104
1105 BUG_ON(!d_unhashed(result));
1106 iput(inode);
1107 return result;
1108}
1109
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110EXPORT_SYMBOL(d_instantiate_unique);
1111
1112/**
1113 * d_alloc_root - allocate root dentry
1114 * @root_inode: inode to allocate the root for
1115 *
1116 * Allocate a root ("/") dentry for the inode given. The inode is
1117 * instantiated and returned. %NULL is returned if there is insufficient
1118 * memory or the inode passed is %NULL.
1119 */
1120
1121struct dentry * d_alloc_root(struct inode * root_inode)
1122{
1123 struct dentry *res = NULL;
1124
1125 if (root_inode) {
1126 static const struct qstr name = { .name = "/", .len = 1 };
1127
1128 res = d_alloc(NULL, &name);
1129 if (res) {
1130 res->d_sb = root_inode->i_sb;
1131 res->d_parent = res;
1132 d_instantiate(res, root_inode);
1133 }
1134 }
1135 return res;
1136}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001137EXPORT_SYMBOL(d_alloc_root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138
1139static inline struct hlist_head *d_hash(struct dentry *parent,
1140 unsigned long hash)
1141{
1142 hash += ((unsigned long) parent ^ GOLDEN_RATIO_PRIME) / L1_CACHE_BYTES;
1143 hash = hash ^ ((hash ^ GOLDEN_RATIO_PRIME) >> D_HASHBITS);
1144 return dentry_hashtable + (hash & D_HASHMASK);
1145}
1146
1147/**
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001148 * d_obtain_alias - find or allocate a dentry for a given inode
1149 * @inode: inode to allocate the dentry for
1150 *
1151 * Obtain a dentry for an inode resulting from NFS filehandle conversion or
1152 * similar open by handle operations. The returned dentry may be anonymous,
1153 * or may have a full name (if the inode was already in the cache).
1154 *
1155 * When called on a directory inode, we must ensure that the inode only ever
1156 * has one dentry. If a dentry is found, that is returned instead of
1157 * allocating a new one.
1158 *
1159 * On successful return, the reference to the inode has been transferred
Christoph Hellwig44003722008-08-11 15:49:04 +02001160 * to the dentry. In case of an error the reference on the inode is released.
1161 * To make it easier to use in export operations a %NULL or IS_ERR inode may
1162 * be passed in and will be the error will be propagate to the return value,
1163 * with a %NULL @inode replaced by ERR_PTR(-ESTALE).
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001164 */
1165struct dentry *d_obtain_alias(struct inode *inode)
1166{
Christoph Hellwig9308a612008-08-11 15:49:12 +02001167 static const struct qstr anonstring = { .name = "" };
1168 struct dentry *tmp;
1169 struct dentry *res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001170
1171 if (!inode)
Christoph Hellwig44003722008-08-11 15:49:04 +02001172 return ERR_PTR(-ESTALE);
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001173 if (IS_ERR(inode))
1174 return ERR_CAST(inode);
1175
Christoph Hellwig9308a612008-08-11 15:49:12 +02001176 res = d_find_alias(inode);
1177 if (res)
1178 goto out_iput;
1179
1180 tmp = d_alloc(NULL, &anonstring);
1181 if (!tmp) {
1182 res = ERR_PTR(-ENOMEM);
1183 goto out_iput;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001184 }
Christoph Hellwig9308a612008-08-11 15:49:12 +02001185 tmp->d_parent = tmp; /* make sure dput doesn't croak */
1186
1187 spin_lock(&dcache_lock);
1188 res = __d_find_alias(inode, 0);
1189 if (res) {
1190 spin_unlock(&dcache_lock);
1191 dput(tmp);
1192 goto out_iput;
1193 }
1194
1195 /* attach a disconnected dentry */
1196 spin_lock(&tmp->d_lock);
1197 tmp->d_sb = inode->i_sb;
1198 tmp->d_inode = inode;
1199 tmp->d_flags |= DCACHE_DISCONNECTED;
1200 tmp->d_flags &= ~DCACHE_UNHASHED;
1201 list_add(&tmp->d_alias, &inode->i_dentry);
1202 hlist_add_head(&tmp->d_hash, &inode->i_sb->s_anon);
1203 spin_unlock(&tmp->d_lock);
1204
1205 spin_unlock(&dcache_lock);
1206 return tmp;
1207
1208 out_iput:
1209 iput(inode);
1210 return res;
Christoph Hellwig4ea3ada2008-08-11 15:48:57 +02001211}
Benny Halevyadc48722009-02-27 14:02:59 -08001212EXPORT_SYMBOL(d_obtain_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213
1214/**
1215 * d_splice_alias - splice a disconnected dentry into the tree if one exists
1216 * @inode: the inode which may have a disconnected dentry
1217 * @dentry: a negative dentry which we want to point to the inode.
1218 *
1219 * If inode is a directory and has a 'disconnected' dentry (i.e. IS_ROOT and
1220 * DCACHE_DISCONNECTED), then d_move that in place of the given dentry
1221 * and return it, else simply d_add the inode to the dentry and return NULL.
1222 *
1223 * This is needed in the lookup routine of any filesystem that is exportable
1224 * (via knfsd) so that we can build dcache paths to directories effectively.
1225 *
1226 * If a dentry was found and moved, then it is returned. Otherwise NULL
1227 * is returned. This matches the expected return value of ->lookup.
1228 *
1229 */
1230struct dentry *d_splice_alias(struct inode *inode, struct dentry *dentry)
1231{
1232 struct dentry *new = NULL;
1233
NeilBrown21c0d8f2006-10-04 02:16:16 -07001234 if (inode && S_ISDIR(inode->i_mode)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 spin_lock(&dcache_lock);
1236 new = __d_find_alias(inode, 1);
1237 if (new) {
1238 BUG_ON(!(new->d_flags & DCACHE_DISCONNECTED));
1239 spin_unlock(&dcache_lock);
1240 security_d_instantiate(new, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 d_move(new, dentry);
1242 iput(inode);
1243 } else {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001244 /* already taking dcache_lock, so d_add() by hand */
1245 __d_instantiate(dentry, inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 spin_unlock(&dcache_lock);
1247 security_d_instantiate(dentry, inode);
1248 d_rehash(dentry);
1249 }
1250 } else
1251 d_add(dentry, inode);
1252 return new;
1253}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001254EXPORT_SYMBOL(d_splice_alias);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255
Barry Naujok94035402008-05-21 16:50:46 +10001256/**
1257 * d_add_ci - lookup or allocate new dentry with case-exact name
1258 * @inode: the inode case-insensitive lookup has found
1259 * @dentry: the negative dentry that was passed to the parent's lookup func
1260 * @name: the case-exact name to be associated with the returned dentry
1261 *
1262 * This is to avoid filling the dcache with case-insensitive names to the
1263 * same inode, only the actual correct case is stored in the dcache for
1264 * case-insensitive filesystems.
1265 *
1266 * For a case-insensitive lookup match and if the the case-exact dentry
1267 * already exists in in the dcache, use it and return it.
1268 *
1269 * If no entry exists with the exact case name, allocate new dentry with
1270 * the exact case, and return the spliced entry.
1271 */
Christoph Hellwige45b5902008-08-07 23:49:07 +02001272struct dentry *d_add_ci(struct dentry *dentry, struct inode *inode,
Barry Naujok94035402008-05-21 16:50:46 +10001273 struct qstr *name)
1274{
1275 int error;
1276 struct dentry *found;
1277 struct dentry *new;
1278
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001279 /*
1280 * First check if a dentry matching the name already exists,
1281 * if not go ahead and create it now.
1282 */
Barry Naujok94035402008-05-21 16:50:46 +10001283 found = d_hash_and_lookup(dentry->d_parent, name);
Barry Naujok94035402008-05-21 16:50:46 +10001284 if (!found) {
1285 new = d_alloc(dentry->d_parent, name);
1286 if (!new) {
1287 error = -ENOMEM;
1288 goto err_out;
1289 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001290
Barry Naujok94035402008-05-21 16:50:46 +10001291 found = d_splice_alias(inode, new);
1292 if (found) {
1293 dput(new);
1294 return found;
1295 }
1296 return new;
1297 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001298
1299 /*
1300 * If a matching dentry exists, and it's not negative use it.
1301 *
1302 * Decrement the reference count to balance the iget() done
1303 * earlier on.
1304 */
Barry Naujok94035402008-05-21 16:50:46 +10001305 if (found->d_inode) {
1306 if (unlikely(found->d_inode != inode)) {
1307 /* This can't happen because bad inodes are unhashed. */
1308 BUG_ON(!is_bad_inode(inode));
1309 BUG_ON(!is_bad_inode(found->d_inode));
1310 }
Barry Naujok94035402008-05-21 16:50:46 +10001311 iput(inode);
1312 return found;
1313 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001314
Barry Naujok94035402008-05-21 16:50:46 +10001315 /*
1316 * Negative dentry: instantiate it unless the inode is a directory and
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001317 * already has a dentry.
Barry Naujok94035402008-05-21 16:50:46 +10001318 */
Barry Naujok94035402008-05-21 16:50:46 +10001319 spin_lock(&dcache_lock);
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001320 if (!S_ISDIR(inode->i_mode) || list_empty(&inode->i_dentry)) {
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001321 __d_instantiate(found, inode);
Barry Naujok94035402008-05-21 16:50:46 +10001322 spin_unlock(&dcache_lock);
1323 security_d_instantiate(found, inode);
1324 return found;
1325 }
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001326
Barry Naujok94035402008-05-21 16:50:46 +10001327 /*
Christoph Hellwigb6520c82009-01-05 19:10:37 +01001328 * In case a directory already has a (disconnected) entry grab a
1329 * reference to it, move it in place and use it.
Barry Naujok94035402008-05-21 16:50:46 +10001330 */
1331 new = list_entry(inode->i_dentry.next, struct dentry, d_alias);
1332 dget_locked(new);
1333 spin_unlock(&dcache_lock);
Barry Naujok94035402008-05-21 16:50:46 +10001334 security_d_instantiate(found, inode);
Barry Naujok94035402008-05-21 16:50:46 +10001335 d_move(new, found);
Barry Naujok94035402008-05-21 16:50:46 +10001336 iput(inode);
Barry Naujok94035402008-05-21 16:50:46 +10001337 dput(found);
Barry Naujok94035402008-05-21 16:50:46 +10001338 return new;
1339
1340err_out:
1341 iput(inode);
1342 return ERR_PTR(error);
1343}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001344EXPORT_SYMBOL(d_add_ci);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345
1346/**
1347 * d_lookup - search for a dentry
1348 * @parent: parent dentry
1349 * @name: qstr of name we wish to find
Nick Pigginb04f7842010-08-18 04:37:34 +10001350 * Returns: dentry, or NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 *
Nick Pigginb04f7842010-08-18 04:37:34 +10001352 * d_lookup searches the children of the parent dentry for the name in
1353 * question. If the dentry is found its reference count is incremented and the
1354 * dentry is returned. The caller must use dput to free the entry when it has
1355 * finished using it. %NULL is returned if the dentry does not exist.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357struct dentry * d_lookup(struct dentry * parent, struct qstr * name)
1358{
1359 struct dentry * dentry = NULL;
1360 unsigned long seq;
1361
1362 do {
1363 seq = read_seqbegin(&rename_lock);
1364 dentry = __d_lookup(parent, name);
1365 if (dentry)
1366 break;
1367 } while (read_seqretry(&rename_lock, seq));
1368 return dentry;
1369}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001370EXPORT_SYMBOL(d_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371
Nick Pigginb04f7842010-08-18 04:37:34 +10001372/*
1373 * __d_lookup - search for a dentry (racy)
1374 * @parent: parent dentry
1375 * @name: qstr of name we wish to find
1376 * Returns: dentry, or NULL
1377 *
1378 * __d_lookup is like d_lookup, however it may (rarely) return a
1379 * false-negative result due to unrelated rename activity.
1380 *
1381 * __d_lookup is slightly faster by avoiding rename_lock read seqlock,
1382 * however it must be used carefully, eg. with a following d_lookup in
1383 * the case of failure.
1384 *
1385 * __d_lookup callers must be commented.
1386 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387struct dentry * __d_lookup(struct dentry * parent, struct qstr * name)
1388{
1389 unsigned int len = name->len;
1390 unsigned int hash = name->hash;
1391 const unsigned char *str = name->name;
1392 struct hlist_head *head = d_hash(parent,hash);
1393 struct dentry *found = NULL;
1394 struct hlist_node *node;
Paul E. McKenney665a7582005-11-07 00:59:17 -08001395 struct dentry *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396
Nick Pigginb04f7842010-08-18 04:37:34 +10001397 /*
1398 * The hash list is protected using RCU.
1399 *
1400 * Take d_lock when comparing a candidate dentry, to avoid races
1401 * with d_move().
1402 *
1403 * It is possible that concurrent renames can mess up our list
1404 * walk here and result in missing our dentry, resulting in the
1405 * false-negative result. d_lookup() protects against concurrent
1406 * renames using rename_lock seqlock.
1407 *
1408 * See Documentation/vfs/dcache-locking.txt for more details.
1409 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 rcu_read_lock();
1411
Paul E. McKenney665a7582005-11-07 00:59:17 -08001412 hlist_for_each_entry_rcu(dentry, node, head, d_hash) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 struct qstr *qstr;
1414
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415 if (dentry->d_name.hash != hash)
1416 continue;
1417 if (dentry->d_parent != parent)
1418 continue;
1419
1420 spin_lock(&dentry->d_lock);
1421
1422 /*
1423 * Recheck the dentry after taking the lock - d_move may have
Nick Pigginb04f7842010-08-18 04:37:34 +10001424 * changed things. Don't bother checking the hash because
1425 * we're about to compare the whole name anyway.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 */
1427 if (dentry->d_parent != parent)
1428 goto next;
1429
Linus Torvaldsd0185c02008-09-29 07:42:57 -07001430 /* non-existing due to RCU? */
1431 if (d_unhashed(dentry))
1432 goto next;
1433
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 /*
1435 * It is safe to compare names since d_move() cannot
1436 * change the qstr (protected by d_lock).
1437 */
1438 qstr = &dentry->d_name;
1439 if (parent->d_op && parent->d_op->d_compare) {
1440 if (parent->d_op->d_compare(parent, qstr, name))
1441 goto next;
1442 } else {
1443 if (qstr->len != len)
1444 goto next;
1445 if (memcmp(qstr->name, str, len))
1446 goto next;
1447 }
1448
Linus Torvaldsd0185c02008-09-29 07:42:57 -07001449 atomic_inc(&dentry->d_count);
1450 found = dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 spin_unlock(&dentry->d_lock);
1452 break;
1453next:
1454 spin_unlock(&dentry->d_lock);
1455 }
1456 rcu_read_unlock();
1457
1458 return found;
1459}
1460
1461/**
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08001462 * d_hash_and_lookup - hash the qstr then search for a dentry
1463 * @dir: Directory to search in
1464 * @name: qstr of name we wish to find
1465 *
1466 * On hash failure or on lookup failure NULL is returned.
1467 */
1468struct dentry *d_hash_and_lookup(struct dentry *dir, struct qstr *name)
1469{
1470 struct dentry *dentry = NULL;
1471
1472 /*
1473 * Check for a fs-specific hash function. Note that we must
1474 * calculate the standard hash first, as the d_op->d_hash()
1475 * routine may choose to leave the hash value unchanged.
1476 */
1477 name->hash = full_name_hash(name->name, name->len);
1478 if (dir->d_op && dir->d_op->d_hash) {
1479 if (dir->d_op->d_hash(dir, name) < 0)
1480 goto out;
1481 }
1482 dentry = d_lookup(dir, name);
1483out:
1484 return dentry;
1485}
1486
1487/**
Nick Piggin786a5e12011-01-07 17:49:16 +11001488 * d_validate - verify dentry provided from insecure source (deprecated)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 * @dentry: The dentry alleged to be valid child of @dparent
1490 * @dparent: The parent dentry (known to be valid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491 *
1492 * An insecure source has sent us a dentry, here we verify it and dget() it.
1493 * This is used by ncpfs in its readdir implementation.
1494 * Zero is returned in the dentry is invalid.
Nick Piggin786a5e12011-01-07 17:49:16 +11001495 *
1496 * This function is slow for big directories, and deprecated, do not use it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 */
Nick Piggind3a23e12011-01-05 20:01:21 +11001498int d_validate(struct dentry *dentry, struct dentry *dparent)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499{
Nick Piggin786a5e12011-01-07 17:49:16 +11001500 struct dentry *child;
Nick Piggind3a23e12011-01-05 20:01:21 +11001501
1502 spin_lock(&dcache_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11001503 list_for_each_entry(child, &dparent->d_subdirs, d_u.d_child) {
1504 if (dentry == child) {
Nick Piggind3a23e12011-01-05 20:01:21 +11001505 __dget_locked(dentry);
1506 spin_unlock(&dcache_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 return 1;
1508 }
1509 }
Nick Piggind3a23e12011-01-05 20:01:21 +11001510 spin_unlock(&dcache_lock);
Nick Piggin786a5e12011-01-07 17:49:16 +11001511
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 return 0;
1513}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001514EXPORT_SYMBOL(d_validate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515
1516/*
1517 * When a file is deleted, we have two options:
1518 * - turn this dentry into a negative dentry
1519 * - unhash this dentry and free it.
1520 *
1521 * Usually, we want to just turn this into
1522 * a negative dentry, but if anybody else is
1523 * currently using the dentry or the inode
1524 * we can't do that and we fall back on removing
1525 * it from the hash queues and waiting for
1526 * it to be deleted later when it has no users
1527 */
1528
1529/**
1530 * d_delete - delete a dentry
1531 * @dentry: The dentry to delete
1532 *
1533 * Turn the dentry into a negative dentry if possible, otherwise
1534 * remove it from the hash queues so it can be deleted later
1535 */
1536
1537void d_delete(struct dentry * dentry)
1538{
John McCutchan7a91bf72005-08-08 13:52:16 -04001539 int isdir = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540 /*
1541 * Are we the only user?
1542 */
1543 spin_lock(&dcache_lock);
1544 spin_lock(&dentry->d_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04001545 isdir = S_ISDIR(dentry->d_inode->i_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546 if (atomic_read(&dentry->d_count) == 1) {
Al Viro13e3c5e2010-05-21 16:11:04 -04001547 dentry->d_flags &= ~DCACHE_CANT_MOUNT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 dentry_iput(dentry);
John McCutchan7a91bf72005-08-08 13:52:16 -04001549 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 return;
1551 }
1552
1553 if (!d_unhashed(dentry))
1554 __d_drop(dentry);
1555
1556 spin_unlock(&dentry->d_lock);
1557 spin_unlock(&dcache_lock);
John McCutchan7a91bf72005-08-08 13:52:16 -04001558
1559 fsnotify_nameremove(dentry, isdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001561EXPORT_SYMBOL(d_delete);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562
1563static void __d_rehash(struct dentry * entry, struct hlist_head *list)
1564{
1565
1566 entry->d_flags &= ~DCACHE_UNHASHED;
1567 hlist_add_head_rcu(&entry->d_hash, list);
1568}
1569
David Howells770bfad2006-08-22 20:06:07 -04001570static void _d_rehash(struct dentry * entry)
1571{
1572 __d_rehash(entry, d_hash(entry->d_parent, entry->d_name.hash));
1573}
1574
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575/**
1576 * d_rehash - add an entry back to the hash
1577 * @entry: dentry to add to the hash
1578 *
1579 * Adds a dentry to the hash according to its name.
1580 */
1581
1582void d_rehash(struct dentry * entry)
1583{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 spin_lock(&dcache_lock);
1585 spin_lock(&entry->d_lock);
David Howells770bfad2006-08-22 20:06:07 -04001586 _d_rehash(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 spin_unlock(&entry->d_lock);
1588 spin_unlock(&dcache_lock);
1589}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001590EXPORT_SYMBOL(d_rehash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591
Nick Pigginfb2d5b82011-01-07 17:49:26 +11001592/**
1593 * dentry_update_name_case - update case insensitive dentry with a new name
1594 * @dentry: dentry to be updated
1595 * @name: new name
1596 *
1597 * Update a case insensitive dentry with new case of name.
1598 *
1599 * dentry must have been returned by d_lookup with name @name. Old and new
1600 * name lengths must match (ie. no d_compare which allows mismatched name
1601 * lengths).
1602 *
1603 * Parent inode i_mutex must be held over d_lookup and into this call (to
1604 * keep renames and concurrent inserts, and readdir(2) away).
1605 */
1606void dentry_update_name_case(struct dentry *dentry, struct qstr *name)
1607{
1608 BUG_ON(!mutex_is_locked(&dentry->d_inode->i_mutex));
1609 BUG_ON(dentry->d_name.len != name->len); /* d_lookup gives this */
1610
1611 spin_lock(&dcache_lock);
1612 spin_lock(&dentry->d_lock);
1613 memcpy((unsigned char *)dentry->d_name.name, name->name, name->len);
1614 spin_unlock(&dentry->d_lock);
1615 spin_unlock(&dcache_lock);
1616}
1617EXPORT_SYMBOL(dentry_update_name_case);
1618
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619/*
1620 * When switching names, the actual string doesn't strictly have to
1621 * be preserved in the target - because we're dropping the target
1622 * anyway. As such, we can just do a simple memcpy() to copy over
1623 * the new name before we switch.
1624 *
1625 * Note that we have to be a lot more careful about getting the hash
1626 * switched - we have to switch the hash value properly even if it
1627 * then no longer matches the actual (corrupted) string of the target.
1628 * The hash value has to match the hash queue that the dentry is on..
1629 */
1630static void switch_names(struct dentry *dentry, struct dentry *target)
1631{
1632 if (dname_external(target)) {
1633 if (dname_external(dentry)) {
1634 /*
1635 * Both external: swap the pointers
1636 */
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08001637 swap(target->d_name.name, dentry->d_name.name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 } else {
1639 /*
1640 * dentry:internal, target:external. Steal target's
1641 * storage and make target internal.
1642 */
J. Bruce Fields321bcf92007-10-21 16:41:38 -07001643 memcpy(target->d_iname, dentry->d_name.name,
1644 dentry->d_name.len + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 dentry->d_name.name = target->d_name.name;
1646 target->d_name.name = target->d_iname;
1647 }
1648 } else {
1649 if (dname_external(dentry)) {
1650 /*
1651 * dentry:external, target:internal. Give dentry's
1652 * storage to target and make dentry internal
1653 */
1654 memcpy(dentry->d_iname, target->d_name.name,
1655 target->d_name.len + 1);
1656 target->d_name.name = dentry->d_name.name;
1657 dentry->d_name.name = dentry->d_iname;
1658 } else {
1659 /*
1660 * Both are internal. Just copy target to dentry
1661 */
1662 memcpy(dentry->d_iname, target->d_name.name,
1663 target->d_name.len + 1);
Al Virodc711ca2008-11-03 15:03:50 -05001664 dentry->d_name.len = target->d_name.len;
1665 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666 }
1667 }
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08001668 swap(dentry->d_name.len, target->d_name.len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669}
1670
1671/*
1672 * We cannibalize "target" when moving dentry on top of it,
1673 * because it's going to be thrown away anyway. We could be more
1674 * polite about it, though.
1675 *
1676 * This forceful removal will result in ugly /proc output if
1677 * somebody holds a file open that got deleted due to a rename.
1678 * We could be nicer about the deleted file, and let it show
J. Bruce Fieldsbc154b12007-10-16 23:29:42 -07001679 * up under the name it had before it was deleted rather than
1680 * under the original name of the file that was moved on top of it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 */
1682
Trond Myklebust9eaef272006-10-21 10:24:20 -07001683/*
1684 * d_move_locked - move a dentry
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 * @dentry: entry to move
1686 * @target: new dentry
1687 *
1688 * Update the dcache to reflect the move of a file name. Negative
1689 * dcache entries should not be moved in this way.
1690 */
Trond Myklebust9eaef272006-10-21 10:24:20 -07001691static void d_move_locked(struct dentry * dentry, struct dentry * target)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692{
1693 struct hlist_head *list;
1694
1695 if (!dentry->d_inode)
1696 printk(KERN_WARNING "VFS: moving negative dcache entry\n");
1697
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 write_seqlock(&rename_lock);
1699 /*
1700 * XXXX: do we really need to take target->d_lock?
1701 */
1702 if (target < dentry) {
1703 spin_lock(&target->d_lock);
Ingo Molnara90b9c02006-07-03 00:25:04 -07001704 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 } else {
1706 spin_lock(&dentry->d_lock);
Ingo Molnara90b9c02006-07-03 00:25:04 -07001707 spin_lock_nested(&target->d_lock, DENTRY_D_LOCK_NESTED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 }
1709
1710 /* Move the dentry to the target hash queue, if on different bucket */
Denis Chengf77e3492007-10-16 23:30:11 -07001711 if (d_unhashed(dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 goto already_unhashed;
1713
1714 hlist_del_rcu(&dentry->d_hash);
1715
1716already_unhashed:
1717 list = d_hash(target->d_parent, target->d_name.hash);
1718 __d_rehash(dentry, list);
1719
1720 /* Unhash the target: dput() will then get rid of it */
1721 __d_drop(target);
1722
Eric Dumazet5160ee62006-01-08 01:03:32 -08001723 list_del(&dentry->d_u.d_child);
1724 list_del(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725
1726 /* Switch the names.. */
1727 switch_names(dentry, target);
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08001728 swap(dentry->d_name.hash, target->d_name.hash);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729
1730 /* ... and switch the parents */
1731 if (IS_ROOT(dentry)) {
1732 dentry->d_parent = target->d_parent;
1733 target->d_parent = target;
Eric Dumazet5160ee62006-01-08 01:03:32 -08001734 INIT_LIST_HEAD(&target->d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 } else {
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08001736 swap(dentry->d_parent, target->d_parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737
1738 /* And add them back to the (new) parent lists */
Eric Dumazet5160ee62006-01-08 01:03:32 -08001739 list_add(&target->d_u.d_child, &target->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 }
1741
Eric Dumazet5160ee62006-01-08 01:03:32 -08001742 list_add(&dentry->d_u.d_child, &dentry->d_parent->d_subdirs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 spin_unlock(&target->d_lock);
Nick Pigginc32ccd82006-03-25 03:07:09 -08001744 fsnotify_d_move(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 spin_unlock(&dentry->d_lock);
1746 write_sequnlock(&rename_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07001747}
1748
1749/**
1750 * d_move - move a dentry
1751 * @dentry: entry to move
1752 * @target: new dentry
1753 *
1754 * Update the dcache to reflect the move of a file name. Negative
1755 * dcache entries should not be moved in this way.
1756 */
1757
1758void d_move(struct dentry * dentry, struct dentry * target)
1759{
1760 spin_lock(&dcache_lock);
1761 d_move_locked(dentry, target);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762 spin_unlock(&dcache_lock);
1763}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001764EXPORT_SYMBOL(d_move);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09001766/**
1767 * d_ancestor - search for an ancestor
1768 * @p1: ancestor dentry
1769 * @p2: child dentry
1770 *
1771 * Returns the ancestor dentry of p2 which is a child of p1, if p1 is
1772 * an ancestor of p2, else NULL.
Trond Myklebust9eaef272006-10-21 10:24:20 -07001773 */
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09001774struct dentry *d_ancestor(struct dentry *p1, struct dentry *p2)
Trond Myklebust9eaef272006-10-21 10:24:20 -07001775{
1776 struct dentry *p;
1777
OGAWA Hirofumi871c0062008-10-16 07:50:27 +09001778 for (p = p2; !IS_ROOT(p); p = p->d_parent) {
Trond Myklebust9eaef272006-10-21 10:24:20 -07001779 if (p->d_parent == p1)
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09001780 return p;
Trond Myklebust9eaef272006-10-21 10:24:20 -07001781 }
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09001782 return NULL;
Trond Myklebust9eaef272006-10-21 10:24:20 -07001783}
1784
1785/*
1786 * This helper attempts to cope with remotely renamed directories
1787 *
1788 * It assumes that the caller is already holding
1789 * dentry->d_parent->d_inode->i_mutex and the dcache_lock
1790 *
1791 * Note: If ever the locking in lock_rename() changes, then please
1792 * remember to update this too...
Trond Myklebust9eaef272006-10-21 10:24:20 -07001793 */
1794static struct dentry *__d_unalias(struct dentry *dentry, struct dentry *alias)
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02001795 __releases(dcache_lock)
Trond Myklebust9eaef272006-10-21 10:24:20 -07001796{
1797 struct mutex *m1 = NULL, *m2 = NULL;
1798 struct dentry *ret;
1799
1800 /* If alias and dentry share a parent, then no extra locks required */
1801 if (alias->d_parent == dentry->d_parent)
1802 goto out_unalias;
1803
1804 /* Check for loops */
1805 ret = ERR_PTR(-ELOOP);
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09001806 if (d_ancestor(alias, dentry))
Trond Myklebust9eaef272006-10-21 10:24:20 -07001807 goto out_err;
1808
1809 /* See lock_rename() */
1810 ret = ERR_PTR(-EBUSY);
1811 if (!mutex_trylock(&dentry->d_sb->s_vfs_rename_mutex))
1812 goto out_err;
1813 m1 = &dentry->d_sb->s_vfs_rename_mutex;
1814 if (!mutex_trylock(&alias->d_parent->d_inode->i_mutex))
1815 goto out_err;
1816 m2 = &alias->d_parent->d_inode->i_mutex;
1817out_unalias:
1818 d_move_locked(alias, dentry);
1819 ret = alias;
1820out_err:
1821 spin_unlock(&dcache_lock);
1822 if (m2)
1823 mutex_unlock(m2);
1824 if (m1)
1825 mutex_unlock(m1);
1826 return ret;
1827}
1828
1829/*
David Howells770bfad2006-08-22 20:06:07 -04001830 * Prepare an anonymous dentry for life in the superblock's dentry tree as a
1831 * named dentry in place of the dentry to be replaced.
1832 */
1833static void __d_materialise_dentry(struct dentry *dentry, struct dentry *anon)
1834{
1835 struct dentry *dparent, *aparent;
1836
1837 switch_names(dentry, anon);
Wu Fengguang9a8d5bb2009-01-07 18:09:14 -08001838 swap(dentry->d_name.hash, anon->d_name.hash);
David Howells770bfad2006-08-22 20:06:07 -04001839
1840 dparent = dentry->d_parent;
1841 aparent = anon->d_parent;
1842
1843 dentry->d_parent = (aparent == anon) ? dentry : aparent;
1844 list_del(&dentry->d_u.d_child);
1845 if (!IS_ROOT(dentry))
1846 list_add(&dentry->d_u.d_child, &dentry->d_parent->d_subdirs);
1847 else
1848 INIT_LIST_HEAD(&dentry->d_u.d_child);
1849
1850 anon->d_parent = (dparent == dentry) ? anon : dparent;
1851 list_del(&anon->d_u.d_child);
1852 if (!IS_ROOT(anon))
1853 list_add(&anon->d_u.d_child, &anon->d_parent->d_subdirs);
1854 else
1855 INIT_LIST_HEAD(&anon->d_u.d_child);
1856
1857 anon->d_flags &= ~DCACHE_DISCONNECTED;
1858}
1859
1860/**
1861 * d_materialise_unique - introduce an inode into the tree
1862 * @dentry: candidate dentry
1863 * @inode: inode to bind to the dentry, to which aliases may be attached
1864 *
1865 * Introduces an dentry into the tree, substituting an extant disconnected
1866 * root directory alias in its place if there is one
1867 */
1868struct dentry *d_materialise_unique(struct dentry *dentry, struct inode *inode)
1869{
Trond Myklebust9eaef272006-10-21 10:24:20 -07001870 struct dentry *actual;
David Howells770bfad2006-08-22 20:06:07 -04001871
1872 BUG_ON(!d_unhashed(dentry));
1873
1874 spin_lock(&dcache_lock);
1875
1876 if (!inode) {
1877 actual = dentry;
OGAWA Hirofumi360da902008-10-16 07:50:28 +09001878 __d_instantiate(dentry, NULL);
David Howells770bfad2006-08-22 20:06:07 -04001879 goto found_lock;
1880 }
1881
Trond Myklebust9eaef272006-10-21 10:24:20 -07001882 if (S_ISDIR(inode->i_mode)) {
1883 struct dentry *alias;
David Howells770bfad2006-08-22 20:06:07 -04001884
Trond Myklebust9eaef272006-10-21 10:24:20 -07001885 /* Does an aliased dentry already exist? */
1886 alias = __d_find_alias(inode, 0);
1887 if (alias) {
1888 actual = alias;
1889 /* Is this an anonymous mountpoint that we could splice
1890 * into our tree? */
1891 if (IS_ROOT(alias)) {
1892 spin_lock(&alias->d_lock);
1893 __d_materialise_dentry(dentry, alias);
1894 __d_drop(alias);
1895 goto found;
1896 }
1897 /* Nope, but we must(!) avoid directory aliasing */
1898 actual = __d_unalias(dentry, alias);
1899 if (IS_ERR(actual))
1900 dput(alias);
1901 goto out_nolock;
1902 }
David Howells770bfad2006-08-22 20:06:07 -04001903 }
1904
1905 /* Add a unique reference */
1906 actual = __d_instantiate_unique(dentry, inode);
1907 if (!actual)
1908 actual = dentry;
1909 else if (unlikely(!d_unhashed(actual)))
1910 goto shouldnt_be_hashed;
1911
1912found_lock:
1913 spin_lock(&actual->d_lock);
1914found:
1915 _d_rehash(actual);
1916 spin_unlock(&actual->d_lock);
1917 spin_unlock(&dcache_lock);
Trond Myklebust9eaef272006-10-21 10:24:20 -07001918out_nolock:
David Howells770bfad2006-08-22 20:06:07 -04001919 if (actual == dentry) {
1920 security_d_instantiate(dentry, inode);
1921 return NULL;
1922 }
1923
1924 iput(inode);
1925 return actual;
1926
David Howells770bfad2006-08-22 20:06:07 -04001927shouldnt_be_hashed:
1928 spin_unlock(&dcache_lock);
1929 BUG();
David Howells770bfad2006-08-22 20:06:07 -04001930}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07001931EXPORT_SYMBOL_GPL(d_materialise_unique);
David Howells770bfad2006-08-22 20:06:07 -04001932
Miklos Szeredicdd16d02008-06-23 18:11:53 +02001933static int prepend(char **buffer, int *buflen, const char *str, int namelen)
Ram Pai6092d042008-03-27 13:06:20 +01001934{
1935 *buflen -= namelen;
1936 if (*buflen < 0)
1937 return -ENAMETOOLONG;
1938 *buffer -= namelen;
1939 memcpy(*buffer, str, namelen);
1940 return 0;
1941}
1942
Miklos Szeredicdd16d02008-06-23 18:11:53 +02001943static int prepend_name(char **buffer, int *buflen, struct qstr *name)
1944{
1945 return prepend(buffer, buflen, name->name, name->len);
1946}
1947
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948/**
Miklos Szeredif2eb6572010-08-10 11:41:39 +02001949 * Prepend path string to a buffer
1950 *
1951 * @path: the dentry/vfsmount to report
1952 * @root: root vfsmnt/dentry (may be modified by this function)
1953 * @buffer: pointer to the end of the buffer
1954 * @buflen: pointer to buffer length
1955 *
1956 * Caller holds the dcache_lock.
1957 *
1958 * If path is not reachable from the supplied root, then the value of
1959 * root is changed (without modifying refcounts).
1960 */
1961static int prepend_path(const struct path *path, struct path *root,
1962 char **buffer, int *buflen)
1963{
1964 struct dentry *dentry = path->dentry;
1965 struct vfsmount *vfsmnt = path->mnt;
1966 bool slash = false;
1967 int error = 0;
1968
Nick Piggin99b7db72010-08-18 04:37:39 +10001969 br_read_lock(vfsmount_lock);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02001970 while (dentry != root->dentry || vfsmnt != root->mnt) {
1971 struct dentry * parent;
1972
1973 if (dentry == vfsmnt->mnt_root || IS_ROOT(dentry)) {
1974 /* Global root? */
1975 if (vfsmnt->mnt_parent == vfsmnt) {
1976 goto global_root;
1977 }
1978 dentry = vfsmnt->mnt_mountpoint;
1979 vfsmnt = vfsmnt->mnt_parent;
1980 continue;
1981 }
1982 parent = dentry->d_parent;
1983 prefetch(parent);
1984 error = prepend_name(buffer, buflen, &dentry->d_name);
1985 if (!error)
1986 error = prepend(buffer, buflen, "/", 1);
1987 if (error)
1988 break;
1989
1990 slash = true;
1991 dentry = parent;
1992 }
1993
1994out:
1995 if (!error && !slash)
1996 error = prepend(buffer, buflen, "/", 1);
1997
Nick Piggin99b7db72010-08-18 04:37:39 +10001998 br_read_unlock(vfsmount_lock);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02001999 return error;
2000
2001global_root:
2002 /*
2003 * Filesystems needing to implement special "root names"
2004 * should do so with ->d_dname()
2005 */
2006 if (IS_ROOT(dentry) &&
2007 (dentry->d_name.len != 1 || dentry->d_name.name[0] != '/')) {
2008 WARN(1, "Root dentry has weird name <%.*s>\n",
2009 (int) dentry->d_name.len, dentry->d_name.name);
2010 }
2011 root->mnt = vfsmnt;
2012 root->dentry = dentry;
2013 goto out;
2014}
2015
2016/**
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002017 * __d_path - return the path of a dentry
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002018 * @path: the dentry/vfsmount to report
2019 * @root: root vfsmnt/dentry (may be modified by this function)
Randy Dunlapcd956a12010-08-14 13:05:31 -07002020 * @buf: buffer to return value in
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 * @buflen: buffer length
2022 *
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002023 * Convert a dentry into an ASCII path name.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002025 * Returns a pointer into the buffer or an error code if the
2026 * path was too long.
Linus Torvalds552ce542007-02-13 12:08:18 -08002027 *
Christoph Hellwigbe148242010-10-10 05:36:21 -04002028 * "buflen" should be positive.
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002029 *
2030 * If path is not reachable from the supplied root, then the value of
2031 * root is changed (without modifying refcounts).
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032 */
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002033char *__d_path(const struct path *path, struct path *root,
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002034 char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035{
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002036 char *res = buf + buflen;
2037 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002039 prepend(&res, &buflen, "\0", 1);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002040 spin_lock(&dcache_lock);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002041 error = prepend_path(path, root, &res, &buflen);
Christoph Hellwigbe148242010-10-10 05:36:21 -04002042 spin_unlock(&dcache_lock);
2043
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002044 if (error)
2045 return ERR_PTR(error);
Miklos Szeredif2eb6572010-08-10 11:41:39 +02002046 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047}
2048
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002049/*
2050 * same as __d_path but appends "(deleted)" for unlinked files.
2051 */
2052static int path_with_deleted(const struct path *path, struct path *root,
2053 char **buf, int *buflen)
2054{
2055 prepend(buf, buflen, "\0", 1);
2056 if (d_unlinked(path->dentry)) {
2057 int error = prepend(buf, buflen, " (deleted)", 10);
2058 if (error)
2059 return error;
2060 }
2061
2062 return prepend_path(path, root, buf, buflen);
2063}
2064
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002065static int prepend_unreachable(char **buffer, int *buflen)
2066{
2067 return prepend(buffer, buflen, "(unreachable)", 13);
2068}
2069
Jan Bluncka03a8a702008-02-14 19:38:32 -08002070/**
2071 * d_path - return the path of a dentry
Jan Blunckcf28b482008-02-14 19:38:44 -08002072 * @path: path to report
Jan Bluncka03a8a702008-02-14 19:38:32 -08002073 * @buf: buffer to return value in
2074 * @buflen: buffer length
2075 *
2076 * Convert a dentry into an ASCII path name. If the entry has been deleted
2077 * the string " (deleted)" is appended. Note that this is ambiguous.
2078 *
Arjan van de Ven52afeef2008-12-01 14:35:00 -08002079 * Returns a pointer into the buffer or an error code if the path was
2080 * too long. Note: Callers should use the returned pointer, not the passed
2081 * in buffer, to use the name! The implementation often starts at an offset
2082 * into the buffer, and may leave 0 bytes at the start.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002083 *
Miklos Szeredi31f3e0b2008-06-23 18:11:52 +02002084 * "buflen" should be positive.
Jan Bluncka03a8a702008-02-14 19:38:32 -08002085 */
Jan Engelhardt20d4fdc2008-06-09 16:40:36 -07002086char *d_path(const struct path *path, char *buf, int buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087{
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002088 char *res = buf + buflen;
Jan Blunck6ac08c32008-02-14 19:34:38 -08002089 struct path root;
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002090 struct path tmp;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002091 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002093 /*
2094 * We have various synthetic filesystems that never get mounted. On
2095 * these filesystems dentries are never used for lookup purposes, and
2096 * thus don't need to be hashed. They also don't need a name until a
2097 * user wants to identify the object in /proc/pid/fd/. The little hack
2098 * below allows us to generate a name for these objects on demand:
2099 */
Jan Blunckcf28b482008-02-14 19:38:44 -08002100 if (path->dentry->d_op && path->dentry->d_op->d_dname)
2101 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002102
Miklos Szeredif7ad3c62010-08-10 11:41:36 +02002103 get_fs_root(current->fs, &root);
Linus Torvalds552ce542007-02-13 12:08:18 -08002104 spin_lock(&dcache_lock);
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002105 tmp = root;
Miklos Szerediffd1f4e2010-08-10 11:41:40 +02002106 error = path_with_deleted(path, &tmp, &res, &buflen);
2107 if (error)
2108 res = ERR_PTR(error);
Linus Torvalds552ce542007-02-13 12:08:18 -08002109 spin_unlock(&dcache_lock);
Jan Blunck6ac08c32008-02-14 19:34:38 -08002110 path_put(&root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 return res;
2112}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002113EXPORT_SYMBOL(d_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002115/**
2116 * d_path_with_unreachable - return the path of a dentry
2117 * @path: path to report
2118 * @buf: buffer to return value in
2119 * @buflen: buffer length
2120 *
2121 * The difference from d_path() is that this prepends "(unreachable)"
2122 * to paths which are unreachable from the current process' root.
2123 */
2124char *d_path_with_unreachable(const struct path *path, char *buf, int buflen)
2125{
2126 char *res = buf + buflen;
2127 struct path root;
2128 struct path tmp;
2129 int error;
2130
2131 if (path->dentry->d_op && path->dentry->d_op->d_dname)
2132 return path->dentry->d_op->d_dname(path->dentry, buf, buflen);
2133
2134 get_fs_root(current->fs, &root);
2135 spin_lock(&dcache_lock);
2136 tmp = root;
2137 error = path_with_deleted(path, &tmp, &res, &buflen);
2138 if (!error && !path_equal(&tmp, &root))
2139 error = prepend_unreachable(&res, &buflen);
2140 spin_unlock(&dcache_lock);
2141 path_put(&root);
2142 if (error)
2143 res = ERR_PTR(error);
2144
2145 return res;
2146}
2147
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148/*
Eric Dumazetc23fbb62007-05-08 00:26:18 -07002149 * Helper function for dentry_operations.d_dname() members
2150 */
2151char *dynamic_dname(struct dentry *dentry, char *buffer, int buflen,
2152 const char *fmt, ...)
2153{
2154 va_list args;
2155 char temp[64];
2156 int sz;
2157
2158 va_start(args, fmt);
2159 sz = vsnprintf(temp, sizeof(temp), fmt, args) + 1;
2160 va_end(args);
2161
2162 if (sz > sizeof(temp) || sz > buflen)
2163 return ERR_PTR(-ENAMETOOLONG);
2164
2165 buffer += buflen - sz;
2166 return memcpy(buffer, temp, sz);
2167}
2168
2169/*
Ram Pai6092d042008-03-27 13:06:20 +01002170 * Write full pathname from the root of the filesystem into the buffer.
2171 */
Al Viroc1031352010-06-06 22:31:14 -04002172char *__dentry_path(struct dentry *dentry, char *buf, int buflen)
Ram Pai6092d042008-03-27 13:06:20 +01002173{
2174 char *end = buf + buflen;
2175 char *retval;
2176
Ram Pai6092d042008-03-27 13:06:20 +01002177 prepend(&end, &buflen, "\0", 1);
Ram Pai6092d042008-03-27 13:06:20 +01002178 if (buflen < 1)
2179 goto Elong;
2180 /* Get '/' right */
2181 retval = end-1;
2182 *retval = '/';
2183
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002184 while (!IS_ROOT(dentry)) {
2185 struct dentry *parent = dentry->d_parent;
Ram Pai6092d042008-03-27 13:06:20 +01002186
Ram Pai6092d042008-03-27 13:06:20 +01002187 prefetch(parent);
Miklos Szeredicdd16d02008-06-23 18:11:53 +02002188 if ((prepend_name(&end, &buflen, &dentry->d_name) != 0) ||
Ram Pai6092d042008-03-27 13:06:20 +01002189 (prepend(&end, &buflen, "/", 1) != 0))
2190 goto Elong;
2191
2192 retval = end;
2193 dentry = parent;
2194 }
Al Viroc1031352010-06-06 22:31:14 -04002195 return retval;
2196Elong:
2197 return ERR_PTR(-ENAMETOOLONG);
2198}
2199EXPORT_SYMBOL(__dentry_path);
2200
2201char *dentry_path(struct dentry *dentry, char *buf, int buflen)
2202{
2203 char *p = NULL;
2204 char *retval;
2205
2206 spin_lock(&dcache_lock);
2207 if (d_unlinked(dentry)) {
2208 p = buf + buflen;
2209 if (prepend(&p, &buflen, "//deleted", 10) != 0)
2210 goto Elong;
2211 buflen++;
2212 }
2213 retval = __dentry_path(dentry, buf, buflen);
Ram Pai6092d042008-03-27 13:06:20 +01002214 spin_unlock(&dcache_lock);
Al Viroc1031352010-06-06 22:31:14 -04002215 if (!IS_ERR(retval) && p)
2216 *p = '/'; /* restore '/' overriden with '\0' */
Ram Pai6092d042008-03-27 13:06:20 +01002217 return retval;
2218Elong:
2219 spin_unlock(&dcache_lock);
2220 return ERR_PTR(-ENAMETOOLONG);
2221}
2222
2223/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 * NOTE! The user-level library version returns a
2225 * character pointer. The kernel system call just
2226 * returns the length of the buffer filled (which
2227 * includes the ending '\0' character), or a negative
2228 * error value. So libc would do something like
2229 *
2230 * char *getcwd(char * buf, size_t size)
2231 * {
2232 * int retval;
2233 *
2234 * retval = sys_getcwd(buf, size);
2235 * if (retval >= 0)
2236 * return buf;
2237 * errno = -retval;
2238 * return NULL;
2239 * }
2240 */
Heiko Carstens3cdad422009-01-14 14:14:22 +01002241SYSCALL_DEFINE2(getcwd, char __user *, buf, unsigned long, size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242{
Linus Torvalds552ce542007-02-13 12:08:18 -08002243 int error;
Jan Blunck6ac08c32008-02-14 19:34:38 -08002244 struct path pwd, root;
Linus Torvalds552ce542007-02-13 12:08:18 -08002245 char *page = (char *) __get_free_page(GFP_USER);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246
2247 if (!page)
2248 return -ENOMEM;
2249
Miklos Szeredif7ad3c62010-08-10 11:41:36 +02002250 get_fs_root_and_pwd(current->fs, &root, &pwd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251
Linus Torvalds552ce542007-02-13 12:08:18 -08002252 error = -ENOENT;
Linus Torvalds552ce542007-02-13 12:08:18 -08002253 spin_lock(&dcache_lock);
Alexey Dobriyanf3da3922009-05-04 03:32:03 +04002254 if (!d_unlinked(pwd.dentry)) {
Linus Torvalds552ce542007-02-13 12:08:18 -08002255 unsigned long len;
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +01002256 struct path tmp = root;
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002257 char *cwd = page + PAGE_SIZE;
2258 int buflen = PAGE_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002260 prepend(&cwd, &buflen, "\0", 1);
2261 error = prepend_path(&pwd, &tmp, &cwd, &buflen);
Linus Torvalds552ce542007-02-13 12:08:18 -08002262 spin_unlock(&dcache_lock);
2263
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002264 if (error)
Linus Torvalds552ce542007-02-13 12:08:18 -08002265 goto out;
2266
Miklos Szeredi8df9d1a2010-08-10 11:41:41 +02002267 /* Unreachable from current root */
2268 if (!path_equal(&tmp, &root)) {
2269 error = prepend_unreachable(&cwd, &buflen);
2270 if (error)
2271 goto out;
2272 }
2273
Linus Torvalds552ce542007-02-13 12:08:18 -08002274 error = -ERANGE;
2275 len = PAGE_SIZE + page - cwd;
2276 if (len <= size) {
2277 error = len;
2278 if (copy_to_user(buf, cwd, len))
2279 error = -EFAULT;
2280 }
2281 } else
2282 spin_unlock(&dcache_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283
2284out:
Jan Blunck6ac08c32008-02-14 19:34:38 -08002285 path_put(&pwd);
2286 path_put(&root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 free_page((unsigned long) page);
2288 return error;
2289}
2290
2291/*
2292 * Test whether new_dentry is a subdirectory of old_dentry.
2293 *
2294 * Trivially implemented using the dcache structure
2295 */
2296
2297/**
2298 * is_subdir - is new dentry a subdirectory of old_dentry
2299 * @new_dentry: new dentry
2300 * @old_dentry: old dentry
2301 *
2302 * Returns 1 if new_dentry is a subdirectory of the parent (at any depth).
2303 * Returns 0 otherwise.
2304 * Caller must ensure that "new_dentry" is pinned before calling is_subdir()
2305 */
2306
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002307int is_subdir(struct dentry *new_dentry, struct dentry *old_dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308{
2309 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 unsigned long seq;
2311
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002312 if (new_dentry == old_dentry)
2313 return 1;
2314
2315 /*
2316 * Need rcu_readlock to protect against the d_parent trashing
2317 * due to d_move
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318 */
2319 rcu_read_lock();
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002320 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321 /* for restarting inner loop in case of seq retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 seq = read_seqbegin(&rename_lock);
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002323 if (d_ancestor(old_dentry, new_dentry))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 result = 1;
OGAWA Hirofumie2761a12008-10-16 07:50:28 +09002325 else
2326 result = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327 } while (read_seqretry(&rename_lock, seq));
2328 rcu_read_unlock();
2329
2330 return result;
2331}
2332
Al Viro2096f752010-01-30 13:16:21 -05002333int path_is_under(struct path *path1, struct path *path2)
2334{
2335 struct vfsmount *mnt = path1->mnt;
2336 struct dentry *dentry = path1->dentry;
2337 int res;
Nick Piggin99b7db72010-08-18 04:37:39 +10002338
2339 br_read_lock(vfsmount_lock);
Al Viro2096f752010-01-30 13:16:21 -05002340 if (mnt != path2->mnt) {
2341 for (;;) {
2342 if (mnt->mnt_parent == mnt) {
Nick Piggin99b7db72010-08-18 04:37:39 +10002343 br_read_unlock(vfsmount_lock);
Al Viro2096f752010-01-30 13:16:21 -05002344 return 0;
2345 }
2346 if (mnt->mnt_parent == path2->mnt)
2347 break;
2348 mnt = mnt->mnt_parent;
2349 }
2350 dentry = mnt->mnt_mountpoint;
2351 }
2352 res = is_subdir(dentry, path2->dentry);
Nick Piggin99b7db72010-08-18 04:37:39 +10002353 br_read_unlock(vfsmount_lock);
Al Viro2096f752010-01-30 13:16:21 -05002354 return res;
2355}
2356EXPORT_SYMBOL(path_is_under);
2357
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358void d_genocide(struct dentry *root)
2359{
2360 struct dentry *this_parent = root;
2361 struct list_head *next;
2362
2363 spin_lock(&dcache_lock);
2364repeat:
2365 next = this_parent->d_subdirs.next;
2366resume:
2367 while (next != &this_parent->d_subdirs) {
2368 struct list_head *tmp = next;
Eric Dumazet5160ee62006-01-08 01:03:32 -08002369 struct dentry *dentry = list_entry(tmp, struct dentry, d_u.d_child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370 next = tmp->next;
2371 if (d_unhashed(dentry)||!dentry->d_inode)
2372 continue;
2373 if (!list_empty(&dentry->d_subdirs)) {
2374 this_parent = dentry;
2375 goto repeat;
2376 }
2377 atomic_dec(&dentry->d_count);
2378 }
2379 if (this_parent != root) {
Eric Dumazet5160ee62006-01-08 01:03:32 -08002380 next = this_parent->d_u.d_child.next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 atomic_dec(&this_parent->d_count);
2382 this_parent = this_parent->d_parent;
2383 goto resume;
2384 }
2385 spin_unlock(&dcache_lock);
2386}
2387
2388/**
2389 * find_inode_number - check for dentry with name
2390 * @dir: directory to check
2391 * @name: Name to find.
2392 *
2393 * Check whether a dentry already exists for the given name,
2394 * and return the inode number if it has an inode. Otherwise
2395 * 0 is returned.
2396 *
2397 * This routine is used to post-process directory listings for
2398 * filesystems using synthetic inode numbers, and is necessary
2399 * to keep getcwd() working.
2400 */
2401
2402ino_t find_inode_number(struct dentry *dir, struct qstr *name)
2403{
2404 struct dentry * dentry;
2405 ino_t ino = 0;
2406
Eric W. Biederman3e7e2412006-03-31 02:31:43 -08002407 dentry = d_hash_and_lookup(dir, name);
2408 if (dentry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 if (dentry->d_inode)
2410 ino = dentry->d_inode->i_ino;
2411 dput(dentry);
2412 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413 return ino;
2414}
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002415EXPORT_SYMBOL(find_inode_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002416
2417static __initdata unsigned long dhash_entries;
2418static int __init set_dhash_entries(char *str)
2419{
2420 if (!str)
2421 return 0;
2422 dhash_entries = simple_strtoul(str, &str, 0);
2423 return 1;
2424}
2425__setup("dhash_entries=", set_dhash_entries);
2426
2427static void __init dcache_init_early(void)
2428{
2429 int loop;
2430
2431 /* If hashes are distributed across NUMA nodes, defer
2432 * hash allocation until vmalloc space is available.
2433 */
2434 if (hashdist)
2435 return;
2436
2437 dentry_hashtable =
2438 alloc_large_system_hash("Dentry cache",
2439 sizeof(struct hlist_head),
2440 dhash_entries,
2441 13,
2442 HASH_EARLY,
2443 &d_hash_shift,
2444 &d_hash_mask,
2445 0);
2446
2447 for (loop = 0; loop < (1 << d_hash_shift); loop++)
2448 INIT_HLIST_HEAD(&dentry_hashtable[loop]);
2449}
2450
Denis Cheng74bf17c2007-10-16 23:26:30 -07002451static void __init dcache_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002452{
2453 int loop;
2454
2455 /*
2456 * A constructor could be added for stable state like the lists,
2457 * but it is probably not worth it because of the cache nature
2458 * of the dcache.
2459 */
Christoph Lameter0a31bd52007-05-06 14:49:57 -07002460 dentry_cache = KMEM_CACHE(dentry,
2461 SLAB_RECLAIM_ACCOUNT|SLAB_PANIC|SLAB_MEM_SPREAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462
Rusty Russell8e1f9362007-07-17 04:03:17 -07002463 register_shrinker(&dcache_shrinker);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464
2465 /* Hash may have been set up in dcache_init_early */
2466 if (!hashdist)
2467 return;
2468
2469 dentry_hashtable =
2470 alloc_large_system_hash("Dentry cache",
2471 sizeof(struct hlist_head),
2472 dhash_entries,
2473 13,
2474 0,
2475 &d_hash_shift,
2476 &d_hash_mask,
2477 0);
2478
2479 for (loop = 0; loop < (1 << d_hash_shift); loop++)
2480 INIT_HLIST_HEAD(&dentry_hashtable[loop]);
2481}
2482
2483/* SLAB cache for __getname() consumers */
Christoph Lametere18b8902006-12-06 20:33:20 -08002484struct kmem_cache *names_cachep __read_mostly;
H Hartley Sweetenec4f8602010-01-05 13:45:18 -07002485EXPORT_SYMBOL(names_cachep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486
Linus Torvalds1da177e2005-04-16 15:20:36 -07002487EXPORT_SYMBOL(d_genocide);
2488
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489void __init vfs_caches_init_early(void)
2490{
2491 dcache_init_early();
2492 inode_init_early();
2493}
2494
2495void __init vfs_caches_init(unsigned long mempages)
2496{
2497 unsigned long reserve;
2498
2499 /* Base hash sizes on available memory, with a reserve equal to
2500 150% of current kernel size */
2501
2502 reserve = min((mempages - nr_free_pages()) * 3/2, mempages - 1);
2503 mempages -= reserve;
2504
2505 names_cachep = kmem_cache_create("names_cache", PATH_MAX, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09002506 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507
Denis Cheng74bf17c2007-10-16 23:26:30 -07002508 dcache_init();
2509 inode_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510 files_init(mempages);
Denis Cheng74bf17c2007-10-16 23:26:30 -07002511 mnt_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512 bdev_cache_init();
2513 chrdev_init();
2514}