1 /* Internal definitions for FS-Cache
3 * Copyright (C) 2004-2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
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.
13 * Lock order, in the order in which multiple locks should be obtained:
14 * - fscache_addremove_sem
16 * - cookie->parent->lock
17 * - cache->object_list_lock
19 * - object->parent->lock
20 * - fscache_thread_lock
24 #include <linux/fscache-cache.h>
25 #include <linux/sched.h>
27 #define FSCACHE_MIN_THREADS 4
28 #define FSCACHE_MAX_THREADS 32
33 extern struct list_head fscache_cache_list;
34 extern struct rw_semaphore fscache_addremove_sem;
36 extern struct fscache_cache *fscache_select_cache_for_object(
37 struct fscache_cookie *);
42 extern struct fscache_cookie fscache_fsdef_index;
43 extern struct fscache_cookie_def fscache_fsdef_netfs_def;
48 #ifdef CONFIG_FSCACHE_HISTOGRAM
49 extern atomic_t fscache_obj_instantiate_histogram[HZ];
50 extern atomic_t fscache_objs_histogram[HZ];
51 extern atomic_t fscache_ops_histogram[HZ];
52 extern atomic_t fscache_retrieval_delay_histogram[HZ];
53 extern atomic_t fscache_retrieval_histogram[HZ];
55 static inline void fscache_hist(atomic_t histogram[], unsigned long start_jif)
57 unsigned long jif = jiffies - start_jif;
60 atomic_inc(&histogram[jif]);
63 extern const struct file_operations fscache_histogram_fops;
66 #define fscache_hist(hist, start_jif) do {} while (0)
72 extern unsigned fscache_defer_lookup;
73 extern unsigned fscache_defer_create;
74 extern unsigned fscache_debug;
75 extern struct kobject *fscache_root;
81 extern int __init fscache_proc_init(void);
82 extern void fscache_proc_cleanup(void);
84 #define fscache_proc_init() (0)
85 #define fscache_proc_cleanup() do {} while (0)
91 #ifdef CONFIG_FSCACHE_STATS
92 extern atomic_t fscache_n_ops_processed[FSCACHE_MAX_THREADS];
93 extern atomic_t fscache_n_objs_processed[FSCACHE_MAX_THREADS];
95 extern atomic_t fscache_n_op_pend;
96 extern atomic_t fscache_n_op_run;
97 extern atomic_t fscache_n_op_enqueue;
98 extern atomic_t fscache_n_op_deferred_release;
99 extern atomic_t fscache_n_op_release;
100 extern atomic_t fscache_n_op_gc;
102 extern atomic_t fscache_n_attr_changed;
103 extern atomic_t fscache_n_attr_changed_ok;
104 extern atomic_t fscache_n_attr_changed_nobufs;
105 extern atomic_t fscache_n_attr_changed_nomem;
106 extern atomic_t fscache_n_attr_changed_calls;
108 extern atomic_t fscache_n_allocs;
109 extern atomic_t fscache_n_allocs_ok;
110 extern atomic_t fscache_n_allocs_wait;
111 extern atomic_t fscache_n_allocs_nobufs;
112 extern atomic_t fscache_n_alloc_ops;
113 extern atomic_t fscache_n_alloc_op_waits;
115 extern atomic_t fscache_n_retrievals;
116 extern atomic_t fscache_n_retrievals_ok;
117 extern atomic_t fscache_n_retrievals_wait;
118 extern atomic_t fscache_n_retrievals_nodata;
119 extern atomic_t fscache_n_retrievals_nobufs;
120 extern atomic_t fscache_n_retrievals_intr;
121 extern atomic_t fscache_n_retrievals_nomem;
122 extern atomic_t fscache_n_retrieval_ops;
123 extern atomic_t fscache_n_retrieval_op_waits;
125 extern atomic_t fscache_n_stores;
126 extern atomic_t fscache_n_stores_ok;
127 extern atomic_t fscache_n_stores_again;
128 extern atomic_t fscache_n_stores_nobufs;
129 extern atomic_t fscache_n_stores_oom;
130 extern atomic_t fscache_n_store_ops;
131 extern atomic_t fscache_n_store_calls;
133 extern atomic_t fscache_n_marks;
134 extern atomic_t fscache_n_uncaches;
136 extern atomic_t fscache_n_acquires;
137 extern atomic_t fscache_n_acquires_null;
138 extern atomic_t fscache_n_acquires_no_cache;
139 extern atomic_t fscache_n_acquires_ok;
140 extern atomic_t fscache_n_acquires_nobufs;
141 extern atomic_t fscache_n_acquires_oom;
143 extern atomic_t fscache_n_updates;
144 extern atomic_t fscache_n_updates_null;
145 extern atomic_t fscache_n_updates_run;
147 extern atomic_t fscache_n_relinquishes;
148 extern atomic_t fscache_n_relinquishes_null;
149 extern atomic_t fscache_n_relinquishes_waitcrt;
151 extern atomic_t fscache_n_cookie_index;
152 extern atomic_t fscache_n_cookie_data;
153 extern atomic_t fscache_n_cookie_special;
155 extern atomic_t fscache_n_object_alloc;
156 extern atomic_t fscache_n_object_no_alloc;
157 extern atomic_t fscache_n_object_lookups;
158 extern atomic_t fscache_n_object_lookups_negative;
159 extern atomic_t fscache_n_object_lookups_positive;
160 extern atomic_t fscache_n_object_created;
161 extern atomic_t fscache_n_object_avail;
162 extern atomic_t fscache_n_object_dead;
164 extern atomic_t fscache_n_checkaux_none;
165 extern atomic_t fscache_n_checkaux_okay;
166 extern atomic_t fscache_n_checkaux_update;
167 extern atomic_t fscache_n_checkaux_obsolete;
169 static inline void fscache_stat(atomic_t *stat)
174 extern const struct file_operations fscache_stats_fops;
177 #define fscache_stat(stat) do {} while (0)
181 * raise an event on an object
182 * - if the event is not masked for that object, then the object is
183 * queued for attention by the thread pool.
185 static inline void fscache_raise_event(struct fscache_object *object,
191 /*****************************************************************************/
195 #define dbgprintk(FMT, ...) \
196 printk(KERN_DEBUG "[%-6.6s] "FMT"\n", current->comm, ##__VA_ARGS__)
198 /* make sure we maintain the format strings, even when debugging is disabled */
199 static inline __attribute__((format(printf, 1, 2)))
200 void _dbprintk(const char *fmt, ...)
204 #define kenter(FMT, ...) dbgprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
205 #define kleave(FMT, ...) dbgprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
206 #define kdebug(FMT, ...) dbgprintk(FMT, ##__VA_ARGS__)
208 #define kjournal(FMT, ...) _dbprintk(FMT, ##__VA_ARGS__)
211 #define _enter(FMT, ...) kenter(FMT, ##__VA_ARGS__)
212 #define _leave(FMT, ...) kleave(FMT, ##__VA_ARGS__)
213 #define _debug(FMT, ...) kdebug(FMT, ##__VA_ARGS__)
215 #elif defined(CONFIG_FSCACHE_DEBUG)
216 #define _enter(FMT, ...) \
218 if (__do_kdebug(ENTER)) \
219 kenter(FMT, ##__VA_ARGS__); \
222 #define _leave(FMT, ...) \
224 if (__do_kdebug(LEAVE)) \
225 kleave(FMT, ##__VA_ARGS__); \
228 #define _debug(FMT, ...) \
230 if (__do_kdebug(DEBUG)) \
231 kdebug(FMT, ##__VA_ARGS__); \
235 #define _enter(FMT, ...) _dbprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
236 #define _leave(FMT, ...) _dbprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
237 #define _debug(FMT, ...) _dbprintk(FMT, ##__VA_ARGS__)
241 * determine whether a particular optional debugging point should be logged
242 * - we need to go through three steps to persuade cpp to correctly join the
243 * shorthand in FSCACHE_DEBUG_LEVEL with its prefix
245 #define ____do_kdebug(LEVEL, POINT) \
246 unlikely((fscache_debug & \
247 (FSCACHE_POINT_##POINT << (FSCACHE_DEBUG_ ## LEVEL * 3))))
248 #define ___do_kdebug(LEVEL, POINT) \
249 ____do_kdebug(LEVEL, POINT)
250 #define __do_kdebug(POINT) \
251 ___do_kdebug(FSCACHE_DEBUG_LEVEL, POINT)
253 #define FSCACHE_DEBUG_CACHE 0
254 #define FSCACHE_DEBUG_COOKIE 1
255 #define FSCACHE_DEBUG_PAGE 2
256 #define FSCACHE_DEBUG_OPERATION 3
258 #define FSCACHE_POINT_ENTER 1
259 #define FSCACHE_POINT_LEAVE 2
260 #define FSCACHE_POINT_DEBUG 4
262 #ifndef FSCACHE_DEBUG_LEVEL
263 #define FSCACHE_DEBUG_LEVEL CACHE
269 #if 1 /* defined(__KDEBUGALL) */
273 if (unlikely(!(X))) { \
274 printk(KERN_ERR "\n"); \
275 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
280 #define ASSERTCMP(X, OP, Y) \
282 if (unlikely(!((X) OP (Y)))) { \
283 printk(KERN_ERR "\n"); \
284 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
285 printk(KERN_ERR "%lx " #OP " %lx is false\n", \
286 (unsigned long)(X), (unsigned long)(Y)); \
291 #define ASSERTIF(C, X) \
293 if (unlikely((C) && !(X))) { \
294 printk(KERN_ERR "\n"); \
295 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
300 #define ASSERTIFCMP(C, X, OP, Y) \
302 if (unlikely((C) && !((X) OP (Y)))) { \
303 printk(KERN_ERR "\n"); \
304 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
305 printk(KERN_ERR "%lx " #OP " %lx is false\n", \
306 (unsigned long)(X), (unsigned long)(Y)); \
313 #define ASSERT(X) do {} while (0)
314 #define ASSERTCMP(X, OP, Y) do {} while (0)
315 #define ASSERTIF(C, X) do {} while (0)
316 #define ASSERTIFCMP(C, X, OP, Y) do {} while (0)
318 #endif /* assert or not */