[deliverable/linux.git] / fs / fscache / internal.h

/* Internal definitions for FS-Cache
 *
 * Copyright (C) 2004-2007 Red Hat, Inc. All Rights Reserved.
 * Written by David Howells (dhowells@redhat.com)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version
 * 2 of the License, or (at your option) any later version.
 */

/*
 * Lock order, in the order in which multiple locks should be obtained:
 * - fscache_addremove_sem
 * - cookie->lock
 * - cookie->parent->lock
 * - cache->object_list_lock
 * - object->lock
 * - object->parent->lock
 * - cookie->stores_lock
 * - fscache_thread_lock
 *
 */

#include <linux/fscache-cache.h>
#include <linux/sched.h>

#define FSCACHE_MIN_THREADS	4
#define FSCACHE_MAX_THREADS	32

/*
 * cache.c
 */
extern struct list_head fscache_cache_list;
extern struct rw_semaphore fscache_addremove_sem;

extern struct fscache_cache *fscache_select_cache_for_object(
	struct fscache_cookie *);

/*
 * cookie.c
 */
extern struct kmem_cache *fscache_cookie_jar;

extern void fscache_cookie_init_once(void *);
extern void __fscache_cookie_put(struct fscache_cookie *);

/*
 * fsdef.c
 */
extern struct fscache_cookie fscache_fsdef_index;
extern struct fscache_cookie_def fscache_fsdef_netfs_def;

/*
 * histogram.c
 */
#ifdef CONFIG_FSCACHE_HISTOGRAM
extern atomic_t fscache_obj_instantiate_histogram[HZ];
extern atomic_t fscache_objs_histogram[HZ];
extern atomic_t fscache_ops_histogram[HZ];
extern atomic_t fscache_retrieval_delay_histogram[HZ];
extern atomic_t fscache_retrieval_histogram[HZ];

static inline void fscache_hist(atomic_t histogram[], unsigned long start_jif)
{
	unsigned long jif = jiffies - start_jif;
	if (jif >= HZ)
		jif = HZ - 1;
	atomic_inc(&histogram[jif]);
}

extern const struct file_operations fscache_histogram_fops;

#else
#define fscache_hist(hist, start_jif) do {} while (0)
#endif

/*
 * main.c
 */
extern unsigned fscache_defer_lookup;
extern unsigned fscache_defer_create;
extern unsigned fscache_debug;
extern struct kobject *fscache_root;
extern struct workqueue_struct *fscache_object_wq;
extern struct workqueue_struct *fscache_op_wq;
DECLARE_PER_CPU(wait_queue_head_t, fscache_object_cong_wait);

static inline bool fscache_object_congested(void)
{
	return workqueue_congested(WORK_CPU_UNBOUND, fscache_object_wq);
}

extern int fscache_wait_bit(void *);
extern int fscache_wait_bit_interruptible(void *);

/*
 * object.c
 */
extern const char fscache_object_states_short[FSCACHE_OBJECT__NSTATES][5];

extern void fscache_withdrawing_object(struct fscache_cache *,
				       struct fscache_object *);
extern void fscache_enqueue_object(struct fscache_object *);

/*
 * object-list.c
 */
#ifdef CONFIG_FSCACHE_OBJECT_LIST
extern const struct file_operations fscache_objlist_fops;

extern void fscache_objlist_add(struct fscache_object *);
#else
#define fscache_objlist_add(object) do {} while(0)
#endif

/*
 * operation.c
 */
extern int fscache_submit_exclusive_op(struct fscache_object *,
				       struct fscache_operation *);
extern int fscache_submit_op(struct fscache_object *,
			     struct fscache_operation *);
extern int fscache_cancel_op(struct fscache_operation *);
extern void fscache_cancel_all_ops(struct fscache_object *);
extern void fscache_abort_object(struct fscache_object *);
extern void fscache_start_operations(struct fscache_object *);
extern void fscache_operation_gc(struct work_struct *);

/*
 * page.c
 */
extern void fscache_invalidate_writes(struct fscache_cookie *);

/*
 * proc.c
 */
#ifdef CONFIG_PROC_FS
extern int __init fscache_proc_init(void);
extern void fscache_proc_cleanup(void);
#else
#define fscache_proc_init()	(0)
#define fscache_proc_cleanup()	do {} while (0)
#endif

/*
 * stats.c
 */
#ifdef CONFIG_FSCACHE_STATS
extern atomic_t fscache_n_ops_processed[FSCACHE_MAX_THREADS];
extern atomic_t fscache_n_objs_processed[FSCACHE_MAX_THREADS];

extern atomic_t fscache_n_op_pend;
extern atomic_t fscache_n_op_run;
extern atomic_t fscache_n_op_enqueue;
extern atomic_t fscache_n_op_deferred_release;
extern atomic_t fscache_n_op_release;
extern atomic_t fscache_n_op_gc;
extern atomic_t fscache_n_op_cancelled;
extern atomic_t fscache_n_op_rejected;

extern atomic_t fscache_n_attr_changed;
extern atomic_t fscache_n_attr_changed_ok;
extern atomic_t fscache_n_attr_changed_nobufs;
extern atomic_t fscache_n_attr_changed_nomem;
extern atomic_t fscache_n_attr_changed_calls;

extern atomic_t fscache_n_allocs;
extern atomic_t fscache_n_allocs_ok;
extern atomic_t fscache_n_allocs_wait;
extern atomic_t fscache_n_allocs_nobufs;
extern atomic_t fscache_n_allocs_intr;
extern atomic_t fscache_n_allocs_object_dead;
extern atomic_t fscache_n_alloc_ops;
extern atomic_t fscache_n_alloc_op_waits;

extern atomic_t fscache_n_retrievals;
extern atomic_t fscache_n_retrievals_ok;
extern atomic_t fscache_n_retrievals_wait;
extern atomic_t fscache_n_retrievals_nodata;
extern atomic_t fscache_n_retrievals_nobufs;
extern atomic_t fscache_n_retrievals_intr;
extern atomic_t fscache_n_retrievals_nomem;
extern atomic_t fscache_n_retrievals_object_dead;
extern atomic_t fscache_n_retrieval_ops;
extern atomic_t fscache_n_retrieval_op_waits;

extern atomic_t fscache_n_stores;
extern atomic_t fscache_n_stores_ok;
extern atomic_t fscache_n_stores_again;
extern atomic_t fscache_n_stores_nobufs;
extern atomic_t fscache_n_stores_oom;
extern atomic_t fscache_n_store_ops;
extern atomic_t fscache_n_store_calls;
extern atomic_t fscache_n_store_pages;
extern atomic_t fscache_n_store_radix_deletes;
extern atomic_t fscache_n_store_pages_over_limit;

extern atomic_t fscache_n_store_vmscan_not_storing;
extern atomic_t fscache_n_store_vmscan_gone;
extern atomic_t fscache_n_store_vmscan_busy;
extern atomic_t fscache_n_store_vmscan_cancelled;

extern atomic_t fscache_n_marks;
extern atomic_t fscache_n_uncaches;

extern atomic_t fscache_n_acquires;
extern atomic_t fscache_n_acquires_null;
extern atomic_t fscache_n_acquires_no_cache;
extern atomic_t fscache_n_acquires_ok;
extern atomic_t fscache_n_acquires_nobufs;
extern atomic_t fscache_n_acquires_oom;

extern atomic_t fscache_n_invalidates;
extern atomic_t fscache_n_invalidates_run;

extern atomic_t fscache_n_updates;
extern atomic_t fscache_n_updates_null;
extern atomic_t fscache_n_updates_run;

extern atomic_t fscache_n_relinquishes;
extern atomic_t fscache_n_relinquishes_null;
extern atomic_t fscache_n_relinquishes_waitcrt;
extern atomic_t fscache_n_relinquishes_retire;

extern atomic_t fscache_n_cookie_index;
extern atomic_t fscache_n_cookie_data;
extern atomic_t fscache_n_cookie_special;

extern atomic_t fscache_n_object_alloc;
extern atomic_t fscache_n_object_no_alloc;
extern atomic_t fscache_n_object_lookups;
extern atomic_t fscache_n_object_lookups_negative;
extern atomic_t fscache_n_object_lookups_positive;
extern atomic_t fscache_n_object_lookups_timed_out;
extern atomic_t fscache_n_object_created;
extern atomic_t fscache_n_object_avail;
extern atomic_t fscache_n_object_dead;

extern atomic_t fscache_n_checkaux_none;
extern atomic_t fscache_n_checkaux_okay;
extern atomic_t fscache_n_checkaux_update;
extern atomic_t fscache_n_checkaux_obsolete;

extern atomic_t fscache_n_cop_alloc_object;
extern atomic_t fscache_n_cop_lookup_object;
extern atomic_t fscache_n_cop_lookup_complete;
extern atomic_t fscache_n_cop_grab_object;
extern atomic_t fscache_n_cop_invalidate_object;
extern atomic_t fscache_n_cop_update_object;
extern atomic_t fscache_n_cop_drop_object;
extern atomic_t fscache_n_cop_put_object;
extern atomic_t fscache_n_cop_sync_cache;
extern atomic_t fscache_n_cop_attr_changed;
extern atomic_t fscache_n_cop_read_or_alloc_page;
extern atomic_t fscache_n_cop_read_or_alloc_pages;
extern atomic_t fscache_n_cop_allocate_page;
extern atomic_t fscache_n_cop_allocate_pages;
extern atomic_t fscache_n_cop_write_page;
extern atomic_t fscache_n_cop_uncache_page;
extern atomic_t fscache_n_cop_dissociate_pages;

static inline void fscache_stat(atomic_t *stat)
{
	atomic_inc(stat);
}

static inline void fscache_stat_d(atomic_t *stat)
{
	atomic_dec(stat);
}

#define __fscache_stat(stat) (stat)

extern const struct file_operations fscache_stats_fops;
#else

#define __fscache_stat(stat) (NULL)
#define fscache_stat(stat) do {} while (0)
#define fscache_stat_d(stat) do {} while (0)
#endif

/*
 * raise an event on an object
 * - if the event is not masked for that object, then the object is
 *   queued for attention by the thread pool.
 */
static inline void fscache_raise_event(struct fscache_object *object,
				       unsigned event)
{
	if (!test_and_set_bit(event, &object->events) &&
	    test_bit(event, &object->event_mask))
		fscache_enqueue_object(object);
}

/*
 * drop a reference to a cookie
 */
static inline void fscache_cookie_put(struct fscache_cookie *cookie)
{
	BUG_ON(atomic_read(&cookie->usage) <= 0);
	if (atomic_dec_and_test(&cookie->usage))
		__fscache_cookie_put(cookie);
}

/*
 * get an extra reference to a netfs retrieval context
 */
static inline
void *fscache_get_context(struct fscache_cookie *cookie, void *context)
{
	if (cookie->def->get_context)
		cookie->def->get_context(cookie->netfs_data, context);
	return context;
}

/*
 * release a reference to a netfs retrieval context
 */
static inline
void fscache_put_context(struct fscache_cookie *cookie, void *context)
{
	if (cookie->def->put_context)
		cookie->def->put_context(cookie->netfs_data, context);
}

/*****************************************************************************/
/*
 * debug tracing
 */
#define dbgprintk(FMT, ...) \
	printk(KERN_DEBUG "[%-6.6s] "FMT"\n", current->comm, ##__VA_ARGS__)

#define kenter(FMT, ...) dbgprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
#define kleave(FMT, ...) dbgprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
#define kdebug(FMT, ...) dbgprintk(FMT, ##__VA_ARGS__)

#define kjournal(FMT, ...) no_printk(FMT, ##__VA_ARGS__)

#ifdef __KDEBUG
#define _enter(FMT, ...) kenter(FMT, ##__VA_ARGS__)
#define _leave(FMT, ...) kleave(FMT, ##__VA_ARGS__)
#define _debug(FMT, ...) kdebug(FMT, ##__VA_ARGS__)

#elif defined(CONFIG_FSCACHE_DEBUG)
#define _enter(FMT, ...)			\
do {						\
	if (__do_kdebug(ENTER))			\
		kenter(FMT, ##__VA_ARGS__);	\
} while (0)

#define _leave(FMT, ...)			\
do {						\
	if (__do_kdebug(LEAVE))			\
		kleave(FMT, ##__VA_ARGS__);	\
} while (0)

#define _debug(FMT, ...)			\
do {						\
	if (__do_kdebug(DEBUG))			\
		kdebug(FMT, ##__VA_ARGS__);	\
} while (0)

#else
#define _enter(FMT, ...) no_printk("==> %s("FMT")", __func__, ##__VA_ARGS__)
#define _leave(FMT, ...) no_printk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
#define _debug(FMT, ...) no_printk(FMT, ##__VA_ARGS__)
#endif

/*
 * determine whether a particular optional debugging point should be logged
 * - we need to go through three steps to persuade cpp to correctly join the
 *   shorthand in FSCACHE_DEBUG_LEVEL with its prefix
 */
#define ____do_kdebug(LEVEL, POINT) \
	unlikely((fscache_debug & \
		  (FSCACHE_POINT_##POINT << (FSCACHE_DEBUG_ ## LEVEL * 3))))
#define ___do_kdebug(LEVEL, POINT) \
	____do_kdebug(LEVEL, POINT)
#define __do_kdebug(POINT) \
	___do_kdebug(FSCACHE_DEBUG_LEVEL, POINT)

#define FSCACHE_DEBUG_CACHE	0
#define FSCACHE_DEBUG_COOKIE	1
#define FSCACHE_DEBUG_PAGE	2
#define FSCACHE_DEBUG_OPERATION	3

#define FSCACHE_POINT_ENTER	1
#define FSCACHE_POINT_LEAVE	2
#define FSCACHE_POINT_DEBUG	4

#ifndef FSCACHE_DEBUG_LEVEL
#define FSCACHE_DEBUG_LEVEL CACHE
#endif

/*
 * assertions
 */
#if 1 /* defined(__KDEBUGALL) */

#define ASSERT(X)							\
do {									\
	if (unlikely(!(X))) {						\
		printk(KERN_ERR "\n");					\
		printk(KERN_ERR "FS-Cache: Assertion failed\n");	\
		BUG();							\
	}								\
} while (0)

#define ASSERTCMP(X, OP, Y)						\
do {									\
	if (unlikely(!((X) OP (Y)))) {					\
		printk(KERN_ERR "\n");					\
		printk(KERN_ERR "FS-Cache: Assertion failed\n");	\
		printk(KERN_ERR "%lx " #OP " %lx is false\n",		\
		       (unsigned long)(X), (unsigned long)(Y));		\
		BUG();							\
	}								\
} while (0)

#define ASSERTIF(C, X)							\
do {									\
	if (unlikely((C) && !(X))) {					\
		printk(KERN_ERR "\n");					\
		printk(KERN_ERR "FS-Cache: Assertion failed\n");	\
		BUG();							\
	}								\
} while (0)

#define ASSERTIFCMP(C, X, OP, Y)					\
do {									\
	if (unlikely((C) && !((X) OP (Y)))) {				\
		printk(KERN_ERR "\n");					\
		printk(KERN_ERR "FS-Cache: Assertion failed\n");	\
		printk(KERN_ERR "%lx " #OP " %lx is false\n",		\
		       (unsigned long)(X), (unsigned long)(Y));		\
		BUG();							\
	}								\
} while (0)

#else

#define ASSERT(X)			do {} while (0)
#define ASSERTCMP(X, OP, Y)		do {} while (0)
#define ASSERTIF(C, X)			do {} while (0)
#define ASSERTIFCMP(C, X, OP, Y)	do {} while (0)

#endif /* assert or not */
Commit	Line	Data
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
1bccf513	20	* - cookie->stores_lock
06b3db1b DH	21	* - fscache_thread_lock
	22	*
	23	*/
	24
	25	#include <linux/fscache-cache.h>
	26	#include <linux/sched.h>
	27
	28	#define FSCACHE_MIN_THREADS 4
	29	#define FSCACHE_MAX_THREADS 32
	30
0e04d4ce	31	/*
348ca102	32	* cache.c
0e04d4ce DH	33	*/
	34	extern struct list_head fscache_cache_list;
	35	extern struct rw_semaphore fscache_addremove_sem;
	36
	37	extern struct fscache_cache *fscache_select_cache_for_object(
	38	struct fscache_cookie *);
	39
955d0091	40	/*
348ca102	41	* cookie.c
955d0091 DH	42	*/
	43	extern struct kmem_cache *fscache_cookie_jar;
	44
	45	extern void fscache_cookie_init_once(void *);
	46	extern void __fscache_cookie_put(struct fscache_cookie *);
	47
a6891645	48	/*
348ca102	49	* fsdef.c
a6891645 DH	50	*/
	51	extern struct fscache_cookie fscache_fsdef_index;
	52	extern struct fscache_cookie_def fscache_fsdef_netfs_def;
	53
7394daa8	54	/*
348ca102	55	* histogram.c
7394daa8 DH	56	*/
	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];
	63
	64	static inline void fscache_hist(atomic_t histogram[], unsigned long start_jif)
	65	{
	66	unsigned long jif = jiffies - start_jif;
	67	if (jif >= HZ)
	68	jif = HZ - 1;
	69	atomic_inc(&histogram[jif]);
	70	}
	71
	72	extern const struct file_operations fscache_histogram_fops;
	73
	74	#else
	75	#define fscache_hist(hist, start_jif) do {} while (0)
	76	#endif
	77
06b3db1b	78	/*
348ca102	79	* main.c
06b3db1b DH	80	*/
	81	extern unsigned fscache_defer_lookup;
	82	extern unsigned fscache_defer_create;
	83	extern unsigned fscache_debug;
	84	extern struct kobject *fscache_root;
8b8edefa	85	extern struct workqueue_struct *fscache_object_wq;
8af7c124	86	extern struct workqueue_struct *fscache_op_wq;
8b8edefa TH	87	DECLARE_PER_CPU(wait_queue_head_t, fscache_object_cong_wait);
	88
	89	static inline bool fscache_object_congested(void)
	90	{
	91	return workqueue_congested(WORK_CPU_UNBOUND, fscache_object_wq);
	92	}
06b3db1b	93
2868cbea DH	94	extern int fscache_wait_bit(void *);
	95	extern int fscache_wait_bit_interruptible(void *);
	96
36c95590	97	/*
348ca102	98	* object.c
36c95590	99	*/
4fbf4291 DH	100	extern const char fscache_object_states_short[FSCACHE_OBJECT__NSTATES][5];
4fbf4291 DH	101
36c95590 DH	102	extern void fscache_withdrawing_object(struct fscache_cache *,
	103	struct fscache_object *);
	104	extern void fscache_enqueue_object(struct fscache_object *);
	105
4fbf4291 DH	106	/*
	107	* object-list.c
	108	*/
	109	#ifdef CONFIG_FSCACHE_OBJECT_LIST
	110	extern const struct file_operations fscache_objlist_fops;
	111
	112	extern void fscache_objlist_add(struct fscache_object *);
	113	#else
	114	#define fscache_objlist_add(object) do {} while(0)
	115	#endif
	116
36c95590	117	/*
348ca102	118	* operation.c
36c95590	119	*/
952efe7b DH	120	extern int fscache_submit_exclusive_op(struct fscache_object *,
	121	struct fscache_operation *);
	122	extern int fscache_submit_op(struct fscache_object *,
	123	struct fscache_operation *);
5753c441	124	extern int fscache_cancel_op(struct fscache_operation *);
ef778e7a	125	extern void fscache_cancel_all_ops(struct fscache_object *);
952efe7b DH	126	extern void fscache_abort_object(struct fscache_object *);
	127	extern void fscache_start_operations(struct fscache_object *);
	128	extern void fscache_operation_gc(struct work_struct *);
36c95590	129
ef778e7a DH	130	/*
	131	* page.c
	132	*/
	133	extern void fscache_invalidate_writes(struct fscache_cookie *);
	134
7394daa8	135	/*
348ca102	136	* proc.c
7394daa8 DH	137	*/
	138	#ifdef CONFIG_PROC_FS
	139	extern int __init fscache_proc_init(void);
	140	extern void fscache_proc_cleanup(void);
	141	#else
	142	#define fscache_proc_init() (0)
	143	#define fscache_proc_cleanup() do {} while (0)
	144	#endif
	145
	146	/*
348ca102	147	* stats.c
7394daa8 DH	148	*/
	149	#ifdef CONFIG_FSCACHE_STATS
	150	extern atomic_t fscache_n_ops_processed[FSCACHE_MAX_THREADS];
	151	extern atomic_t fscache_n_objs_processed[FSCACHE_MAX_THREADS];
	152
	153	extern atomic_t fscache_n_op_pend;
	154	extern atomic_t fscache_n_op_run;
	155	extern atomic_t fscache_n_op_enqueue;
	156	extern atomic_t fscache_n_op_deferred_release;
	157	extern atomic_t fscache_n_op_release;
	158	extern atomic_t fscache_n_op_gc;
5753c441	159	extern atomic_t fscache_n_op_cancelled;
e3d4d28b	160	extern atomic_t fscache_n_op_rejected;
7394daa8 DH	161
	162	extern atomic_t fscache_n_attr_changed;
	163	extern atomic_t fscache_n_attr_changed_ok;
	164	extern atomic_t fscache_n_attr_changed_nobufs;
	165	extern atomic_t fscache_n_attr_changed_nomem;
	166	extern atomic_t fscache_n_attr_changed_calls;
	167
	168	extern atomic_t fscache_n_allocs;
	169	extern atomic_t fscache_n_allocs_ok;
	170	extern atomic_t fscache_n_allocs_wait;
	171	extern atomic_t fscache_n_allocs_nobufs;
5753c441	172	extern atomic_t fscache_n_allocs_intr;
60d543ca	173	extern atomic_t fscache_n_allocs_object_dead;
7394daa8 DH	174	extern atomic_t fscache_n_alloc_ops;
	175	extern atomic_t fscache_n_alloc_op_waits;
	176
	177	extern atomic_t fscache_n_retrievals;
	178	extern atomic_t fscache_n_retrievals_ok;
	179	extern atomic_t fscache_n_retrievals_wait;
	180	extern atomic_t fscache_n_retrievals_nodata;
	181	extern atomic_t fscache_n_retrievals_nobufs;
	182	extern atomic_t fscache_n_retrievals_intr;
	183	extern atomic_t fscache_n_retrievals_nomem;
60d543ca	184	extern atomic_t fscache_n_retrievals_object_dead;
7394daa8 DH	185	extern atomic_t fscache_n_retrieval_ops;
	186	extern atomic_t fscache_n_retrieval_op_waits;
	187
	188	extern atomic_t fscache_n_stores;
	189	extern atomic_t fscache_n_stores_ok;
	190	extern atomic_t fscache_n_stores_again;
	191	extern atomic_t fscache_n_stores_nobufs;
	192	extern atomic_t fscache_n_stores_oom;
	193	extern atomic_t fscache_n_store_ops;
	194	extern atomic_t fscache_n_store_calls;
1bccf513 DH	195	extern atomic_t fscache_n_store_pages;
	196	extern atomic_t fscache_n_store_radix_deletes;
	197	extern atomic_t fscache_n_store_pages_over_limit;
7394daa8	198
201a1542 DH	199	extern atomic_t fscache_n_store_vmscan_not_storing;
	200	extern atomic_t fscache_n_store_vmscan_gone;
	201	extern atomic_t fscache_n_store_vmscan_busy;
	202	extern atomic_t fscache_n_store_vmscan_cancelled;
	203
7394daa8 DH	204	extern atomic_t fscache_n_marks;
	205	extern atomic_t fscache_n_uncaches;
	206
	207	extern atomic_t fscache_n_acquires;
	208	extern atomic_t fscache_n_acquires_null;
	209	extern atomic_t fscache_n_acquires_no_cache;
	210	extern atomic_t fscache_n_acquires_ok;
	211	extern atomic_t fscache_n_acquires_nobufs;
	212	extern atomic_t fscache_n_acquires_oom;
	213
ef778e7a DH	214	extern atomic_t fscache_n_invalidates;
	215	extern atomic_t fscache_n_invalidates_run;
	216
7394daa8 DH	217	extern atomic_t fscache_n_updates;
	218	extern atomic_t fscache_n_updates_null;
	219	extern atomic_t fscache_n_updates_run;
	220
	221	extern atomic_t fscache_n_relinquishes;
	222	extern atomic_t fscache_n_relinquishes_null;
	223	extern atomic_t fscache_n_relinquishes_waitcrt;
2175bb06	224	extern atomic_t fscache_n_relinquishes_retire;
7394daa8 DH	225
	226	extern atomic_t fscache_n_cookie_index;
	227	extern atomic_t fscache_n_cookie_data;
	228	extern atomic_t fscache_n_cookie_special;
	229
	230	extern atomic_t fscache_n_object_alloc;
	231	extern atomic_t fscache_n_object_no_alloc;
	232	extern atomic_t fscache_n_object_lookups;
	233	extern atomic_t fscache_n_object_lookups_negative;
	234	extern atomic_t fscache_n_object_lookups_positive;
fee096de	235	extern atomic_t fscache_n_object_lookups_timed_out;
7394daa8 DH	236	extern atomic_t fscache_n_object_created;
	237	extern atomic_t fscache_n_object_avail;
	238	extern atomic_t fscache_n_object_dead;
	239
	240	extern atomic_t fscache_n_checkaux_none;
	241	extern atomic_t fscache_n_checkaux_okay;
	242	extern atomic_t fscache_n_checkaux_update;
	243	extern atomic_t fscache_n_checkaux_obsolete;
	244
52bd75fd DH	245	extern atomic_t fscache_n_cop_alloc_object;
	246	extern atomic_t fscache_n_cop_lookup_object;
	247	extern atomic_t fscache_n_cop_lookup_complete;
	248	extern atomic_t fscache_n_cop_grab_object;
ef778e7a	249	extern atomic_t fscache_n_cop_invalidate_object;
52bd75fd DH	250	extern atomic_t fscache_n_cop_update_object;
	251	extern atomic_t fscache_n_cop_drop_object;
	252	extern atomic_t fscache_n_cop_put_object;
	253	extern atomic_t fscache_n_cop_sync_cache;
	254	extern atomic_t fscache_n_cop_attr_changed;
	255	extern atomic_t fscache_n_cop_read_or_alloc_page;
	256	extern atomic_t fscache_n_cop_read_or_alloc_pages;
	257	extern atomic_t fscache_n_cop_allocate_page;
	258	extern atomic_t fscache_n_cop_allocate_pages;
	259	extern atomic_t fscache_n_cop_write_page;
	260	extern atomic_t fscache_n_cop_uncache_page;
	261	extern atomic_t fscache_n_cop_dissociate_pages;
	262
7394daa8 DH	263	static inline void fscache_stat(atomic_t *stat)
	264	{
	265	atomic_inc(stat);
	266	}
	267
52bd75fd DH	268	static inline void fscache_stat_d(atomic_t *stat)
	269	{
	270	atomic_dec(stat);
	271	}
	272
60d543ca DH	273	#define __fscache_stat(stat) (stat)
60d543ca DH	274
7394daa8 DH	275	extern const struct file_operations fscache_stats_fops;
	276	#else
	277
60d543ca	278	#define __fscache_stat(stat) (NULL)
7394daa8	279	#define fscache_stat(stat) do {} while (0)
4fa9f4ed	280	#define fscache_stat_d(stat) do {} while (0)
7394daa8 DH	281	#endif
7394daa8 DH	282
0e04d4ce DH	283	/*
	284	* raise an event on an object
	285	* - if the event is not masked for that object, then the object is
	286	* queued for attention by the thread pool.
	287	*/
	288	static inline void fscache_raise_event(struct fscache_object *object,
	289	unsigned event)
	290	{
36c95590 DH	291	if (!test_and_set_bit(event, &object->events) &&
	292	test_bit(event, &object->event_mask))
	293	fscache_enqueue_object(object);
	294	}
	295
	296	/*
	297	* drop a reference to a cookie
	298	*/
	299	static inline void fscache_cookie_put(struct fscache_cookie *cookie)
	300	{
	301	BUG_ON(atomic_read(&cookie->usage) <= 0);
	302	if (atomic_dec_and_test(&cookie->usage))
	303	__fscache_cookie_put(cookie);
0e04d4ce DH	304	}
0e04d4ce DH	305
b5108822 DH	306	/*
	307	* get an extra reference to a netfs retrieval context
	308	*/
	309	static inline
	310	void fscache_get_context(struct fscache_cookie cookie, void *context)
	311	{
	312	if (cookie->def->get_context)
	313	cookie->def->get_context(cookie->netfs_data, context);
	314	return context;
	315	}
	316
	317	/*
	318	* release a reference to a netfs retrieval context
	319	*/
	320	static inline
	321	void fscache_put_context(struct fscache_cookie cookie, void context)
	322	{
	323	if (cookie->def->put_context)
	324	cookie->def->put_context(cookie->netfs_data, context);
	325	}
	326
06b3db1b DH	327	/*****************************************************************************/
	328	/*
	329	* debug tracing
	330	*/
	331	#define dbgprintk(FMT, ...) \
	332	printk(KERN_DEBUG "[%-6.6s] "FMT"\n", current->comm, ##__VA_ARGS__)
	333
06b3db1b DH	334	#define kenter(FMT, ...) dbgprintk("==> %s("FMT")", __func__, ##__VA_ARGS__)
	335	#define kleave(FMT, ...) dbgprintk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
	336	#define kdebug(FMT, ...) dbgprintk(FMT, ##__VA_ARGS__)
	337
12fdff3f	338	#define kjournal(FMT, ...) no_printk(FMT, ##__VA_ARGS__)
06b3db1b DH	339
	340	#ifdef __KDEBUG
	341	#define _enter(FMT, ...) kenter(FMT, ##__VA_ARGS__)
	342	#define _leave(FMT, ...) kleave(FMT, ##__VA_ARGS__)
	343	#define _debug(FMT, ...) kdebug(FMT, ##__VA_ARGS__)
	344
	345	#elif defined(CONFIG_FSCACHE_DEBUG)
	346	#define _enter(FMT, ...) \
	347	do { \
	348	if (__do_kdebug(ENTER)) \
	349	kenter(FMT, ##__VA_ARGS__); \
	350	} while (0)
	351
	352	#define _leave(FMT, ...) \
	353	do { \
	354	if (__do_kdebug(LEAVE)) \
	355	kleave(FMT, ##__VA_ARGS__); \
	356	} while (0)
	357
	358	#define _debug(FMT, ...) \
	359	do { \
	360	if (__do_kdebug(DEBUG)) \
	361	kdebug(FMT, ##__VA_ARGS__); \
	362	} while (0)
	363
	364	#else
12fdff3f DH	365	#define _enter(FMT, ...) no_printk("==> %s("FMT")", __func__, ##__VA_ARGS__)
	366	#define _leave(FMT, ...) no_printk("<== %s()"FMT"", __func__, ##__VA_ARGS__)
	367	#define _debug(FMT, ...) no_printk(FMT, ##__VA_ARGS__)
06b3db1b DH	368	#endif
	369
	370	/*
	371	* determine whether a particular optional debugging point should be logged
	372	* - we need to go through three steps to persuade cpp to correctly join the
	373	* shorthand in FSCACHE_DEBUG_LEVEL with its prefix
	374	*/
	375	#define ____do_kdebug(LEVEL, POINT) \
	376	unlikely((fscache_debug & \
	377	(FSCACHE_POINT_##POINT << (FSCACHE_DEBUG_ ## LEVEL * 3))))
	378	#define ___do_kdebug(LEVEL, POINT) \
	379	____do_kdebug(LEVEL, POINT)
	380	#define __do_kdebug(POINT) \
	381	___do_kdebug(FSCACHE_DEBUG_LEVEL, POINT)
	382
	383	#define FSCACHE_DEBUG_CACHE 0
	384	#define FSCACHE_DEBUG_COOKIE 1
	385	#define FSCACHE_DEBUG_PAGE 2
	386	#define FSCACHE_DEBUG_OPERATION 3
	387
	388	#define FSCACHE_POINT_ENTER 1
	389	#define FSCACHE_POINT_LEAVE 2
	390	#define FSCACHE_POINT_DEBUG 4
	391
	392	#ifndef FSCACHE_DEBUG_LEVEL
	393	#define FSCACHE_DEBUG_LEVEL CACHE
	394	#endif
	395
	396	/*
	397	* assertions
	398	*/
	399	#if 1 /* defined(__KDEBUGALL) */
	400
	401	#define ASSERT(X) \
	402	do { \
	403	if (unlikely(!(X))) { \
	404	printk(KERN_ERR "\n"); \
	405	printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
	406	BUG(); \
	407	} \
	408	} while (0)
	409
	410	#define ASSERTCMP(X, OP, Y) \
	411	do { \
	412	if (unlikely(!((X) OP (Y)))) { \
	413	printk(KERN_ERR "\n"); \
	414	printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
	415	printk(KERN_ERR "%lx " #OP " %lx is false\n", \
	416	(unsigned long)(X), (unsigned long)(Y)); \
	417	BUG(); \
	418	} \
	419	} while (0)
	420
	421	#define ASSERTIF(C, X) \
	422	do { \
	423	if (unlikely((C) && !(X))) { \
	424	printk(KERN_ERR "\n"); \
	425	printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
	426	BUG(); \
	427	} \
	428	} while (0)
	429
	430	#define ASSERTIFCMP(C, X, OP, Y) \
	431	do { \
432	if (unlikely((C) && !((X) OP (Y)))) { \
433	printk(KERN_ERR "\n"); \
434	printk(KERN_ERR "FS-Cache: Assertion failed\n"); \
435	printk(KERN_ERR "%lx " #OP " %lx is false\n", \
436	(unsigned long)(X), (unsigned long)(Y)); \
437	BUG(); \
438	} \
439	} while (0)
440
441	#else
442
443	#define ASSERT(X) do {} while (0)
444	#define ASSERTCMP(X, OP, Y) do {} while (0)
445	#define ASSERTIF(C, X) do {} while (0)
446	#define ASSERTIFCMP(C, X, OP, Y) do {} while (0)
447
448	#endif /* assert or not */