hostfs: simplify locking
[linux-2.6-block.git] / include / linux / dcache.h
CommitLineData
1da177e4
LT
1#ifndef __LINUX_DCACHE_H
2#define __LINUX_DCACHE_H
3
1da177e4
LT
4#include <asm/atomic.h>
5#include <linux/list.h>
82524746 6#include <linux/rculist.h>
1da177e4
LT
7#include <linux/spinlock.h>
8#include <linux/cache.h>
9#include <linux/rcupdate.h>
1da177e4
LT
10
11struct nameidata;
cf28b486 12struct path;
1da177e4
LT
13struct vfsmount;
14
15/*
16 * linux/include/linux/dcache.h
17 *
18 * Dirent cache data structures
19 *
20 * (C) Copyright 1997 Thomas Schoebel-Theuer,
21 * with heavy changes by Linus Torvalds
22 */
23
24#define IS_ROOT(x) ((x) == (x)->d_parent)
25
26/*
27 * "quick string" -- eases parameter passing, but more importantly
28 * saves "metadata" about the string (ie length and the hash).
29 *
30 * hash comes first so it snuggles against d_parent in the
31 * dentry.
32 */
33struct qstr {
34 unsigned int hash;
35 unsigned int len;
36 const unsigned char *name;
37};
38
39struct dentry_stat_t {
40 int nr_dentry;
41 int nr_unused;
42 int age_limit; /* age in seconds */
43 int want_pages; /* pages requested by system */
44 int dummy[2];
45};
46extern struct dentry_stat_t dentry_stat;
47
48/* Name hashing routines. Initial hash value */
49/* Hash courtesy of the R5 hash in reiserfs modulo sign bits */
50#define init_name_hash() 0
51
52/* partial hash update function. Assume roughly 4 bits per character */
53static inline unsigned long
54partial_name_hash(unsigned long c, unsigned long prevhash)
55{
56 return (prevhash + (c << 4) + (c >> 4)) * 11;
57}
58
59/*
60 * Finally: cut down the number of bits to a int value (and try to avoid
61 * losing bits)
62 */
63static inline unsigned long end_name_hash(unsigned long hash)
64{
65 return (unsigned int) hash;
66}
67
68/* Compute the hash for a name string. */
69static inline unsigned int
70full_name_hash(const unsigned char *name, unsigned int len)
71{
72 unsigned long hash = init_name_hash();
73 while (len--)
74 hash = partial_name_hash(*name++, hash);
75 return end_name_hash(hash);
76}
77
c2452f32
NP
78/*
79 * Try to keep struct dentry aligned on 64 byte cachelines (this will
80 * give reasonable cacheline footprint with larger lines without the
81 * large memory footprint increase).
82 */
83#ifdef CONFIG_64BIT
84#define DNAME_INLINE_LEN_MIN 32 /* 192 bytes */
85#else
86#define DNAME_INLINE_LEN_MIN 40 /* 128 bytes */
87#endif
1da177e4
LT
88
89struct dentry {
90 atomic_t d_count;
91 unsigned int d_flags; /* protected by d_lock */
92 spinlock_t d_lock; /* per dentry lock */
c2452f32 93 int d_mounted;
1da177e4
LT
94 struct inode *d_inode; /* Where the name belongs to - NULL is
95 * negative */
96 /*
97 * The next three fields are touched by __d_lookup. Place them here
3f4bb1f4 98 * so they all fit in a cache line.
1da177e4 99 */
3f4bb1f4 100 struct hlist_node d_hash; /* lookup hash list */
1da177e4
LT
101 struct dentry *d_parent; /* parent directory */
102 struct qstr d_name;
103
104 struct list_head d_lru; /* LRU list */
5160ee6f
ED
105 /*
106 * d_child and d_rcu can share memory
107 */
108 union {
109 struct list_head d_child; /* child of parent list */
110 struct rcu_head d_rcu;
111 } d_u;
1da177e4
LT
112 struct list_head d_subdirs; /* our children */
113 struct list_head d_alias; /* inode alias list */
114 unsigned long d_time; /* used by d_revalidate */
e56980d4 115 const struct dentry_operations *d_op;
1da177e4
LT
116 struct super_block *d_sb; /* The root of the dentry tree */
117 void *d_fsdata; /* fs-specific data */
c2452f32 118
1da177e4
LT
119 unsigned char d_iname[DNAME_INLINE_LEN_MIN]; /* small names */
120};
121
a90b9c05
IM
122/*
123 * dentry->d_lock spinlock nesting subclasses:
124 *
125 * 0: normal
126 * 1: nested
127 */
128enum dentry_d_lock_class
129{
130 DENTRY_D_LOCK_NORMAL, /* implicitly used by plain spin_lock() APIs. */
131 DENTRY_D_LOCK_NESTED
132};
133
1da177e4
LT
134struct dentry_operations {
135 int (*d_revalidate)(struct dentry *, struct nameidata *);
b1e6a015
NP
136 int (*d_hash)(const struct dentry *, const struct inode *,
137 struct qstr *);
621e155a
NP
138 int (*d_compare)(const struct dentry *, const struct inode *,
139 const struct dentry *, const struct inode *,
140 unsigned int, const char *, const struct qstr *);
fe15ce44 141 int (*d_delete)(const struct dentry *);
1da177e4
LT
142 void (*d_release)(struct dentry *);
143 void (*d_iput)(struct dentry *, struct inode *);
c23fbb6b 144 char *(*d_dname)(struct dentry *, char *, int);
1da177e4
LT
145};
146
5eef7fa9
NP
147/*
148 * Locking rules for dentry_operations callbacks are to be found in
149 * Documentation/filesystems/Locking. Keep it updated!
150 *
621e155a
NP
151 * FUrther descriptions are found in Documentation/filesystems/vfs.txt.
152 * Keep it updated too!
1da177e4
LT
153 */
154
155/* d_flags entries */
156#define DCACHE_AUTOFS_PENDING 0x0001 /* autofs: "under construction" */
157#define DCACHE_NFSFS_RENAMED 0x0002 /* this dentry has been "silly
158 * renamed" and has to be
159 * deleted on the last dput()
160 */
161#define DCACHE_DISCONNECTED 0x0004
162 /* This dentry is possibly not currently connected to the dcache tree,
163 * in which case its parent will either be itself, or will have this
164 * flag as well. nfsd will not use a dentry with this bit set, but will
165 * first endeavour to clear the bit either by discovering that it is
166 * connected, or by performing lookup operations. Any filesystem which
167 * supports nfsd_operations MUST have a lookup function which, if it finds
168 * a directory inode with a DCACHE_DISCONNECTED dentry, will d_move
169 * that dentry into place and return that dentry rather than the passed one,
170 * typically using d_splice_alias.
171 */
172
173#define DCACHE_REFERENCED 0x0008 /* Recently used, don't discard. */
174#define DCACHE_UNHASHED 0x0010
175
c28f7e56 176#define DCACHE_INOTIFY_PARENT_WATCHED 0x0020 /* Parent inode is watched by inotify */
c32ccd87 177
c2452f32
NP
178#define DCACHE_COOKIE 0x0040 /* For use by dcookie subsystem */
179
c28f7e56
EP
180#define DCACHE_FSNOTIFY_PARENT_WATCHED 0x0080 /* Parent inode is watched by some fsnotify listener */
181
d83c49f3
AV
182#define DCACHE_CANT_MOUNT 0x0100
183
1da177e4 184extern spinlock_t dcache_lock;
74c3cbe3 185extern seqlock_t rename_lock;
1da177e4
LT
186
187/**
188 * d_drop - drop a dentry
189 * @dentry: dentry to drop
190 *
191 * d_drop() unhashes the entry from the parent dentry hashes, so that it won't
192 * be found through a VFS lookup any more. Note that this is different from
193 * deleting the dentry - d_delete will try to mark the dentry negative if
194 * possible, giving a successful _negative_ lookup, while d_drop will
195 * just make the cache lookup fail.
196 *
197 * d_drop() is used mainly for stuff that wants to invalidate a dentry for some
198 * reason (NFS timeouts or autofs deletes).
199 *
200 * __d_drop requires dentry->d_lock.
201 */
202
203static inline void __d_drop(struct dentry *dentry)
204{
205 if (!(dentry->d_flags & DCACHE_UNHASHED)) {
206 dentry->d_flags |= DCACHE_UNHASHED;
207 hlist_del_rcu(&dentry->d_hash);
208 }
209}
210
211static inline void d_drop(struct dentry *dentry)
212{
213 spin_lock(&dcache_lock);
214 spin_lock(&dentry->d_lock);
215 __d_drop(dentry);
216 spin_unlock(&dentry->d_lock);
217 spin_unlock(&dcache_lock);
218}
219
220static inline int dname_external(struct dentry *dentry)
221{
222 return dentry->d_name.name != dentry->d_iname;
223}
224
225/*
226 * These are the low-level FS interfaces to the dcache..
227 */
228extern void d_instantiate(struct dentry *, struct inode *);
229extern struct dentry * d_instantiate_unique(struct dentry *, struct inode *);
770bfad8 230extern struct dentry * d_materialise_unique(struct dentry *, struct inode *);
1da177e4
LT
231extern void d_delete(struct dentry *);
232
233/* allocate/de-allocate */
234extern struct dentry * d_alloc(struct dentry *, const struct qstr *);
1da177e4 235extern struct dentry * d_splice_alias(struct inode *, struct dentry *);
e45b590b 236extern struct dentry * d_add_ci(struct dentry *, struct inode *, struct qstr *);
4ea3ada2 237extern struct dentry * d_obtain_alias(struct inode *);
1da177e4
LT
238extern void shrink_dcache_sb(struct super_block *);
239extern void shrink_dcache_parent(struct dentry *);
c636ebdb 240extern void shrink_dcache_for_umount(struct super_block *);
1da177e4
LT
241extern int d_invalidate(struct dentry *);
242
243/* only used at mount-time */
244extern struct dentry * d_alloc_root(struct inode *);
245
246/* <clickety>-<click> the ramfs-type tree */
247extern void d_genocide(struct dentry *);
248
249extern struct dentry *d_find_alias(struct inode *);
250extern void d_prune_aliases(struct inode *);
251
252/* test whether we have any submounts in a subdir tree */
253extern int have_submounts(struct dentry *);
254
255/*
256 * This adds the entry to the hash queues.
257 */
258extern void d_rehash(struct dentry *);
259
260/**
261 * d_add - add dentry to hash queues
262 * @entry: dentry to add
263 * @inode: The inode to attach to this dentry
264 *
265 * This adds the entry to the hash queues and initializes @inode.
266 * The entry was actually filled in earlier during d_alloc().
267 */
268
269static inline void d_add(struct dentry *entry, struct inode *inode)
270{
271 d_instantiate(entry, inode);
272 d_rehash(entry);
273}
274
275/**
276 * d_add_unique - add dentry to hash queues without aliasing
277 * @entry: dentry to add
278 * @inode: The inode to attach to this dentry
279 *
280 * This adds the entry to the hash queues and initializes @inode.
281 * The entry was actually filled in earlier during d_alloc().
282 */
283static inline struct dentry *d_add_unique(struct dentry *entry, struct inode *inode)
284{
285 struct dentry *res;
286
287 res = d_instantiate_unique(entry, inode);
288 d_rehash(res != NULL ? res : entry);
289 return res;
290}
291
fb2d5b86
NP
292extern void dentry_update_name_case(struct dentry *, struct qstr *);
293
1da177e4
LT
294/* used for rename() and baskets */
295extern void d_move(struct dentry *, struct dentry *);
e2761a11 296extern struct dentry *d_ancestor(struct dentry *, struct dentry *);
1da177e4
LT
297
298/* appendix may either be NULL or be used for transname suffixes */
299extern struct dentry * d_lookup(struct dentry *, struct qstr *);
300extern struct dentry * __d_lookup(struct dentry *, struct qstr *);
3e7e241f 301extern struct dentry * d_hash_and_lookup(struct dentry *, struct qstr *);
1da177e4
LT
302
303/* validate "insecure" dentry pointer */
304extern int d_validate(struct dentry *, struct dentry *);
305
c23fbb6b
ED
306/*
307 * helper function for dentry_operations.d_dname() members
308 */
309extern char *dynamic_dname(struct dentry *, char *, int, const char *, ...);
310
9d1bc601 311extern char *__d_path(const struct path *path, struct path *root, char *, int);
20d4fdc1 312extern char *d_path(const struct path *, char *, int);
8df9d1a4 313extern char *d_path_with_unreachable(const struct path *, char *, int);
ec2447c2 314extern char *dentry_path_raw(struct dentry *, char *, int);
6092d048 315extern char *dentry_path(struct dentry *, char *, int);
cf28b486 316
1da177e4
LT
317/* Allocation counts.. */
318
319/**
320 * dget, dget_locked - get a reference to a dentry
321 * @dentry: dentry to get a reference to
322 *
323 * Given a dentry or %NULL pointer increment the reference count
324 * if appropriate and return the dentry. A dentry will not be
325 * destroyed when it has references. dget() should never be
326 * called for dentries with zero reference counter. For these cases
327 * (preferably none, functions in dcache.c are sufficient for normal
328 * needs and they take necessary precautions) you should hold dcache_lock
329 * and call dget_locked() instead of dget().
330 */
331
332static inline struct dentry *dget(struct dentry *dentry)
333{
334 if (dentry) {
335 BUG_ON(!atomic_read(&dentry->d_count));
336 atomic_inc(&dentry->d_count);
337 }
338 return dentry;
339}
340
341extern struct dentry * dget_locked(struct dentry *);
342
343/**
344 * d_unhashed - is dentry hashed
345 * @dentry: entry to check
346 *
347 * Returns true if the dentry passed is not currently hashed.
348 */
349
350static inline int d_unhashed(struct dentry *dentry)
351{
352 return (dentry->d_flags & DCACHE_UNHASHED);
353}
354
f3da392e
AD
355static inline int d_unlinked(struct dentry *dentry)
356{
357 return d_unhashed(dentry) && !IS_ROOT(dentry);
358}
359
d83c49f3
AV
360static inline int cant_mount(struct dentry *dentry)
361{
362 return (dentry->d_flags & DCACHE_CANT_MOUNT);
363}
364
365static inline void dont_mount(struct dentry *dentry)
366{
367 spin_lock(&dentry->d_lock);
368 dentry->d_flags |= DCACHE_CANT_MOUNT;
369 spin_unlock(&dentry->d_lock);
370}
371
1da177e4
LT
372static inline struct dentry *dget_parent(struct dentry *dentry)
373{
374 struct dentry *ret;
375
376 spin_lock(&dentry->d_lock);
377 ret = dget(dentry->d_parent);
378 spin_unlock(&dentry->d_lock);
379 return ret;
380}
381
382extern void dput(struct dentry *);
383
384static inline int d_mountpoint(struct dentry *dentry)
385{
386 return dentry->d_mounted;
387}
388
1c755af4 389extern struct vfsmount *lookup_mnt(struct path *);
1da177e4
LT
390extern struct dentry *lookup_create(struct nameidata *nd, int is_dir);
391
392extern int sysctl_vfs_cache_pressure;
393
1da177e4 394#endif /* __LINUX_DCACHE_H */