]> bbs.cooldavid.org Git - net-next-2.6.git/blame - fs/fscache/internal.h
git://bbs.cooldavid.org / net-next-2.6.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
FS-Cache: The object-available state can't rely on the cookie to be available
[net-next-2.6.git] / fs / fscache / internal.h
CommitLineData
06b3db1b
DH		 1/* Internal definitions for FS-Cache
2 *
3 * Copyright (C) 2004-2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 */
11
12/*
13 * Lock order, in the order in which multiple locks should be obtained:
14 * - fscache_addremove_sem
15 * - cookie->lock
16 * - cookie->parent->lock
17 * - cache->object_list_lock
18 * - object->lock
19 * - object->parent->lock
20 * - fscache_thread_lock
21 *
22 */
23
24#include <linux/fscache-cache.h>
25#include <linux/sched.h>
26
27#define FSCACHE_MIN_THREADS 4
28#define FSCACHE_MAX_THREADS 32
29
0e04d4ce 30/*
348ca102 31 * cache.c
0e04d4ce
DH		 32 */
33extern struct list_head fscache_cache_list;
34extern struct rw_semaphore fscache_addremove_sem;
35
36extern struct fscache_cache *fscache_select_cache_for_object(
37 struct fscache_cookie *);
38
955d0091 39/*
348ca102 40 * cookie.c
955d0091
DH		 41 */
42extern struct kmem_cache *fscache_cookie_jar;
43
44extern void fscache_cookie_init_once(void *);
45extern void __fscache_cookie_put(struct fscache_cookie *);
46
a6891645 47/*
348ca102 48 * fsdef.c
a6891645
DH		 49 */
50extern struct fscache_cookie fscache_fsdef_index;
51extern struct fscache_cookie_def fscache_fsdef_netfs_def;
52
7394daa8 53/*
348ca102 54 * histogram.c
7394daa8
DH		 55 */
56#ifdef CONFIG_FSCACHE_HISTOGRAM
57extern atomic_t fscache_obj_instantiate_histogram[HZ];
58extern atomic_t fscache_objs_histogram[HZ];
59extern atomic_t fscache_ops_histogram[HZ];
60extern atomic_t fscache_retrieval_delay_histogram[HZ];
61extern atomic_t fscache_retrieval_histogram[HZ];
62
63static inline void fscache_hist(atomic_t histogram[], unsigned long start_jif)
64{
65 unsigned long jif = jiffies - start_jif;
66 if (jif >= HZ)
67 jif = HZ - 1;
68 atomic_inc(&histogram[jif]);
69}
70
71extern const struct file_operations fscache_histogram_fops;
72
73#else
74#define fscache_hist(hist, start_jif) do {} while (0)
75#endif
76
06b3db1b 77/*
348ca102 78 * main.c
06b3db1b
DH		 79 */
80extern unsigned fscache_defer_lookup;
81extern unsigned fscache_defer_create;
82extern unsigned fscache_debug;
83extern struct kobject *fscache_root;
84
2868cbea
DH		 85extern int fscache_wait_bit(void *);
86extern int fscache_wait_bit_interruptible(void *);
87
36c95590 88/*
348ca102 89 * object.c
36c95590 90 */
4fbf4291
DH		 91extern const char fscache_object_states_short[FSCACHE_OBJECT__NSTATES][5];
92
36c95590
DH		 93extern void fscache_withdrawing_object(struct fscache_cache *,
94 struct fscache_object *);
95extern void fscache_enqueue_object(struct fscache_object *);
96
4fbf4291
DH		 97/*
98 * object-list.c
99 */
100#ifdef CONFIG_FSCACHE_OBJECT_LIST
101extern const struct file_operations fscache_objlist_fops;
102
103extern void fscache_objlist_add(struct fscache_object *);
104#else
105#define fscache_objlist_add(object) do {} while(0)
106#endif
107
36c95590 108/*
348ca102 109 * operation.c
36c95590 110 */
952efe7b
DH		 111extern int fscache_submit_exclusive_op(struct fscache_object *,
112 struct fscache_operation *);
113extern int fscache_submit_op(struct fscache_object *,
114 struct fscache_operation *);
5753c441 115extern int fscache_cancel_op(struct fscache_operation *);
952efe7b
DH		 116extern void fscache_abort_object(struct fscache_object *);
117extern void fscache_start_operations(struct fscache_object *);
118extern void fscache_operation_gc(struct work_struct *);
36c95590 119
7394daa8 120/*
348ca102 121 * proc.c
7394daa8
DH		 122 */
123#ifdef CONFIG_PROC_FS
124extern int __init fscache_proc_init(void);
125extern void fscache_proc_cleanup(void);
126#else
127#define fscache_proc_init() (0)
128#define fscache_proc_cleanup() do {} while (0)
129#endif
130
131/*
348ca102 132 * stats.c
7394daa8
DH		 133 */
134#ifdef CONFIG_FSCACHE_STATS
135extern atomic_t fscache_n_ops_processed[FSCACHE_MAX_THREADS];
136extern atomic_t fscache_n_objs_processed[FSCACHE_MAX_THREADS];
137
138extern atomic_t fscache_n_op_pend;
139extern atomic_t fscache_n_op_run;
140extern atomic_t fscache_n_op_enqueue;
141extern atomic_t fscache_n_op_deferred_release;
142extern atomic_t fscache_n_op_release;
143extern atomic_t fscache_n_op_gc;
5753c441 144extern atomic_t fscache_n_op_cancelled;
7394daa8
DH		 145
146extern atomic_t fscache_n_attr_changed;
147extern atomic_t fscache_n_attr_changed_ok;
148extern atomic_t fscache_n_attr_changed_nobufs;
149extern atomic_t fscache_n_attr_changed_nomem;
150extern atomic_t fscache_n_attr_changed_calls;
151
152extern atomic_t fscache_n_allocs;
153extern atomic_t fscache_n_allocs_ok;
154extern atomic_t fscache_n_allocs_wait;
155extern atomic_t fscache_n_allocs_nobufs;
5753c441 156extern atomic_t fscache_n_allocs_intr;
7394daa8
DH		 157extern atomic_t fscache_n_alloc_ops;
158extern atomic_t fscache_n_alloc_op_waits;
159
160extern atomic_t fscache_n_retrievals;
161extern atomic_t fscache_n_retrievals_ok;
162extern atomic_t fscache_n_retrievals_wait;
163extern atomic_t fscache_n_retrievals_nodata;
164extern atomic_t fscache_n_retrievals_nobufs;
165extern atomic_t fscache_n_retrievals_intr;
166extern atomic_t fscache_n_retrievals_nomem;
167extern atomic_t fscache_n_retrieval_ops;
168extern atomic_t fscache_n_retrieval_op_waits;
169
170extern atomic_t fscache_n_stores;
171extern atomic_t fscache_n_stores_ok;
172extern atomic_t fscache_n_stores_again;
173extern atomic_t fscache_n_stores_nobufs;
174extern atomic_t fscache_n_stores_oom;
175extern atomic_t fscache_n_store_ops;
176extern atomic_t fscache_n_store_calls;
177
178extern atomic_t fscache_n_marks;
179extern atomic_t fscache_n_uncaches;
180
181extern atomic_t fscache_n_acquires;
182extern atomic_t fscache_n_acquires_null;
183extern atomic_t fscache_n_acquires_no_cache;
184extern atomic_t fscache_n_acquires_ok;
185extern atomic_t fscache_n_acquires_nobufs;
186extern atomic_t fscache_n_acquires_oom;
187
188extern atomic_t fscache_n_updates;
189extern atomic_t fscache_n_updates_null;
190extern atomic_t fscache_n_updates_run;
191
192extern atomic_t fscache_n_relinquishes;
193extern atomic_t fscache_n_relinquishes_null;
194extern atomic_t fscache_n_relinquishes_waitcrt;
195
196extern atomic_t fscache_n_cookie_index;
197extern atomic_t fscache_n_cookie_data;
198extern atomic_t fscache_n_cookie_special;
199
200extern atomic_t fscache_n_object_alloc;
201extern atomic_t fscache_n_object_no_alloc;
202extern atomic_t fscache_n_object_lookups;
203extern atomic_t fscache_n_object_lookups_negative;
204extern atomic_t fscache_n_object_lookups_positive;
205extern atomic_t fscache_n_object_created;
206extern atomic_t fscache_n_object_avail;
207extern atomic_t fscache_n_object_dead;
208
209extern atomic_t fscache_n_checkaux_none;
210extern atomic_t fscache_n_checkaux_okay;
211extern atomic_t fscache_n_checkaux_update;
212extern atomic_t fscache_n_checkaux_obsolete;
213
52bd75fd
DH		 214extern atomic_t fscache_n_cop_alloc_object;
215extern atomic_t fscache_n_cop_lookup_object;
216extern atomic_t fscache_n_cop_lookup_complete;
217extern atomic_t fscache_n_cop_grab_object;
218extern atomic_t fscache_n_cop_update_object;
219extern atomic_t fscache_n_cop_drop_object;
220extern atomic_t fscache_n_cop_put_object;
221extern atomic_t fscache_n_cop_sync_cache;
222extern atomic_t fscache_n_cop_attr_changed;
223extern atomic_t fscache_n_cop_read_or_alloc_page;
224extern atomic_t fscache_n_cop_read_or_alloc_pages;
225extern atomic_t fscache_n_cop_allocate_page;
226extern atomic_t fscache_n_cop_allocate_pages;
227extern atomic_t fscache_n_cop_write_page;
228extern atomic_t fscache_n_cop_uncache_page;
229extern atomic_t fscache_n_cop_dissociate_pages;
230
7394daa8
DH		 231static inline void fscache_stat(atomic_t *stat)
232{
233 atomic_inc(stat);
234}
235
52bd75fd
DH		 236static inline void fscache_stat_d(atomic_t *stat)
237{
238 atomic_dec(stat);
239}
240
7394daa8
DH		 241extern const struct file_operations fscache_stats_fops;
242#else
243
244#define fscache_stat(stat) do {} while (0)
245#endif
246
0e04d4ce
DH		 247/*
248 * raise an event on an object
249 * - if the event is not masked for that object, then the object is
250 * queued for attention by the thread pool.
251 */
252static inline void fscache_raise_event(struct fscache_object *object,
253 unsigned event)
254{
36c95590
DH		 255 if (!test_and_set_bit(event, &object->events) &&
256 test_bit(event, &object->event_mask))
257 fscache_enqueue_object(object);
258}
259
260/*
261 * drop a reference to a cookie
262 */
263static inline void fscache_cookie_put(struct fscache_cookie *cookie)
264{
265 BUG_ON(atomic_read(&cookie->usage) <= 0);
266 if (atomic_dec_and_test(&cookie->usage))
267 __fscache_cookie_put(cookie);
0e04d4ce
DH		 268}
269
b5108822
DH		 270/*
271 * get an extra reference to a netfs retrieval context
272 */
273static inline
274void *fscache_get_context(struct fscache_cookie *cookie, void *context)
275{
276 if (cookie->def->get_context)
277 cookie->def->get_context(cookie->netfs_data, context);
278 return context;
279}
280
281/*
282 * release a reference to a netfs retrieval context
283 */
284static inline
285void fscache_put_context(struct fscache_cookie *cookie, void *context)
286{
287 if (cookie->def->put_context)
288 cookie->def->put_context(cookie->netfs_data, context);
289}
290
06b3db1b
DH		 291/*****************************************************************************/
292/*
293 * debug tracing
294 */
295#define dbgprintk(FMT, ...) \
296 printk(KERN_DEBUG "[%-6.6s] "FMT"\n", current->comm, ##__VA_ARGS__)
297
298/* make sure we maintain the format strings, even when debugging is disabled */
299static inline __attribute__((format(printf, 1, 2)))
300void _dbprintk(const char *fmt, ...)
301{
302}
303
304#define kenter(FMT, ...) dbgprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
305#define kleave(FMT, ...) dbgprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
306#define kdebug(FMT, ...) dbgprintk(FMT, ##__VA_ARGS__)
307
308#define kjournal(FMT, ...) _dbprintk(FMT, ##__VA_ARGS__)
309
310#ifdef __KDEBUG
311#define _enter(FMT, ...) kenter(FMT, ##__VA_ARGS__)
312#define _leave(FMT, ...) kleave(FMT, ##__VA_ARGS__)
313#define _debug(FMT, ...) kdebug(FMT, ##__VA_ARGS__)
314
315#elif defined(CONFIG_FSCACHE_DEBUG)
316#define _enter(FMT, ...) \
317do { \
318 if (__do_kdebug(ENTER)) \
319 kenter(FMT, ##__VA_ARGS__); \
320} while (0)
321
322#define _leave(FMT, ...) \
323do { \
324 if (__do_kdebug(LEAVE)) \
325 kleave(FMT, ##__VA_ARGS__); \
326} while (0)
327
328#define _debug(FMT, ...) \
329do { \
330 if (__do_kdebug(DEBUG)) \
331 kdebug(FMT, ##__VA_ARGS__); \
332} while (0)
333
334#else
335#define _enter(FMT, ...) _dbprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
336#define _leave(FMT, ...) _dbprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
337#define _debug(FMT, ...) _dbprintk(FMT, ##__VA_ARGS__)
338#endif
339
340/*
341 * determine whether a particular optional debugging point should be logged
342 * - we need to go through three steps to persuade cpp to correctly join the
343 * shorthand in FSCACHE_DEBUG_LEVEL with its prefix
344 */
345#define ____do_kdebug(LEVEL, POINT) \
346 unlikely((fscache_debug & \
347 (FSCACHE_POINT_##POINT << (FSCACHE_DEBUG_ ## LEVEL * 3))))
348#define ___do_kdebug(LEVEL, POINT) \
349 ____do_kdebug(LEVEL, POINT)
350#define __do_kdebug(POINT) \
351 ___do_kdebug(FSCACHE_DEBUG_LEVEL, POINT)
352
353#define FSCACHE_DEBUG_CACHE 0
354#define FSCACHE_DEBUG_COOKIE 1
355#define FSCACHE_DEBUG_PAGE 2
356#define FSCACHE_DEBUG_OPERATION 3
357
358#define FSCACHE_POINT_ENTER 1
359#define FSCACHE_POINT_LEAVE 2
360#define FSCACHE_POINT_DEBUG 4
361
362#ifndef FSCACHE_DEBUG_LEVEL
363#define FSCACHE_DEBUG_LEVEL CACHE
364#endif
365
366/*
367 * assertions
368 */
369#if 1 /* defined(__KDEBUGALL) */
370
371#define ASSERT(X) \
372do { \
373 if (unlikely(!(X))) { \
374 printk(KERN_ERR "\n"); \
375 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
376 BUG(); \
377 } \
378} while (0)
379
380#define ASSERTCMP(X, OP, Y) \
381do { \
382 if (unlikely(!((X) OP (Y)))) { \
383 printk(KERN_ERR "\n"); \
384 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
385 printk(KERN_ERR "%lx " #OP " %lx is false\n", \
386 (unsigned long)(X), (unsigned long)(Y)); \
387 BUG(); \
388 } \
389} while (0)
390
391#define ASSERTIF(C, X) \
392do { \
393 if (unlikely((C) && !(X))) { \
394 printk(KERN_ERR "\n"); \
395 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
396 BUG(); \
397 } \
398} while (0)
399
400#define ASSERTIFCMP(C, X, OP, Y) \
401do { \
402 if (unlikely((C) && !((X) OP (Y)))) { \
403 printk(KERN_ERR "\n"); \
404 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
405 printk(KERN_ERR "%lx " #OP " %lx is false\n", \
406 (unsigned long)(X), (unsigned long)(Y)); \
407 BUG(); \
408 } \
409} while (0)
410
411#else
412
413#define ASSERT(X) do {} while (0)
414#define ASSERTCMP(X, OP, Y) do {} while (0)
415#define ASSERTIF(C, X) do {} while (0)
416#define ASSERTIFCMP(C, X, OP, Y) do {} while (0)
417
418#endif /* assert or not */
Clone of davem's net-next-2.6 tree