[mirror_ubuntu-bionic-kernel.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 <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);
}

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

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