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
29 #define pr_fmt(fmt) "FS-Cache: " fmt
31 #include <linux/fscache-cache.h>
32 #include <linux/sched.h>
34 #define FSCACHE_MIN_THREADS 4
35 #define FSCACHE_MAX_THREADS 32
40 extern struct list_head fscache_cache_list;
41 extern struct rw_semaphore fscache_addremove_sem;
43 extern struct fscache_cache *fscache_select_cache_for_object(
44 struct fscache_cookie *);
49 extern struct kmem_cache *fscache_cookie_jar;
51 extern void fscache_cookie_init_once(void *);
52 extern void __fscache_cookie_put(struct fscache_cookie *);
57 extern struct fscache_cookie fscache_fsdef_index;
58 extern struct fscache_cookie_def fscache_fsdef_netfs_def;
63 #ifdef CONFIG_FSCACHE_HISTOGRAM
64 extern atomic_t fscache_obj_instantiate_histogram[HZ];
65 extern atomic_t fscache_objs_histogram[HZ];
66 extern atomic_t fscache_ops_histogram[HZ];
67 extern atomic_t fscache_retrieval_delay_histogram[HZ];
68 extern atomic_t fscache_retrieval_histogram[HZ];
70 static inline void fscache_hist(atomic_t histogram[], unsigned long start_jif)
72 unsigned long jif = jiffies - start_jif;
75 atomic_inc(&histogram[jif]);
78 extern const struct file_operations fscache_histogram_fops;
81 #define fscache_hist(hist, start_jif) do {} while (0)
87 extern unsigned fscache_defer_lookup;
88 extern unsigned fscache_defer_create;
89 extern unsigned fscache_debug;
90 extern struct kobject *fscache_root;
91 extern struct workqueue_struct *fscache_object_wq;
92 extern struct workqueue_struct *fscache_op_wq;
93 DECLARE_PER_CPU(wait_queue_head_t, fscache_object_cong_wait);
95 static inline bool fscache_object_congested(void)
97 return workqueue_congested(WORK_CPU_UNBOUND, fscache_object_wq);
100 extern int fscache_wait_atomic_t(atomic_t *);
105 extern void fscache_enqueue_object(struct fscache_object *);
110 #ifdef CONFIG_FSCACHE_OBJECT_LIST
111 extern const struct file_operations fscache_objlist_fops;
113 extern void fscache_objlist_add(struct fscache_object *);
114 extern void fscache_objlist_remove(struct fscache_object *);
116 #define fscache_objlist_add(object) do {} while(0)
117 #define fscache_objlist_remove(object) do {} while(0)
123 extern int fscache_submit_exclusive_op(struct fscache_object *,
124 struct fscache_operation *);
125 extern int fscache_submit_op(struct fscache_object *,
126 struct fscache_operation *);
127 extern int fscache_cancel_op(struct fscache_operation *,
128 void (*)(struct fscache_operation *),
130 extern void fscache_cancel_all_ops(struct fscache_object *);
131 extern void fscache_abort_object(struct fscache_object *);
132 extern void fscache_start_operations(struct fscache_object *);
133 extern void fscache_operation_gc(struct work_struct *);
138 extern int fscache_wait_for_deferred_lookup(struct fscache_cookie *);
139 extern int fscache_wait_for_operation_activation(struct fscache_object *,
140 struct fscache_operation *,
143 void (*)(struct fscache_operation *));
144 extern void fscache_invalidate_writes(struct fscache_cookie *);
149 #ifdef CONFIG_PROC_FS
150 extern int __init fscache_proc_init(void);
151 extern void fscache_proc_cleanup(void);
153 #define fscache_proc_init() (0)
154 #define fscache_proc_cleanup() do {} while (0)
160 #ifdef CONFIG_FSCACHE_STATS
161 extern atomic_t fscache_n_ops_processed[FSCACHE_MAX_THREADS];
162 extern atomic_t fscache_n_objs_processed[FSCACHE_MAX_THREADS];
164 extern atomic_t fscache_n_op_pend;
165 extern atomic_t fscache_n_op_run;
166 extern atomic_t fscache_n_op_enqueue;
167 extern atomic_t fscache_n_op_deferred_release;
168 extern atomic_t fscache_n_op_release;
169 extern atomic_t fscache_n_op_gc;
170 extern atomic_t fscache_n_op_cancelled;
171 extern atomic_t fscache_n_op_rejected;
173 extern atomic_t fscache_n_attr_changed;
174 extern atomic_t fscache_n_attr_changed_ok;
175 extern atomic_t fscache_n_attr_changed_nobufs;
176 extern atomic_t fscache_n_attr_changed_nomem;
177 extern atomic_t fscache_n_attr_changed_calls;
179 extern atomic_t fscache_n_allocs;
180 extern atomic_t fscache_n_allocs_ok;
181 extern atomic_t fscache_n_allocs_wait;
182 extern atomic_t fscache_n_allocs_nobufs;
183 extern atomic_t fscache_n_allocs_intr;
184 extern atomic_t fscache_n_allocs_object_dead;
185 extern atomic_t fscache_n_alloc_ops;
186 extern atomic_t fscache_n_alloc_op_waits;
188 extern atomic_t fscache_n_retrievals;
189 extern atomic_t fscache_n_retrievals_ok;
190 extern atomic_t fscache_n_retrievals_wait;
191 extern atomic_t fscache_n_retrievals_nodata;
192 extern atomic_t fscache_n_retrievals_nobufs;
193 extern atomic_t fscache_n_retrievals_intr;
194 extern atomic_t fscache_n_retrievals_nomem;
195 extern atomic_t fscache_n_retrievals_object_dead;
196 extern atomic_t fscache_n_retrieval_ops;
197 extern atomic_t fscache_n_retrieval_op_waits;
199 extern atomic_t fscache_n_stores;
200 extern atomic_t fscache_n_stores_ok;
201 extern atomic_t fscache_n_stores_again;
202 extern atomic_t fscache_n_stores_nobufs;
203 extern atomic_t fscache_n_stores_oom;
204 extern atomic_t fscache_n_store_ops;
205 extern atomic_t fscache_n_store_calls;
206 extern atomic_t fscache_n_store_pages;
207 extern atomic_t fscache_n_store_radix_deletes;
208 extern atomic_t fscache_n_store_pages_over_limit;
210 extern atomic_t fscache_n_store_vmscan_not_storing;
211 extern atomic_t fscache_n_store_vmscan_gone;
212 extern atomic_t fscache_n_store_vmscan_busy;
213 extern atomic_t fscache_n_store_vmscan_cancelled;
214 extern atomic_t fscache_n_store_vmscan_wait;
216 extern atomic_t fscache_n_marks;
217 extern atomic_t fscache_n_uncaches;
219 extern atomic_t fscache_n_acquires;
220 extern atomic_t fscache_n_acquires_null;
221 extern atomic_t fscache_n_acquires_no_cache;
222 extern atomic_t fscache_n_acquires_ok;
223 extern atomic_t fscache_n_acquires_nobufs;
224 extern atomic_t fscache_n_acquires_oom;
226 extern atomic_t fscache_n_invalidates;
227 extern atomic_t fscache_n_invalidates_run;
229 extern atomic_t fscache_n_updates;
230 extern atomic_t fscache_n_updates_null;
231 extern atomic_t fscache_n_updates_run;
233 extern atomic_t fscache_n_relinquishes;
234 extern atomic_t fscache_n_relinquishes_null;
235 extern atomic_t fscache_n_relinquishes_waitcrt;
236 extern atomic_t fscache_n_relinquishes_retire;
238 extern atomic_t fscache_n_cookie_index;
239 extern atomic_t fscache_n_cookie_data;
240 extern atomic_t fscache_n_cookie_special;
242 extern atomic_t fscache_n_object_alloc;
243 extern atomic_t fscache_n_object_no_alloc;
244 extern atomic_t fscache_n_object_lookups;
245 extern atomic_t fscache_n_object_lookups_negative;
246 extern atomic_t fscache_n_object_lookups_positive;
247 extern atomic_t fscache_n_object_lookups_timed_out;
248 extern atomic_t fscache_n_object_created;
249 extern atomic_t fscache_n_object_avail;
250 extern atomic_t fscache_n_object_dead;
252 extern atomic_t fscache_n_checkaux_none;
253 extern atomic_t fscache_n_checkaux_okay;
254 extern atomic_t fscache_n_checkaux_update;
255 extern atomic_t fscache_n_checkaux_obsolete;
257 extern atomic_t fscache_n_cop_alloc_object;
258 extern atomic_t fscache_n_cop_lookup_object;
259 extern atomic_t fscache_n_cop_lookup_complete;
260 extern atomic_t fscache_n_cop_grab_object;
261 extern atomic_t fscache_n_cop_invalidate_object;
262 extern atomic_t fscache_n_cop_update_object;
263 extern atomic_t fscache_n_cop_drop_object;
264 extern atomic_t fscache_n_cop_put_object;
265 extern atomic_t fscache_n_cop_sync_cache;
266 extern atomic_t fscache_n_cop_attr_changed;
267 extern atomic_t fscache_n_cop_read_or_alloc_page;
268 extern atomic_t fscache_n_cop_read_or_alloc_pages;
269 extern atomic_t fscache_n_cop_allocate_page;
270 extern atomic_t fscache_n_cop_allocate_pages;
271 extern atomic_t fscache_n_cop_write_page;
272 extern atomic_t fscache_n_cop_uncache_page;
273 extern atomic_t fscache_n_cop_dissociate_pages;
275 extern atomic_t fscache_n_cache_no_space_reject;
276 extern atomic_t fscache_n_cache_stale_objects;
277 extern atomic_t fscache_n_cache_retired_objects;
278 extern atomic_t fscache_n_cache_culled_objects;
280 static inline void fscache_stat(atomic_t *stat)
285 static inline void fscache_stat_d(atomic_t *stat)
290 #define __fscache_stat(stat) (stat)
292 extern const struct file_operations fscache_stats_fops;
295 #define __fscache_stat(stat) (NULL)
296 #define fscache_stat(stat) do {} while (0)
297 #define fscache_stat_d(stat) do {} while (0)
301 * raise an event on an object
302 * - if the event is not masked for that object, then the object is
303 * queued for attention by the thread pool.
305 static inline void fscache_raise_event(struct fscache_object *object,
308 BUG_ON(event >= NR_FSCACHE_OBJECT_EVENTS);
310 printk("*** fscache_raise_event(OBJ%d{%lx},%x)\n",
311 object->debug_id, object->event_mask, (1 << event));
313 if (!test_and_set_bit(event, &object->events) &&
314 test_bit(event, &object->event_mask))
315 fscache_enqueue_object(object);
319 * drop a reference to a cookie
321 static inline void fscache_cookie_put(struct fscache_cookie *cookie)
323 BUG_ON(atomic_read(&cookie->usage) <= 0);
324 if (atomic_dec_and_test(&cookie->usage))
325 __fscache_cookie_put(cookie);
329 * get an extra reference to a netfs retrieval context
332 void *fscache_get_context(struct fscache_cookie *cookie, void *context)
334 if (cookie->def->get_context)
335 cookie->def->get_context(cookie->netfs_data, context);
340 * release a reference to a netfs retrieval context
343 void fscache_put_context(struct fscache_cookie *cookie, void *context)
345 if (cookie->def->put_context)
346 cookie->def->put_context(cookie->netfs_data, context);
349 /*****************************************************************************/
353 #define dbgprintk(FMT, ...) \
354 printk(KERN_DEBUG "[%-6.6s] "FMT"\n", current->comm, ##__VA_ARGS__)
356 #define kenter(FMT, ...) dbgprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
357 #define kleave(FMT, ...) dbgprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
358 #define kdebug(FMT, ...) dbgprintk(FMT, ##__VA_ARGS__)
360 #define kjournal(FMT, ...) no_printk(FMT, ##__VA_ARGS__)
363 #define _enter(FMT, ...) kenter(FMT, ##__VA_ARGS__)
364 #define _leave(FMT, ...) kleave(FMT, ##__VA_ARGS__)
365 #define _debug(FMT, ...) kdebug(FMT, ##__VA_ARGS__)
367 #elif defined(CONFIG_FSCACHE_DEBUG)
368 #define _enter(FMT, ...) \
370 if (__do_kdebug(ENTER)) \
371 kenter(FMT, ##__VA_ARGS__); \
374 #define _leave(FMT, ...) \
376 if (__do_kdebug(LEAVE)) \
377 kleave(FMT, ##__VA_ARGS__); \
380 #define _debug(FMT, ...) \
382 if (__do_kdebug(DEBUG)) \
383 kdebug(FMT, ##__VA_ARGS__); \
387 #define _enter(FMT, ...) no_printk("==> %s("FMT")", __func__, ##__VA_ARGS__)
388 #define _leave(FMT, ...) no_printk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
389 #define _debug(FMT, ...) no_printk(FMT, ##__VA_ARGS__)
393 * determine whether a particular optional debugging point should be logged
394 * - we need to go through three steps to persuade cpp to correctly join the
395 * shorthand in FSCACHE_DEBUG_LEVEL with its prefix
397 #define ____do_kdebug(LEVEL, POINT) \
398 unlikely((fscache_debug & \
399 (FSCACHE_POINT_##POINT << (FSCACHE_DEBUG_ ## LEVEL * 3))))
400 #define ___do_kdebug(LEVEL, POINT) \
401 ____do_kdebug(LEVEL, POINT)
402 #define __do_kdebug(POINT) \
403 ___do_kdebug(FSCACHE_DEBUG_LEVEL, POINT)
405 #define FSCACHE_DEBUG_CACHE 0
406 #define FSCACHE_DEBUG_COOKIE 1
407 #define FSCACHE_DEBUG_PAGE 2
408 #define FSCACHE_DEBUG_OPERATION 3
410 #define FSCACHE_POINT_ENTER 1
411 #define FSCACHE_POINT_LEAVE 2
412 #define FSCACHE_POINT_DEBUG 4
414 #ifndef FSCACHE_DEBUG_LEVEL
415 #define FSCACHE_DEBUG_LEVEL CACHE
421 #if 1 /* defined(__KDEBUGALL) */
425 if (unlikely(!(X))) { \
427 pr_err("Assertion failed\n"); \
432 #define ASSERTCMP(X, OP, Y) \
434 if (unlikely(!((X) OP (Y)))) { \
436 pr_err("Assertion failed\n"); \
437 pr_err("%lx " #OP " %lx is false\n", \
438 (unsigned long)(X), (unsigned long)(Y)); \
443 #define ASSERTIF(C, X) \
445 if (unlikely((C) && !(X))) { \
447 pr_err("Assertion failed\n"); \
452 #define ASSERTIFCMP(C, X, OP, Y) \
454 if (unlikely((C) && !((X) OP (Y)))) { \
456 pr_err("Assertion failed\n"); \
457 pr_err("%lx " #OP " %lx is false\n", \
458 (unsigned long)(X), (unsigned long)(Y)); \
465 #define ASSERT(X) do {} while (0)
466 #define ASSERTCMP(X, OP, Y) do {} while (0)
467 #define ASSERTIF(C, X) do {} while (0)
468 #define ASSERTIFCMP(C, X, OP, Y) do {} while (0)
470 #endif /* assert or not */