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