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 fscache_cookie fscache_fsdef_index;
34 extern struct fscache_cookie_def fscache_fsdef_netfs_def;
39 #ifdef CONFIG_FSCACHE_HISTOGRAM
40 extern atomic_t fscache_obj_instantiate_histogram[HZ];
41 extern atomic_t fscache_objs_histogram[HZ];
42 extern atomic_t fscache_ops_histogram[HZ];
43 extern atomic_t fscache_retrieval_delay_histogram[HZ];
44 extern atomic_t fscache_retrieval_histogram[HZ];
46 static inline void fscache_hist(atomic_t histogram[], unsigned long start_jif)
48 unsigned long jif = jiffies - start_jif;
51 atomic_inc(&histogram[jif]);
54 extern const struct file_operations fscache_histogram_fops;
57 #define fscache_hist(hist, start_jif) do {} while (0)
63 extern unsigned fscache_defer_lookup;
64 extern unsigned fscache_defer_create;
65 extern unsigned fscache_debug;
66 extern struct kobject *fscache_root;
72 extern int __init fscache_proc_init(void);
73 extern void fscache_proc_cleanup(void);
75 #define fscache_proc_init() (0)
76 #define fscache_proc_cleanup() do {} while (0)
82 #ifdef CONFIG_FSCACHE_STATS
83 extern atomic_t fscache_n_ops_processed[FSCACHE_MAX_THREADS];
84 extern atomic_t fscache_n_objs_processed[FSCACHE_MAX_THREADS];
86 extern atomic_t fscache_n_op_pend;
87 extern atomic_t fscache_n_op_run;
88 extern atomic_t fscache_n_op_enqueue;
89 extern atomic_t fscache_n_op_deferred_release;
90 extern atomic_t fscache_n_op_release;
91 extern atomic_t fscache_n_op_gc;
93 extern atomic_t fscache_n_attr_changed;
94 extern atomic_t fscache_n_attr_changed_ok;
95 extern atomic_t fscache_n_attr_changed_nobufs;
96 extern atomic_t fscache_n_attr_changed_nomem;
97 extern atomic_t fscache_n_attr_changed_calls;
99 extern atomic_t fscache_n_allocs;
100 extern atomic_t fscache_n_allocs_ok;
101 extern atomic_t fscache_n_allocs_wait;
102 extern atomic_t fscache_n_allocs_nobufs;
103 extern atomic_t fscache_n_alloc_ops;
104 extern atomic_t fscache_n_alloc_op_waits;
106 extern atomic_t fscache_n_retrievals;
107 extern atomic_t fscache_n_retrievals_ok;
108 extern atomic_t fscache_n_retrievals_wait;
109 extern atomic_t fscache_n_retrievals_nodata;
110 extern atomic_t fscache_n_retrievals_nobufs;
111 extern atomic_t fscache_n_retrievals_intr;
112 extern atomic_t fscache_n_retrievals_nomem;
113 extern atomic_t fscache_n_retrieval_ops;
114 extern atomic_t fscache_n_retrieval_op_waits;
116 extern atomic_t fscache_n_stores;
117 extern atomic_t fscache_n_stores_ok;
118 extern atomic_t fscache_n_stores_again;
119 extern atomic_t fscache_n_stores_nobufs;
120 extern atomic_t fscache_n_stores_oom;
121 extern atomic_t fscache_n_store_ops;
122 extern atomic_t fscache_n_store_calls;
124 extern atomic_t fscache_n_marks;
125 extern atomic_t fscache_n_uncaches;
127 extern atomic_t fscache_n_acquires;
128 extern atomic_t fscache_n_acquires_null;
129 extern atomic_t fscache_n_acquires_no_cache;
130 extern atomic_t fscache_n_acquires_ok;
131 extern atomic_t fscache_n_acquires_nobufs;
132 extern atomic_t fscache_n_acquires_oom;
134 extern atomic_t fscache_n_updates;
135 extern atomic_t fscache_n_updates_null;
136 extern atomic_t fscache_n_updates_run;
138 extern atomic_t fscache_n_relinquishes;
139 extern atomic_t fscache_n_relinquishes_null;
140 extern atomic_t fscache_n_relinquishes_waitcrt;
142 extern atomic_t fscache_n_cookie_index;
143 extern atomic_t fscache_n_cookie_data;
144 extern atomic_t fscache_n_cookie_special;
146 extern atomic_t fscache_n_object_alloc;
147 extern atomic_t fscache_n_object_no_alloc;
148 extern atomic_t fscache_n_object_lookups;
149 extern atomic_t fscache_n_object_lookups_negative;
150 extern atomic_t fscache_n_object_lookups_positive;
151 extern atomic_t fscache_n_object_created;
152 extern atomic_t fscache_n_object_avail;
153 extern atomic_t fscache_n_object_dead;
155 extern atomic_t fscache_n_checkaux_none;
156 extern atomic_t fscache_n_checkaux_okay;
157 extern atomic_t fscache_n_checkaux_update;
158 extern atomic_t fscache_n_checkaux_obsolete;
160 static inline void fscache_stat(atomic_t *stat)
165 extern const struct file_operations fscache_stats_fops;
168 #define fscache_stat(stat) do {} while (0)
171 /*****************************************************************************/
175 #define dbgprintk(FMT, ...) \
176 printk(KERN_DEBUG "[%-6.6s] "FMT"\n", current->comm, ##__VA_ARGS__)
178 /* make sure we maintain the format strings, even when debugging is disabled */
179 static inline __attribute__((format(printf, 1, 2)))
180 void _dbprintk(const char *fmt, ...)
184 #define kenter(FMT, ...) dbgprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
185 #define kleave(FMT, ...) dbgprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
186 #define kdebug(FMT, ...) dbgprintk(FMT, ##__VA_ARGS__)
188 #define kjournal(FMT, ...) _dbprintk(FMT, ##__VA_ARGS__)
191 #define _enter(FMT, ...) kenter(FMT, ##__VA_ARGS__)
192 #define _leave(FMT, ...) kleave(FMT, ##__VA_ARGS__)
193 #define _debug(FMT, ...) kdebug(FMT, ##__VA_ARGS__)
195 #elif defined(CONFIG_FSCACHE_DEBUG)
196 #define _enter(FMT, ...) \
198 if (__do_kdebug(ENTER)) \
199 kenter(FMT, ##__VA_ARGS__); \
202 #define _leave(FMT, ...) \
204 if (__do_kdebug(LEAVE)) \
205 kleave(FMT, ##__VA_ARGS__); \
208 #define _debug(FMT, ...) \
210 if (__do_kdebug(DEBUG)) \
211 kdebug(FMT, ##__VA_ARGS__); \
215 #define _enter(FMT, ...) _dbprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
216 #define _leave(FMT, ...) _dbprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
217 #define _debug(FMT, ...) _dbprintk(FMT, ##__VA_ARGS__)
221 * determine whether a particular optional debugging point should be logged
222 * - we need to go through three steps to persuade cpp to correctly join the
223 * shorthand in FSCACHE_DEBUG_LEVEL with its prefix
225 #define ____do_kdebug(LEVEL, POINT) \
226 unlikely((fscache_debug & \
227 (FSCACHE_POINT_##POINT << (FSCACHE_DEBUG_ ## LEVEL * 3))))
228 #define ___do_kdebug(LEVEL, POINT) \
229 ____do_kdebug(LEVEL, POINT)
230 #define __do_kdebug(POINT) \
231 ___do_kdebug(FSCACHE_DEBUG_LEVEL, POINT)
233 #define FSCACHE_DEBUG_CACHE 0
234 #define FSCACHE_DEBUG_COOKIE 1
235 #define FSCACHE_DEBUG_PAGE 2
236 #define FSCACHE_DEBUG_OPERATION 3
238 #define FSCACHE_POINT_ENTER 1
239 #define FSCACHE_POINT_LEAVE 2
240 #define FSCACHE_POINT_DEBUG 4
242 #ifndef FSCACHE_DEBUG_LEVEL
243 #define FSCACHE_DEBUG_LEVEL CACHE
249 #if 1 /* defined(__KDEBUGALL) */
253 if (unlikely(!(X))) { \
254 printk(KERN_ERR "\n"); \
255 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
260 #define ASSERTCMP(X, OP, Y) \
262 if (unlikely(!((X) OP (Y)))) { \
263 printk(KERN_ERR "\n"); \
264 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
265 printk(KERN_ERR "%lx " #OP " %lx is false\n", \
266 (unsigned long)(X), (unsigned long)(Y)); \
271 #define ASSERTIF(C, X) \
273 if (unlikely((C) && !(X))) { \
274 printk(KERN_ERR "\n"); \
275 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
280 #define ASSERTIFCMP(C, X, OP, Y) \
282 if (unlikely((C) && !((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)); \
293 #define ASSERT(X) do {} while (0)
294 #define ASSERTCMP(X, OP, Y) do {} while (0)
295 #define ASSERTIF(C, X) do {} while (0)
296 #define ASSERTIFCMP(C, X, OP, Y) do {} while (0)
298 #endif /* assert or not */