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 * - cookie->stores_lock
21 * - fscache_thread_lock
25 #include <linux/fscache-cache.h>
26 #include <linux/sched.h>
28 #define FSCACHE_MIN_THREADS 4
29 #define FSCACHE_MAX_THREADS 32
34 extern struct list_head fscache_cache_list;
35 extern struct rw_semaphore fscache_addremove_sem;
37 extern struct fscache_cache *fscache_select_cache_for_object(
38 struct fscache_cookie *);
43 extern struct kmem_cache *fscache_cookie_jar;
45 extern void fscache_cookie_init_once(void *);
46 extern void __fscache_cookie_put(struct fscache_cookie *);
51 extern struct fscache_cookie fscache_fsdef_index;
52 extern struct fscache_cookie_def fscache_fsdef_netfs_def;
57 #ifdef CONFIG_FSCACHE_HISTOGRAM
58 extern atomic_t fscache_obj_instantiate_histogram[HZ];
59 extern atomic_t fscache_objs_histogram[HZ];
60 extern atomic_t fscache_ops_histogram[HZ];
61 extern atomic_t fscache_retrieval_delay_histogram[HZ];
62 extern atomic_t fscache_retrieval_histogram[HZ];
64 static inline void fscache_hist(atomic_t histogram[], unsigned long start_jif)
66 unsigned long jif = jiffies - start_jif;
69 atomic_inc(&histogram[jif]);
72 extern const struct file_operations fscache_histogram_fops;
75 #define fscache_hist(hist, start_jif) do {} while (0)
81 extern unsigned fscache_defer_lookup;
82 extern unsigned fscache_defer_create;
83 extern unsigned fscache_debug;
84 extern struct kobject *fscache_root;
86 extern int fscache_wait_bit(void *);
87 extern int fscache_wait_bit_interruptible(void *);
92 extern const char fscache_object_states_short[FSCACHE_OBJECT__NSTATES][5];
94 extern void fscache_withdrawing_object(struct fscache_cache *,
95 struct fscache_object *);
96 extern void fscache_enqueue_object(struct fscache_object *);
101 #ifdef CONFIG_FSCACHE_OBJECT_LIST
102 extern const struct file_operations fscache_objlist_fops;
104 extern void fscache_objlist_add(struct fscache_object *);
106 #define fscache_objlist_add(object) do {} while(0)
112 extern int fscache_submit_exclusive_op(struct fscache_object *,
113 struct fscache_operation *);
114 extern int fscache_submit_op(struct fscache_object *,
115 struct fscache_operation *);
116 extern int fscache_cancel_op(struct fscache_operation *);
117 extern void fscache_abort_object(struct fscache_object *);
118 extern void fscache_start_operations(struct fscache_object *);
119 extern void fscache_operation_gc(struct work_struct *);
124 #ifdef CONFIG_PROC_FS
125 extern int __init fscache_proc_init(void);
126 extern void fscache_proc_cleanup(void);
128 #define fscache_proc_init() (0)
129 #define fscache_proc_cleanup() do {} while (0)
135 #ifdef CONFIG_FSCACHE_STATS
136 extern atomic_t fscache_n_ops_processed[FSCACHE_MAX_THREADS];
137 extern atomic_t fscache_n_objs_processed[FSCACHE_MAX_THREADS];
139 extern atomic_t fscache_n_op_pend;
140 extern atomic_t fscache_n_op_run;
141 extern atomic_t fscache_n_op_enqueue;
142 extern atomic_t fscache_n_op_deferred_release;
143 extern atomic_t fscache_n_op_release;
144 extern atomic_t fscache_n_op_gc;
145 extern atomic_t fscache_n_op_cancelled;
147 extern atomic_t fscache_n_attr_changed;
148 extern atomic_t fscache_n_attr_changed_ok;
149 extern atomic_t fscache_n_attr_changed_nobufs;
150 extern atomic_t fscache_n_attr_changed_nomem;
151 extern atomic_t fscache_n_attr_changed_calls;
153 extern atomic_t fscache_n_allocs;
154 extern atomic_t fscache_n_allocs_ok;
155 extern atomic_t fscache_n_allocs_wait;
156 extern atomic_t fscache_n_allocs_nobufs;
157 extern atomic_t fscache_n_allocs_intr;
158 extern atomic_t fscache_n_alloc_ops;
159 extern atomic_t fscache_n_alloc_op_waits;
161 extern atomic_t fscache_n_retrievals;
162 extern atomic_t fscache_n_retrievals_ok;
163 extern atomic_t fscache_n_retrievals_wait;
164 extern atomic_t fscache_n_retrievals_nodata;
165 extern atomic_t fscache_n_retrievals_nobufs;
166 extern atomic_t fscache_n_retrievals_intr;
167 extern atomic_t fscache_n_retrievals_nomem;
168 extern atomic_t fscache_n_retrieval_ops;
169 extern atomic_t fscache_n_retrieval_op_waits;
171 extern atomic_t fscache_n_stores;
172 extern atomic_t fscache_n_stores_ok;
173 extern atomic_t fscache_n_stores_again;
174 extern atomic_t fscache_n_stores_nobufs;
175 extern atomic_t fscache_n_stores_oom;
176 extern atomic_t fscache_n_store_ops;
177 extern atomic_t fscache_n_store_calls;
178 extern atomic_t fscache_n_store_pages;
179 extern atomic_t fscache_n_store_radix_deletes;
180 extern atomic_t fscache_n_store_pages_over_limit;
182 extern atomic_t fscache_n_marks;
183 extern atomic_t fscache_n_uncaches;
185 extern atomic_t fscache_n_acquires;
186 extern atomic_t fscache_n_acquires_null;
187 extern atomic_t fscache_n_acquires_no_cache;
188 extern atomic_t fscache_n_acquires_ok;
189 extern atomic_t fscache_n_acquires_nobufs;
190 extern atomic_t fscache_n_acquires_oom;
192 extern atomic_t fscache_n_updates;
193 extern atomic_t fscache_n_updates_null;
194 extern atomic_t fscache_n_updates_run;
196 extern atomic_t fscache_n_relinquishes;
197 extern atomic_t fscache_n_relinquishes_null;
198 extern atomic_t fscache_n_relinquishes_waitcrt;
200 extern atomic_t fscache_n_cookie_index;
201 extern atomic_t fscache_n_cookie_data;
202 extern atomic_t fscache_n_cookie_special;
204 extern atomic_t fscache_n_object_alloc;
205 extern atomic_t fscache_n_object_no_alloc;
206 extern atomic_t fscache_n_object_lookups;
207 extern atomic_t fscache_n_object_lookups_negative;
208 extern atomic_t fscache_n_object_lookups_positive;
209 extern atomic_t fscache_n_object_created;
210 extern atomic_t fscache_n_object_avail;
211 extern atomic_t fscache_n_object_dead;
213 extern atomic_t fscache_n_checkaux_none;
214 extern atomic_t fscache_n_checkaux_okay;
215 extern atomic_t fscache_n_checkaux_update;
216 extern atomic_t fscache_n_checkaux_obsolete;
218 extern atomic_t fscache_n_cop_alloc_object;
219 extern atomic_t fscache_n_cop_lookup_object;
220 extern atomic_t fscache_n_cop_lookup_complete;
221 extern atomic_t fscache_n_cop_grab_object;
222 extern atomic_t fscache_n_cop_update_object;
223 extern atomic_t fscache_n_cop_drop_object;
224 extern atomic_t fscache_n_cop_put_object;
225 extern atomic_t fscache_n_cop_sync_cache;
226 extern atomic_t fscache_n_cop_attr_changed;
227 extern atomic_t fscache_n_cop_read_or_alloc_page;
228 extern atomic_t fscache_n_cop_read_or_alloc_pages;
229 extern atomic_t fscache_n_cop_allocate_page;
230 extern atomic_t fscache_n_cop_allocate_pages;
231 extern atomic_t fscache_n_cop_write_page;
232 extern atomic_t fscache_n_cop_uncache_page;
233 extern atomic_t fscache_n_cop_dissociate_pages;
235 static inline void fscache_stat(atomic_t *stat)
240 static inline void fscache_stat_d(atomic_t *stat)
245 extern const struct file_operations fscache_stats_fops;
248 #define fscache_stat(stat) do {} while (0)
252 * raise an event on an object
253 * - if the event is not masked for that object, then the object is
254 * queued for attention by the thread pool.
256 static inline void fscache_raise_event(struct fscache_object *object,
259 if (!test_and_set_bit(event, &object->events) &&
260 test_bit(event, &object->event_mask))
261 fscache_enqueue_object(object);
265 * drop a reference to a cookie
267 static inline void fscache_cookie_put(struct fscache_cookie *cookie)
269 BUG_ON(atomic_read(&cookie->usage) <= 0);
270 if (atomic_dec_and_test(&cookie->usage))
271 __fscache_cookie_put(cookie);
275 * get an extra reference to a netfs retrieval context
278 void *fscache_get_context(struct fscache_cookie *cookie, void *context)
280 if (cookie->def->get_context)
281 cookie->def->get_context(cookie->netfs_data, context);
286 * release a reference to a netfs retrieval context
289 void fscache_put_context(struct fscache_cookie *cookie, void *context)
291 if (cookie->def->put_context)
292 cookie->def->put_context(cookie->netfs_data, context);
295 /*****************************************************************************/
299 #define dbgprintk(FMT, ...) \
300 printk(KERN_DEBUG "[%-6.6s] "FMT"\n", current->comm, ##__VA_ARGS__)
302 /* make sure we maintain the format strings, even when debugging is disabled */
303 static inline __attribute__((format(printf, 1, 2)))
304 void _dbprintk(const char *fmt, ...)
308 #define kenter(FMT, ...) dbgprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
309 #define kleave(FMT, ...) dbgprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
310 #define kdebug(FMT, ...) dbgprintk(FMT, ##__VA_ARGS__)
312 #define kjournal(FMT, ...) _dbprintk(FMT, ##__VA_ARGS__)
315 #define _enter(FMT, ...) kenter(FMT, ##__VA_ARGS__)
316 #define _leave(FMT, ...) kleave(FMT, ##__VA_ARGS__)
317 #define _debug(FMT, ...) kdebug(FMT, ##__VA_ARGS__)
319 #elif defined(CONFIG_FSCACHE_DEBUG)
320 #define _enter(FMT, ...) \
322 if (__do_kdebug(ENTER)) \
323 kenter(FMT, ##__VA_ARGS__); \
326 #define _leave(FMT, ...) \
328 if (__do_kdebug(LEAVE)) \
329 kleave(FMT, ##__VA_ARGS__); \
332 #define _debug(FMT, ...) \
334 if (__do_kdebug(DEBUG)) \
335 kdebug(FMT, ##__VA_ARGS__); \
339 #define _enter(FMT, ...) _dbprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
340 #define _leave(FMT, ...) _dbprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
341 #define _debug(FMT, ...) _dbprintk(FMT, ##__VA_ARGS__)
345 * determine whether a particular optional debugging point should be logged
346 * - we need to go through three steps to persuade cpp to correctly join the
347 * shorthand in FSCACHE_DEBUG_LEVEL with its prefix
349 #define ____do_kdebug(LEVEL, POINT) \
350 unlikely((fscache_debug & \
351 (FSCACHE_POINT_##POINT << (FSCACHE_DEBUG_ ## LEVEL * 3))))
352 #define ___do_kdebug(LEVEL, POINT) \
353 ____do_kdebug(LEVEL, POINT)
354 #define __do_kdebug(POINT) \
355 ___do_kdebug(FSCACHE_DEBUG_LEVEL, POINT)
357 #define FSCACHE_DEBUG_CACHE 0
358 #define FSCACHE_DEBUG_COOKIE 1
359 #define FSCACHE_DEBUG_PAGE 2
360 #define FSCACHE_DEBUG_OPERATION 3
362 #define FSCACHE_POINT_ENTER 1
363 #define FSCACHE_POINT_LEAVE 2
364 #define FSCACHE_POINT_DEBUG 4
366 #ifndef FSCACHE_DEBUG_LEVEL
367 #define FSCACHE_DEBUG_LEVEL CACHE
373 #if 1 /* defined(__KDEBUGALL) */
377 if (unlikely(!(X))) { \
378 printk(KERN_ERR "\n"); \
379 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
384 #define ASSERTCMP(X, OP, Y) \
386 if (unlikely(!((X) OP (Y)))) { \
387 printk(KERN_ERR "\n"); \
388 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
389 printk(KERN_ERR "%lx " #OP " %lx is false\n", \
390 (unsigned long)(X), (unsigned long)(Y)); \
395 #define ASSERTIF(C, X) \
397 if (unlikely((C) && !(X))) { \
398 printk(KERN_ERR "\n"); \
399 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
404 #define ASSERTIFCMP(C, X, OP, Y) \
406 if (unlikely((C) && !((X) OP (Y)))) { \
407 printk(KERN_ERR "\n"); \
408 printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
409 printk(KERN_ERR "%lx " #OP " %lx is false\n", \
410 (unsigned long)(X), (unsigned long)(Y)); \
417 #define ASSERT(X) do {} while (0)
418 #define ASSERTCMP(X, OP, Y) do {} while (0)
419 #define ASSERTIF(C, X) do {} while (0)
420 #define ASSERTIFCMP(C, X, OP, Y) do {} while (0)
422 #endif /* assert or not */