projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
FS-Cache: Use radix tree preload correctly in tracking of pages to be stored
[deliverable/linux.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 *);
115extern void fscache_abort_object(struct fscache_object *);
116extern void fscache_start_operations(struct fscache_object *);
117extern void fscache_operation_gc(struct work_struct *);
36c95590 118
7394daa8 119/*
348ca102 120 * proc.c
7394daa8
DH		 121 */
122#ifdef CONFIG_PROC_FS
123extern int __init fscache_proc_init(void);
124extern void fscache_proc_cleanup(void);
125#else
126#define fscache_proc_init() (0)
127#define fscache_proc_cleanup() do {} while (0)
128#endif
129
130/*
348ca102 131 * stats.c
7394daa8
DH		 132 */
133#ifdef CONFIG_FSCACHE_STATS
134extern atomic_t fscache_n_ops_processed[FSCACHE_MAX_THREADS];
135extern atomic_t fscache_n_objs_processed[FSCACHE_MAX_THREADS];
136
137extern atomic_t fscache_n_op_pend;
138extern atomic_t fscache_n_op_run;
139extern atomic_t fscache_n_op_enqueue;
140extern atomic_t fscache_n_op_deferred_release;
141extern atomic_t fscache_n_op_release;
142extern atomic_t fscache_n_op_gc;
143
144extern atomic_t fscache_n_attr_changed;
145extern atomic_t fscache_n_attr_changed_ok;
146extern atomic_t fscache_n_attr_changed_nobufs;
147extern atomic_t fscache_n_attr_changed_nomem;
148extern atomic_t fscache_n_attr_changed_calls;
149
150extern atomic_t fscache_n_allocs;
151extern atomic_t fscache_n_allocs_ok;
152extern atomic_t fscache_n_allocs_wait;
153extern atomic_t fscache_n_allocs_nobufs;
154extern atomic_t fscache_n_alloc_ops;
155extern atomic_t fscache_n_alloc_op_waits;
156
157extern atomic_t fscache_n_retrievals;
158extern atomic_t fscache_n_retrievals_ok;
159extern atomic_t fscache_n_retrievals_wait;
160extern atomic_t fscache_n_retrievals_nodata;
161extern atomic_t fscache_n_retrievals_nobufs;
162extern atomic_t fscache_n_retrievals_intr;
163extern atomic_t fscache_n_retrievals_nomem;
164extern atomic_t fscache_n_retrieval_ops;
165extern atomic_t fscache_n_retrieval_op_waits;
166
167extern atomic_t fscache_n_stores;
168extern atomic_t fscache_n_stores_ok;
169extern atomic_t fscache_n_stores_again;
170extern atomic_t fscache_n_stores_nobufs;
171extern atomic_t fscache_n_stores_oom;
172extern atomic_t fscache_n_store_ops;
173extern atomic_t fscache_n_store_calls;
174
175extern atomic_t fscache_n_marks;
176extern atomic_t fscache_n_uncaches;
177
178extern atomic_t fscache_n_acquires;
179extern atomic_t fscache_n_acquires_null;
180extern atomic_t fscache_n_acquires_no_cache;
181extern atomic_t fscache_n_acquires_ok;
182extern atomic_t fscache_n_acquires_nobufs;
183extern atomic_t fscache_n_acquires_oom;
184
185extern atomic_t fscache_n_updates;
186extern atomic_t fscache_n_updates_null;
187extern atomic_t fscache_n_updates_run;
188
189extern atomic_t fscache_n_relinquishes;
190extern atomic_t fscache_n_relinquishes_null;
191extern atomic_t fscache_n_relinquishes_waitcrt;
192
193extern atomic_t fscache_n_cookie_index;
194extern atomic_t fscache_n_cookie_data;
195extern atomic_t fscache_n_cookie_special;
196
197extern atomic_t fscache_n_object_alloc;
198extern atomic_t fscache_n_object_no_alloc;
199extern atomic_t fscache_n_object_lookups;
200extern atomic_t fscache_n_object_lookups_negative;
201extern atomic_t fscache_n_object_lookups_positive;
202extern atomic_t fscache_n_object_created;
203extern atomic_t fscache_n_object_avail;
204extern atomic_t fscache_n_object_dead;
205
206extern atomic_t fscache_n_checkaux_none;
207extern atomic_t fscache_n_checkaux_okay;
208extern atomic_t fscache_n_checkaux_update;
209extern atomic_t fscache_n_checkaux_obsolete;
210
52bd75fd
DH		 211extern atomic_t fscache_n_cop_alloc_object;
212extern atomic_t fscache_n_cop_lookup_object;
213extern atomic_t fscache_n_cop_lookup_complete;
214extern atomic_t fscache_n_cop_grab_object;
215extern atomic_t fscache_n_cop_update_object;
216extern atomic_t fscache_n_cop_drop_object;
217extern atomic_t fscache_n_cop_put_object;
218extern atomic_t fscache_n_cop_sync_cache;
219extern atomic_t fscache_n_cop_attr_changed;
220extern atomic_t fscache_n_cop_read_or_alloc_page;
221extern atomic_t fscache_n_cop_read_or_alloc_pages;
222extern atomic_t fscache_n_cop_allocate_page;
223extern atomic_t fscache_n_cop_allocate_pages;
224extern atomic_t fscache_n_cop_write_page;
225extern atomic_t fscache_n_cop_uncache_page;
226extern atomic_t fscache_n_cop_dissociate_pages;
227
7394daa8
DH		 228static inline void fscache_stat(atomic_t *stat)
229{
230 atomic_inc(stat);
231}
232
52bd75fd
DH		 233static inline void fscache_stat_d(atomic_t *stat)
234{
235 atomic_dec(stat);
236}
237
7394daa8
DH		 238extern const struct file_operations fscache_stats_fops;
239#else
240
241#define fscache_stat(stat) do {} while (0)
242#endif
243
0e04d4ce
DH		 244/*
245 * raise an event on an object
246 * - if the event is not masked for that object, then the object is
247 * queued for attention by the thread pool.
248 */
249static inline void fscache_raise_event(struct fscache_object *object,
250 unsigned event)
251{
36c95590
DH		 252 if (!test_and_set_bit(event, &object->events) &&
253 test_bit(event, &object->event_mask))
254 fscache_enqueue_object(object);
255}
256
257/*
258 * drop a reference to a cookie
259 */
260static inline void fscache_cookie_put(struct fscache_cookie *cookie)
261{
262 BUG_ON(atomic_read(&cookie->usage) <= 0);
263 if (atomic_dec_and_test(&cookie->usage))
264 __fscache_cookie_put(cookie);
0e04d4ce
DH		 265}
266
b5108822
DH		 267/*
268 * get an extra reference to a netfs retrieval context
269 */
270static inline
271void *fscache_get_context(struct fscache_cookie *cookie, void *context)
272{
273 if (cookie->def->get_context)
274 cookie->def->get_context(cookie->netfs_data, context);
275 return context;
276}
277
278/*
279 * release a reference to a netfs retrieval context
280 */
281static inline
282void fscache_put_context(struct fscache_cookie *cookie, void *context)
283{
284 if (cookie->def->put_context)
285 cookie->def->put_context(cookie->netfs_data, context);
286}
287
06b3db1b
DH		 288/*****************************************************************************/
289/*
290 * debug tracing
291 */
292#define dbgprintk(FMT, ...) \
293 printk(KERN_DEBUG "[%-6.6s] "FMT"\n", current->comm, ##__VA_ARGS__)
294
295/* make sure we maintain the format strings, even when debugging is disabled */
296static inline __attribute__((format(printf, 1, 2)))
297void _dbprintk(const char *fmt, ...)
298{
299}
300
301#define kenter(FMT, ...) dbgprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
302#define kleave(FMT, ...) dbgprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
303#define kdebug(FMT, ...) dbgprintk(FMT, ##__VA_ARGS__)
304
305#define kjournal(FMT, ...) _dbprintk(FMT, ##__VA_ARGS__)
306
307#ifdef __KDEBUG
308#define _enter(FMT, ...) kenter(FMT, ##__VA_ARGS__)
309#define _leave(FMT, ...) kleave(FMT, ##__VA_ARGS__)
310#define _debug(FMT, ...) kdebug(FMT, ##__VA_ARGS__)
311
312#elif defined(CONFIG_FSCACHE_DEBUG)
313#define _enter(FMT, ...) \
314do { \
315 if (__do_kdebug(ENTER)) \
316 kenter(FMT, ##__VA_ARGS__); \
317} while (0)
318
319#define _leave(FMT, ...) \
320do { \
321 if (__do_kdebug(LEAVE)) \
322 kleave(FMT, ##__VA_ARGS__); \
323} while (0)
324
325#define _debug(FMT, ...) \
326do { \
327 if (__do_kdebug(DEBUG)) \
328 kdebug(FMT, ##__VA_ARGS__); \
329} while (0)
330
331#else
332#define _enter(FMT, ...) _dbprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
333#define _leave(FMT, ...) _dbprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
334#define _debug(FMT, ...) _dbprintk(FMT, ##__VA_ARGS__)
335#endif
336
337/*
338 * determine whether a particular optional debugging point should be logged
339 * - we need to go through three steps to persuade cpp to correctly join the
340 * shorthand in FSCACHE_DEBUG_LEVEL with its prefix
341 */
342#define ____do_kdebug(LEVEL, POINT) \
343 unlikely((fscache_debug & \
344 (FSCACHE_POINT_##POINT << (FSCACHE_DEBUG_ ## LEVEL * 3))))
345#define ___do_kdebug(LEVEL, POINT) \
346 ____do_kdebug(LEVEL, POINT)
347#define __do_kdebug(POINT) \
348 ___do_kdebug(FSCACHE_DEBUG_LEVEL, POINT)
349
350#define FSCACHE_DEBUG_CACHE 0
351#define FSCACHE_DEBUG_COOKIE 1
352#define FSCACHE_DEBUG_PAGE 2
353#define FSCACHE_DEBUG_OPERATION 3
354
355#define FSCACHE_POINT_ENTER 1
356#define FSCACHE_POINT_LEAVE 2
357#define FSCACHE_POINT_DEBUG 4
358
359#ifndef FSCACHE_DEBUG_LEVEL
360#define FSCACHE_DEBUG_LEVEL CACHE
361#endif
362
363/*
364 * assertions
365 */
366#if 1 /* defined(__KDEBUGALL) */
367
368#define ASSERT(X) \
369do { \
370 if (unlikely(!(X))) { \
371 printk(KERN_ERR "\n"); \
372 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
373 BUG(); \
374 } \
375} while (0)
376
377#define ASSERTCMP(X, OP, Y) \
378do { \
379 if (unlikely(!((X) OP (Y)))) { \
380 printk(KERN_ERR "\n"); \
381 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
382 printk(KERN_ERR "%lx " #OP " %lx is false\n", \
383 (unsigned long)(X), (unsigned long)(Y)); \
384 BUG(); \
385 } \
386} while (0)
387
388#define ASSERTIF(C, X) \
389do { \
390 if (unlikely((C) && !(X))) { \
391 printk(KERN_ERR "\n"); \
392 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
393 BUG(); \
394 } \
395} while (0)
396
397#define ASSERTIFCMP(C, X, OP, Y) \
398do { \
399 if (unlikely((C) && !((X) OP (Y)))) { \
400 printk(KERN_ERR "\n"); \
401 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
402 printk(KERN_ERR "%lx " #OP " %lx is false\n", \
403 (unsigned long)(X), (unsigned long)(Y)); \
404 BUG(); \
405 } \
406} while (0)
407
408#else
409
410#define ASSERT(X) do {} while (0)
411#define ASSERTCMP(X, OP, Y) do {} while (0)
412#define ASSERTIF(C, X) do {} while (0)
413#define ASSERTIFCMP(C, X, OP, Y) do {} while (0)
414
415#endif /* assert or not */
Linux kernel - Deliverables
This page took 0.088334 seconds and 5 git commands to generate.