[linux-2.6-block.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
 *
 */

#ifdef pr_fmt
#undef pr_fmt
#endif

#define pr_fmt(fmt) "FS-Cache: " fmt

#include <linux/fscache-cache.h>
#include <trace/events/fscache.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_free_cookie(struct fscache_cookie *);
extern void fscache_cookie_init_once(void *);
extern struct fscache_cookie *fscache_alloc_cookie(struct fscache_cookie *,
						   const struct fscache_cookie_def *,
						   const void *, size_t,
						   const void *, size_t,
						   void *, loff_t);
extern struct fscache_cookie *fscache_hash_cookie(struct fscache_cookie *);
extern void fscache_cookie_put(struct fscache_cookie *,
			       enum fscache_cookie_trace);

/*
 * 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);
}

/*
 * object.c
 */
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 *);
extern void fscache_objlist_remove(struct fscache_object *);
#else
#define fscache_objlist_add(object) do {} while(0)
#define fscache_objlist_remove(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 *, bool);
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 int fscache_wait_for_deferred_lookup(struct fscache_cookie *);
extern int fscache_wait_for_operation_activation(struct fscache_object *,
						 struct fscache_operation *,
						 atomic_t *,
						 atomic_t *);
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_initialised;
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_store_vmscan_wait;

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;

extern atomic_t fscache_n_cache_no_space_reject;
extern atomic_t fscache_n_cache_stale_objects;
extern atomic_t fscache_n_cache_retired_objects;
extern atomic_t fscache_n_cache_culled_objects;

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)
{
	BUG_ON(event >= NR_FSCACHE_OBJECT_EVENTS);
#if 0
	printk("*** fscache_raise_event(OBJ%d{%lx},%x)\n",
	       object->debug_id, object->event_mask, (1 << event));
#endif
	if (!test_and_set_bit(event, &object->events) &&
	    test_bit(event, &object->event_mask))
		fscache_enqueue_object(object);
}

static inline void fscache_cookie_get(struct fscache_cookie *cookie,
				      enum fscache_cookie_trace where)
{
	int usage = atomic_inc_return(&cookie->usage);

	trace_fscache_cookie(cookie, where, usage);
}

/*
 * 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);
}

/*
 * Update the auxiliary data on a cookie.
 */
static inline
void fscache_update_aux(struct fscache_cookie *cookie, const void *aux_data)
{
	void *p;

	if (!aux_data)
		return;
	if (cookie->aux_len <= sizeof(cookie->inline_aux))
		p = cookie->inline_aux;
	else
		p = cookie->aux;

	if (memcmp(p, aux_data, cookie->aux_len) != 0) {
		memcpy(p, aux_data, cookie->aux_len);
		set_bit(FSCACHE_COOKIE_AUX_UPDATED, &cookie->flags);
	}
}

/*****************************************************************************/
/*
 * 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))) {						\
		pr_err("\n");					\
		pr_err("Assertion failed\n");	\
		BUG();							\
	}								\
} while (0)

#define ASSERTCMP(X, OP, Y)						\
do {									\
	if (unlikely(!((X) OP (Y)))) {					\
		pr_err("\n");					\
		pr_err("Assertion failed\n");	\
		pr_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))) {					\
		pr_err("\n");					\
		pr_err("Assertion failed\n");	\
		BUG();							\
	}								\
} while (0)

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