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

/* SPDX-License-Identifier: GPL-2.0-or-later */
/* Internal definitions for FS-Cache
 *
 * Copyright (C) 2004-2007 Red Hat, Inc. All Rights Reserved.
 * Written by David Howells ([email protected])
 */

/*
 * 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>
#include <linux/seq_file.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 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 seq_operations fscache_histogram_ops;

#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 proc_ops fscache_objlist_proc_ops;

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)

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