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