[linux-2.6-block.git] / fs / fscache / object-list.c

// SPDX-License-Identifier: GPL-2.0-or-later
/* Global fscache object list maintainer and viewer
 *
 * Copyright (C) 2009 Red Hat, Inc. All Rights Reserved.
 * Written by David Howells (dhowells@redhat.com)
 */

#define FSCACHE_DEBUG_LEVEL COOKIE
#include <linux/module.h>
#include <linux/seq_file.h>
#include <linux/slab.h>
#include <linux/key.h>
#include <keys/user-type.h>
#include "internal.h"

static struct rb_root fscache_object_list;
static DEFINE_RWLOCK(fscache_object_list_lock);

struct fscache_objlist_data {
	unsigned long	config;		/* display configuration */
#define FSCACHE_OBJLIST_CONFIG_KEY	0x00000001	/* show object keys */
#define FSCACHE_OBJLIST_CONFIG_AUX	0x00000002	/* show object auxdata */
#define FSCACHE_OBJLIST_CONFIG_COOKIE	0x00000004	/* show objects with cookies */
#define FSCACHE_OBJLIST_CONFIG_NOCOOKIE	0x00000008	/* show objects without cookies */
#define FSCACHE_OBJLIST_CONFIG_BUSY	0x00000010	/* show busy objects */
#define FSCACHE_OBJLIST_CONFIG_IDLE	0x00000020	/* show idle objects */
#define FSCACHE_OBJLIST_CONFIG_PENDWR	0x00000040	/* show objects with pending writes */
#define FSCACHE_OBJLIST_CONFIG_NOPENDWR	0x00000080	/* show objects without pending writes */
#define FSCACHE_OBJLIST_CONFIG_READS	0x00000100	/* show objects with active reads */
#define FSCACHE_OBJLIST_CONFIG_NOREADS	0x00000200	/* show objects without active reads */
#define FSCACHE_OBJLIST_CONFIG_EVENTS	0x00000400	/* show objects with events */
#define FSCACHE_OBJLIST_CONFIG_NOEVENTS	0x00000800	/* show objects without no events */
#define FSCACHE_OBJLIST_CONFIG_WORK	0x00001000	/* show objects with work */
#define FSCACHE_OBJLIST_CONFIG_NOWORK	0x00002000	/* show objects without work */
};

/*
 * Add an object to the object list
 * - we use the address of the fscache_object structure as the key into the
 *   tree
 */
void fscache_objlist_add(struct fscache_object *obj)
{
	struct fscache_object *xobj;
	struct rb_node **p = &fscache_object_list.rb_node, *parent = NULL;

	ASSERT(RB_EMPTY_NODE(&obj->objlist_link));

	write_lock(&fscache_object_list_lock);

	while (*p) {
		parent = *p;
		xobj = rb_entry(parent, struct fscache_object, objlist_link);

		if (obj < xobj)
			p = &(*p)->rb_left;
		else if (obj > xobj)
			p = &(*p)->rb_right;
		else
			BUG();
	}

	rb_link_node(&obj->objlist_link, parent, p);
	rb_insert_color(&obj->objlist_link, &fscache_object_list);

	write_unlock(&fscache_object_list_lock);
}

/*
 * Remove an object from the object list.
 */
void fscache_objlist_remove(struct fscache_object *obj)
{
	if (RB_EMPTY_NODE(&obj->objlist_link))
		return;

	write_lock(&fscache_object_list_lock);

	BUG_ON(RB_EMPTY_ROOT(&fscache_object_list));
	rb_erase(&obj->objlist_link, &fscache_object_list);

	write_unlock(&fscache_object_list_lock);
}

/*
 * find the object in the tree on or after the specified index
 */
static struct fscache_object *fscache_objlist_lookup(loff_t *_pos)
{
	struct fscache_object *pobj, *obj = NULL, *minobj = NULL;
	struct rb_node *p;
	unsigned long pos;

	if (*_pos >= (unsigned long) ERR_PTR(-ENOENT))
		return NULL;
	pos = *_pos;

	/* banners (can't represent line 0 by pos 0 as that would involve
	 * returning a NULL pointer) */
	if (pos == 0)
		return (struct fscache_object *)(long)++(*_pos);
	if (pos < 3)
		return (struct fscache_object *)pos;

	pobj = (struct fscache_object *)pos;
	p = fscache_object_list.rb_node;
	while (p) {
		obj = rb_entry(p, struct fscache_object, objlist_link);
		if (pobj < obj) {
			if (!minobj || minobj > obj)
				minobj = obj;
			p = p->rb_left;
		} else if (pobj > obj) {
			p = p->rb_right;
		} else {
			minobj = obj;
			break;
		}
		obj = NULL;
	}

	if (!minobj)
		*_pos = (unsigned long) ERR_PTR(-ENOENT);
	else if (minobj != obj)
		*_pos = (unsigned long) minobj;
	return minobj;
}

/*
 * set up the iterator to start reading from the first line
 */
static void *fscache_objlist_start(struct seq_file *m, loff_t *_pos)
	__acquires(&fscache_object_list_lock)
{
	read_lock(&fscache_object_list_lock);
	return fscache_objlist_lookup(_pos);
}

/*
 * move to the next line
 */
static void *fscache_objlist_next(struct seq_file *m, void *v, loff_t *_pos)
{
	(*_pos)++;
	return fscache_objlist_lookup(_pos);
}

/*
 * clean up after reading
 */
static void fscache_objlist_stop(struct seq_file *m, void *v)
	__releases(&fscache_object_list_lock)
{
	read_unlock(&fscache_object_list_lock);
}

/*
 * display an object
 */
static int fscache_objlist_show(struct seq_file *m, void *v)
{
	struct fscache_objlist_data *data = m->private;
	struct fscache_object *obj = v;
	struct fscache_cookie *cookie;
	unsigned long config = data->config;
	char _type[3], *type;
	u8 *p;

	if ((unsigned long) v == 1) {
		seq_puts(m, "OBJECT   PARENT   STAT CHLDN OPS OOP IPR EX READS"
			 " EM EV FL S"
			 " | NETFS_COOKIE_DEF TY FL NETFS_DATA");
		if (config & (FSCACHE_OBJLIST_CONFIG_KEY |
			      FSCACHE_OBJLIST_CONFIG_AUX))
			seq_puts(m, "       ");
		if (config & FSCACHE_OBJLIST_CONFIG_KEY)
			seq_puts(m, "OBJECT_KEY");
		if ((config & (FSCACHE_OBJLIST_CONFIG_KEY |
			       FSCACHE_OBJLIST_CONFIG_AUX)) ==
		    (FSCACHE_OBJLIST_CONFIG_KEY | FSCACHE_OBJLIST_CONFIG_AUX))
			seq_puts(m, ", ");
		if (config & FSCACHE_OBJLIST_CONFIG_AUX)
			seq_puts(m, "AUX_DATA");
		seq_puts(m, "\n");
		return 0;
	}

	if ((unsigned long) v == 2) {
		seq_puts(m, "======== ======== ==== ===== === === === == ====="
			 " == == == ="
			 " | ================ == == ================");
		if (config & (FSCACHE_OBJLIST_CONFIG_KEY |
			      FSCACHE_OBJLIST_CONFIG_AUX))
			seq_puts(m, " ================");
		seq_puts(m, "\n");
		return 0;
	}

	/* filter out any unwanted objects */
#define FILTER(criterion, _yes, _no)					\
	do {								\
		unsigned long yes = FSCACHE_OBJLIST_CONFIG_##_yes;	\
		unsigned long no = FSCACHE_OBJLIST_CONFIG_##_no;	\
		if (criterion) {					\
			if (!(config & yes))				\
				return 0;				\
		} else {						\
			if (!(config & no))				\
				return 0;				\
		}							\
	} while(0)

	cookie = obj->cookie;
	if (~config) {
		FILTER(cookie->def,
		       COOKIE, NOCOOKIE);
		FILTER(fscache_object_is_active(obj) ||
		       obj->n_ops != 0 ||
		       obj->n_obj_ops != 0 ||
		       obj->flags ||
		       !list_empty(&obj->dependents),
		       BUSY, IDLE);
		FILTER(test_bit(FSCACHE_OBJECT_PENDING_WRITE, &obj->flags),
		       PENDWR, NOPENDWR);
		FILTER(atomic_read(&obj->n_reads),
		       READS, NOREADS);
		FILTER(obj->events & obj->event_mask,
		       EVENTS, NOEVENTS);
		FILTER(work_busy(&obj->work), WORK, NOWORK);
	}

	seq_printf(m,
		   "%8x %8x %s %5u %3u %3u %3u %2u %5u %2lx %2lx %2lx %1x | ",
		   obj->debug_id,
		   obj->parent ? obj->parent->debug_id : -1,
		   obj->state->short_name,
		   obj->n_children,
		   obj->n_ops,
		   obj->n_obj_ops,
		   obj->n_in_progress,
		   obj->n_exclusive,
		   atomic_read(&obj->n_reads),
		   obj->event_mask,
		   obj->events,
		   obj->flags,
		   work_busy(&obj->work));

	if (fscache_use_cookie(obj)) {
		uint16_t keylen = 0, auxlen = 0;

		switch (cookie->type) {
		case 0:
			type = "IX";
			break;
		case 1:
			type = "DT";
			break;
		default:
			snprintf(_type, sizeof(_type), "%02u",
				 cookie->type);
			type = _type;
			break;
		}

		seq_printf(m, "%-16s %s %2lx %16p",
			   cookie->def->name,
			   type,
			   cookie->flags,
			   cookie->netfs_data);

		if (config & FSCACHE_OBJLIST_CONFIG_KEY)
			keylen = cookie->key_len;

		if (config & FSCACHE_OBJLIST_CONFIG_AUX)
			auxlen = cookie->aux_len;

		if (keylen > 0 || auxlen > 0) {
			seq_puts(m, " ");
			p = keylen <= sizeof(cookie->inline_key) ?
				cookie->inline_key : cookie->key;
			for (; keylen > 0; keylen--)
				seq_printf(m, "%02x", *p++);
			if (auxlen > 0) {
				if (config & FSCACHE_OBJLIST_CONFIG_KEY)
					seq_puts(m, ", ");
				p = auxlen <= sizeof(cookie->inline_aux) ?
					cookie->inline_aux : cookie->aux;
				for (; auxlen > 0; auxlen--)
					seq_printf(m, "%02x", *p++);
			}
		}

		seq_puts(m, "\n");
		fscache_unuse_cookie(obj);
	} else {
		seq_puts(m, "<no_netfs>\n");
	}
	return 0;
}

static const struct seq_operations fscache_objlist_ops = {
	.start		= fscache_objlist_start,
	.stop		= fscache_objlist_stop,
	.next		= fscache_objlist_next,
	.show		= fscache_objlist_show,
};

/*
 * get the configuration for filtering the list
 */
static void fscache_objlist_config(struct fscache_objlist_data *data)
{
#ifdef CONFIG_KEYS
	const struct user_key_payload *confkey;
	unsigned long config;
	struct key *key;
	const char *buf;
	int len;

	key = request_key(&key_type_user, "fscache:objlist", NULL);
	if (IS_ERR(key))
		goto no_config;

	config = 0;
	rcu_read_lock();

	confkey = user_key_payload_rcu(key);
	if (!confkey) {
		/* key was revoked */
		rcu_read_unlock();
		key_put(key);
		goto no_config;
	}

	buf = confkey->data;

	for (len = confkey->datalen - 1; len >= 0; len--) {
		switch (buf[len]) {
		case 'K': config |= FSCACHE_OBJLIST_CONFIG_KEY;		break;
		case 'A': config |= FSCACHE_OBJLIST_CONFIG_AUX;		break;
		case 'C': config |= FSCACHE_OBJLIST_CONFIG_COOKIE;	break;
		case 'c': config |= FSCACHE_OBJLIST_CONFIG_NOCOOKIE;	break;
		case 'B': config |= FSCACHE_OBJLIST_CONFIG_BUSY;	break;
		case 'b': config |= FSCACHE_OBJLIST_CONFIG_IDLE;	break;
		case 'W': config |= FSCACHE_OBJLIST_CONFIG_PENDWR;	break;
		case 'w': config |= FSCACHE_OBJLIST_CONFIG_NOPENDWR;	break;
		case 'R': config |= FSCACHE_OBJLIST_CONFIG_READS;	break;
		case 'r': config |= FSCACHE_OBJLIST_CONFIG_NOREADS;	break;
		case 'S': config |= FSCACHE_OBJLIST_CONFIG_WORK;	break;
		case 's': config |= FSCACHE_OBJLIST_CONFIG_NOWORK;	break;
		}
	}

	rcu_read_unlock();
	key_put(key);

	if (!(config & (FSCACHE_OBJLIST_CONFIG_COOKIE | FSCACHE_OBJLIST_CONFIG_NOCOOKIE)))
	    config   |= FSCACHE_OBJLIST_CONFIG_COOKIE | FSCACHE_OBJLIST_CONFIG_NOCOOKIE;
	if (!(config & (FSCACHE_OBJLIST_CONFIG_BUSY | FSCACHE_OBJLIST_CONFIG_IDLE)))
	    config   |= FSCACHE_OBJLIST_CONFIG_BUSY | FSCACHE_OBJLIST_CONFIG_IDLE;
	if (!(config & (FSCACHE_OBJLIST_CONFIG_PENDWR | FSCACHE_OBJLIST_CONFIG_NOPENDWR)))
	    config   |= FSCACHE_OBJLIST_CONFIG_PENDWR | FSCACHE_OBJLIST_CONFIG_NOPENDWR;
	if (!(config & (FSCACHE_OBJLIST_CONFIG_READS | FSCACHE_OBJLIST_CONFIG_NOREADS)))
	    config   |= FSCACHE_OBJLIST_CONFIG_READS | FSCACHE_OBJLIST_CONFIG_NOREADS;
	if (!(config & (FSCACHE_OBJLIST_CONFIG_EVENTS | FSCACHE_OBJLIST_CONFIG_NOEVENTS)))
	    config   |= FSCACHE_OBJLIST_CONFIG_EVENTS | FSCACHE_OBJLIST_CONFIG_NOEVENTS;
	if (!(config & (FSCACHE_OBJLIST_CONFIG_WORK | FSCACHE_OBJLIST_CONFIG_NOWORK)))
	    config   |= FSCACHE_OBJLIST_CONFIG_WORK | FSCACHE_OBJLIST_CONFIG_NOWORK;

	data->config = config;
	return;

no_config:
#endif
	data->config = ULONG_MAX;
}

/*
 * open "/proc/fs/fscache/objects" to provide a list of active objects
 * - can be configured by a user-defined key added to the caller's keyrings
 */
static int fscache_objlist_open(struct inode *inode, struct file *file)
{
	struct fscache_objlist_data *data;

	data = __seq_open_private(file, &fscache_objlist_ops, sizeof(*data));
	if (!data)
		return -ENOMEM;

	/* get the configuration key */
	fscache_objlist_config(data);

	return 0;
}

/*
 * clean up on close
 */
static int fscache_objlist_release(struct inode *inode, struct file *file)
{
	struct seq_file *m = file->private_data;

	kfree(m->private);
	m->private = NULL;
	return seq_release(inode, file);
}

const struct file_operations fscache_objlist_fops = {
	.open		= fscache_objlist_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= fscache_objlist_release,
};
Commit	Line	Data
b4d0d230	1	// SPDX-License-Identifier: GPL-2.0-or-later
4fbf4291 DH	2	/* Global fscache object list maintainer and viewer
	3	*
	4	* Copyright (C) 2009 Red Hat, Inc. All Rights Reserved.
	5	* Written by David Howells (dhowells@redhat.com)
4fbf4291 DH	6	*/
	7
	8	#define FSCACHE_DEBUG_LEVEL COOKIE
	9	#include <linux/module.h>
	10	#include <linux/seq_file.h>
5a0e3ad6	11	#include <linux/slab.h>
4fbf4291 DH	12	#include <linux/key.h>
	13	#include <keys/user-type.h>
	14	#include "internal.h"
	15
	16	static struct rb_root fscache_object_list;
	17	static DEFINE_RWLOCK(fscache_object_list_lock);
	18
	19	struct fscache_objlist_data {
	20	unsigned long config; /* display configuration */
	21	#define FSCACHE_OBJLIST_CONFIG_KEY 0x00000001 /* show object keys */
	22	#define FSCACHE_OBJLIST_CONFIG_AUX 0x00000002 /* show object auxdata */
	23	#define FSCACHE_OBJLIST_CONFIG_COOKIE 0x00000004 /* show objects with cookies */
	24	#define FSCACHE_OBJLIST_CONFIG_NOCOOKIE 0x00000008 /* show objects without cookies */
	25	#define FSCACHE_OBJLIST_CONFIG_BUSY 0x00000010 /* show busy objects */
	26	#define FSCACHE_OBJLIST_CONFIG_IDLE 0x00000020 /* show idle objects */
	27	#define FSCACHE_OBJLIST_CONFIG_PENDWR 0x00000040 /* show objects with pending writes */
	28	#define FSCACHE_OBJLIST_CONFIG_NOPENDWR 0x00000080 /* show objects without pending writes */
	29	#define FSCACHE_OBJLIST_CONFIG_READS 0x00000100 /* show objects with active reads */
	30	#define FSCACHE_OBJLIST_CONFIG_NOREADS 0x00000200 /* show objects without active reads */
	31	#define FSCACHE_OBJLIST_CONFIG_EVENTS 0x00000400 /* show objects with events */
	32	#define FSCACHE_OBJLIST_CONFIG_NOEVENTS 0x00000800 /* show objects without no events */
8b8edefa TH	33	#define FSCACHE_OBJLIST_CONFIG_WORK 0x00001000 /* show objects with work */
8b8edefa TH	34	#define FSCACHE_OBJLIST_CONFIG_NOWORK 0x00002000 /* show objects without work */
4fbf4291 DH	35	};
	36
	37	/*
	38	* Add an object to the object list
	39	* - we use the address of the fscache_object structure as the key into the
	40	* tree
	41	*/
	42	void fscache_objlist_add(struct fscache_object *obj)
	43	{
	44	struct fscache_object *xobj;
	45	struct rb_node *p = &fscache_object_list.rb_node, parent = NULL;
	46
7026f192 DH	47	ASSERT(RB_EMPTY_NODE(&obj->objlist_link));
7026f192 DH	48
4fbf4291 DH	49	write_lock(&fscache_object_list_lock);
	50
	51	while (*p) {
	52	parent = *p;
	53	xobj = rb_entry(parent, struct fscache_object, objlist_link);
	54
	55	if (obj < xobj)
	56	p = &(*p)->rb_left;
	57	else if (obj > xobj)
	58	p = &(*p)->rb_right;
	59	else
	60	BUG();
	61	}
	62
	63	rb_link_node(&obj->objlist_link, parent, p);
	64	rb_insert_color(&obj->objlist_link, &fscache_object_list);
	65
	66	write_unlock(&fscache_object_list_lock);
	67	}
	68
1362729b DH	69	/*
1362729b DH	70	* Remove an object from the object list.
4fbf4291	71	*/
1362729b	72	void fscache_objlist_remove(struct fscache_object *obj)
4fbf4291	73	{
7026f192 DH	74	if (RB_EMPTY_NODE(&obj->objlist_link))
	75	return;
	76
4fbf4291 DH	77	write_lock(&fscache_object_list_lock);
	78
	79	BUG_ON(RB_EMPTY_ROOT(&fscache_object_list));
	80	rb_erase(&obj->objlist_link, &fscache_object_list);
	81
	82	write_unlock(&fscache_object_list_lock);
	83	}
4fbf4291 DH	84
	85	/*
	86	* find the object in the tree on or after the specified index
	87	*/
	88	static struct fscache_object fscache_objlist_lookup(loff_t _pos)
	89	{
ea58ceb5	90	struct fscache_object pobj, obj = NULL, *minobj = NULL;
4fbf4291 DH	91	struct rb_node *p;
	92	unsigned long pos;
	93
	94	if (*_pos >= (unsigned long) ERR_PTR(-ENOENT))
	95	return NULL;
	96	pos = *_pos;
	97
	98	/* banners (can't represent line 0 by pos 0 as that would involve
	99	* returning a NULL pointer) */
	100	if (pos == 0)
cc68e3be	101	return (struct fscache_object )(long)++(_pos);
4fbf4291 DH	102	if (pos < 3)
	103	return (struct fscache_object *)pos;
	104
	105	pobj = (struct fscache_object *)pos;
	106	p = fscache_object_list.rb_node;
	107	while (p) {
	108	obj = rb_entry(p, struct fscache_object, objlist_link);
	109	if (pobj < obj) {
	110	if (!minobj \|\| minobj > obj)
	111	minobj = obj;
	112	p = p->rb_left;
	113	} else if (pobj > obj) {
	114	p = p->rb_right;
	115	} else {
	116	minobj = obj;
	117	break;
	118	}
	119	obj = NULL;
	120	}
	121
	122	if (!minobj)
	123	*_pos = (unsigned long) ERR_PTR(-ENOENT);
	124	else if (minobj != obj)
	125	*_pos = (unsigned long) minobj;
	126	return minobj;
	127	}
	128
	129	/*
	130	* set up the iterator to start reading from the first line
	131	*/
	132	static void fscache_objlist_start(struct seq_file m, loff_t *_pos)
	133	__acquires(&fscache_object_list_lock)
	134	{
	135	read_lock(&fscache_object_list_lock);
	136	return fscache_objlist_lookup(_pos);
	137	}
	138
	139	/*
	140	* move to the next line
	141	*/
	142	static void fscache_objlist_next(struct seq_file m, void v, loff_t _pos)
	143	{
	144	(*_pos)++;
	145	return fscache_objlist_lookup(_pos);
	146	}
	147
	148	/*
	149	* clean up after reading
	150	*/
	151	static void fscache_objlist_stop(struct seq_file m, void v)
	152	__releases(&fscache_object_list_lock)
	153	{
	154	read_unlock(&fscache_object_list_lock);
	155	}
	156
	157	/*
	158	* display an object
	159	*/
	160	static int fscache_objlist_show(struct seq_file m, void v)
	161	{
	162	struct fscache_objlist_data *data = m->private;
	163	struct fscache_object *obj = v;
1362729b	164	struct fscache_cookie *cookie;
4fbf4291	165	unsigned long config = data->config;
4fbf4291	166	char _type[3], *type;
402cb8dd	167	u8 *p;
4fbf4291 DH	168
	169	if ((unsigned long) v == 1) {
	170	seq_puts(m, "OBJECT PARENT STAT CHLDN OPS OOP IPR EX READS"
caaef690	171	" EM EV FL S"
4fbf4291 DH	172	" \| NETFS_COOKIE_DEF TY FL NETFS_DATA");
	173	if (config & (FSCACHE_OBJLIST_CONFIG_KEY \|
	174	FSCACHE_OBJLIST_CONFIG_AUX))
	175	seq_puts(m, " ");
	176	if (config & FSCACHE_OBJLIST_CONFIG_KEY)
	177	seq_puts(m, "OBJECT_KEY");
	178	if ((config & (FSCACHE_OBJLIST_CONFIG_KEY \|
	179	FSCACHE_OBJLIST_CONFIG_AUX)) ==
	180	(FSCACHE_OBJLIST_CONFIG_KEY \| FSCACHE_OBJLIST_CONFIG_AUX))
	181	seq_puts(m, ", ");
	182	if (config & FSCACHE_OBJLIST_CONFIG_AUX)
	183	seq_puts(m, "AUX_DATA");
	184	seq_puts(m, "\n");
	185	return 0;
	186	}
	187
	188	if ((unsigned long) v == 2) {
	189	seq_puts(m, "======== ======== ==== ===== === === === == ====="
caaef690	190	" == == == ="
4fbf4291 DH	191	" \| ================ == == ================");
	192	if (config & (FSCACHE_OBJLIST_CONFIG_KEY \|
	193	FSCACHE_OBJLIST_CONFIG_AUX))
	194	seq_puts(m, " ================");
	195	seq_puts(m, "\n");
	196	return 0;
	197	}
	198
	199	/* filter out any unwanted objects */
	200	#define FILTER(criterion, _yes, _no) \
	201	do { \
	202	unsigned long yes = FSCACHE_OBJLIST_CONFIG_##_yes; \
	203	unsigned long no = FSCACHE_OBJLIST_CONFIG_##_no; \
	204	if (criterion) { \
	205	if (!(config & yes)) \
	206	return 0; \
	207	} else { \
	208	if (!(config & no)) \
	209	return 0; \
	210	} \
	211	} while(0)
	212
1362729b	213	cookie = obj->cookie;
4fbf4291	214	if (~config) {
1362729b	215	FILTER(cookie->def,
4fbf4291	216	COOKIE, NOCOOKIE);
caaef690	217	FILTER(fscache_object_is_active(obj) \|\|
4fbf4291 DH	218	obj->n_ops != 0 \|\|
	219	obj->n_obj_ops != 0 \|\|
	220	obj->flags \|\|
	221	!list_empty(&obj->dependents),
	222	BUSY, IDLE);
	223	FILTER(test_bit(FSCACHE_OBJECT_PENDING_WRITE, &obj->flags),
	224	PENDWR, NOPENDWR);
	225	FILTER(atomic_read(&obj->n_reads),
	226	READS, NOREADS);
	227	FILTER(obj->events & obj->event_mask,
	228	EVENTS, NOEVENTS);
8b8edefa	229	FILTER(work_busy(&obj->work), WORK, NOWORK);
4fbf4291 DH	230	}
	231
	232	seq_printf(m,
caaef690	233	"%8x %8x %s %5u %3u %3u %3u %2u %5u %2lx %2lx %2lx %1x \| ",
4fbf4291 DH	234	obj->debug_id,
4fbf4291 DH	235	obj->parent ? obj->parent->debug_id : -1,
caaef690	236	obj->state->short_name,
4fbf4291 DH	237	obj->n_children,
	238	obj->n_ops,
	239	obj->n_obj_ops,
	240	obj->n_in_progress,
	241	obj->n_exclusive,
	242	atomic_read(&obj->n_reads),
c2d35bfe	243	obj->event_mask,
4fbf4291 DH	244	obj->events,
4fbf4291 DH	245	obj->flags,
8b8edefa	246	work_busy(&obj->work));
4fbf4291	247
1362729b DH	248	if (fscache_use_cookie(obj)) {
1362729b DH	249	uint16_t keylen = 0, auxlen = 0;
4fbf4291	250
402cb8dd	251	switch (cookie->type) {
1362729b DH	252	case 0:
	253	type = "IX";
	254	break;
	255	case 1:
	256	type = "DT";
	257	break;
	258	default:
ebfddb3d	259	snprintf(_type, sizeof(_type), "%02u",
402cb8dd	260	cookie->type);
1362729b DH	261	type = _type;
1362729b DH	262	break;
4fbf4291	263	}
4fbf4291	264
1362729b DH	265	seq_printf(m, "%-16s %s %2lx %16p",
	266	cookie->def->name,
	267	type,
	268	cookie->flags,
	269	cookie->netfs_data);
	270
402cb8dd DH	271	if (config & FSCACHE_OBJLIST_CONFIG_KEY)
402cb8dd DH	272	keylen = cookie->key_len;
1362729b	273
402cb8dd DH	274	if (config & FSCACHE_OBJLIST_CONFIG_AUX)
402cb8dd DH	275	auxlen = cookie->aux_len;
1362729b DH	276
1362729b DH	277	if (keylen > 0 \|\| auxlen > 0) {
3185a88c	278	seq_puts(m, " ");
402cb8dd DH	279	p = keylen <= sizeof(cookie->inline_key) ?
	280	cookie->inline_key : cookie->key;
	281	for (; keylen > 0; keylen--)
4fbf4291 DH	282	seq_printf(m, "%02x", *p++);
	283	if (auxlen > 0) {
	284	if (config & FSCACHE_OBJLIST_CONFIG_KEY)
3185a88c	285	seq_puts(m, ", ");
402cb8dd DH	286	p = auxlen <= sizeof(cookie->inline_aux) ?
402cb8dd DH	287	cookie->inline_aux : cookie->aux;
4fbf4291 DH	288	for (; auxlen > 0; auxlen--)
	289	seq_printf(m, "%02x", *p++);
	290	}
	291	}
4fbf4291	292
3185a88c	293	seq_puts(m, "\n");
402cb8dd	294	fscache_unuse_cookie(obj);
1362729b	295	} else {
3185a88c	296	seq_puts(m, "<no_netfs>\n");
1362729b	297	}
4fbf4291 DH	298	return 0;
	299	}
	300
	301	static const struct seq_operations fscache_objlist_ops = {
	302	.start = fscache_objlist_start,
	303	.stop = fscache_objlist_stop,
	304	.next = fscache_objlist_next,
	305	.show = fscache_objlist_show,
	306	};
	307
	308	/*
	309	* get the configuration for filtering the list
	310	*/
	311	static void fscache_objlist_config(struct fscache_objlist_data *data)
	312	{
	313	#ifdef CONFIG_KEYS
146aa8b1	314	const struct user_key_payload *confkey;
4fbf4291 DH	315	unsigned long config;
	316	struct key *key;
	317	const char *buf;
	318	int len;
	319
028db3e2	320	key = request_key(&key_type_user, "fscache:objlist", NULL);
4fbf4291 DH	321	if (IS_ERR(key))
	322	goto no_config;
	323
	324	config = 0;
	325	rcu_read_lock();
	326
0837e49a	327	confkey = user_key_payload_rcu(key);
d124b2c5 EB	328	if (!confkey) {
	329	/* key was revoked */
	330	rcu_read_unlock();
	331	key_put(key);
	332	goto no_config;
	333	}
	334
4fbf4291 DH	335	buf = confkey->data;
	336
	337	for (len = confkey->datalen - 1; len >= 0; len--) {
	338	switch (buf[len]) {
	339	case 'K': config \|= FSCACHE_OBJLIST_CONFIG_KEY; break;
	340	case 'A': config \|= FSCACHE_OBJLIST_CONFIG_AUX; break;
	341	case 'C': config \|= FSCACHE_OBJLIST_CONFIG_COOKIE; break;
	342	case 'c': config \|= FSCACHE_OBJLIST_CONFIG_NOCOOKIE; break;
	343	case 'B': config \|= FSCACHE_OBJLIST_CONFIG_BUSY; break;
	344	case 'b': config \|= FSCACHE_OBJLIST_CONFIG_IDLE; break;
	345	case 'W': config \|= FSCACHE_OBJLIST_CONFIG_PENDWR; break;
	346	case 'w': config \|= FSCACHE_OBJLIST_CONFIG_NOPENDWR; break;
	347	case 'R': config \|= FSCACHE_OBJLIST_CONFIG_READS; break;
	348	case 'r': config \|= FSCACHE_OBJLIST_CONFIG_NOREADS; break;
	349	case 'S': config \|= FSCACHE_OBJLIST_CONFIG_WORK; break;
	350	case 's': config \|= FSCACHE_OBJLIST_CONFIG_NOWORK; break;
	351	}
	352	}
	353
	354	rcu_read_unlock();
	355	key_put(key);
	356
	357	if (!(config & (FSCACHE_OBJLIST_CONFIG_COOKIE \| FSCACHE_OBJLIST_CONFIG_NOCOOKIE)))
	358	config \|= FSCACHE_OBJLIST_CONFIG_COOKIE \| FSCACHE_OBJLIST_CONFIG_NOCOOKIE;
	359	if (!(config & (FSCACHE_OBJLIST_CONFIG_BUSY \| FSCACHE_OBJLIST_CONFIG_IDLE)))
	360	config \|= FSCACHE_OBJLIST_CONFIG_BUSY \| FSCACHE_OBJLIST_CONFIG_IDLE;
	361	if (!(config & (FSCACHE_OBJLIST_CONFIG_PENDWR \| FSCACHE_OBJLIST_CONFIG_NOPENDWR)))
	362	config \|= FSCACHE_OBJLIST_CONFIG_PENDWR \| FSCACHE_OBJLIST_CONFIG_NOPENDWR;
	363	if (!(config & (FSCACHE_OBJLIST_CONFIG_READS \| FSCACHE_OBJLIST_CONFIG_NOREADS)))
	364	config \|= FSCACHE_OBJLIST_CONFIG_READS \| FSCACHE_OBJLIST_CONFIG_NOREADS;
	365	if (!(config & (FSCACHE_OBJLIST_CONFIG_EVENTS \| FSCACHE_OBJLIST_CONFIG_NOEVENTS)))
	366	config \|= FSCACHE_OBJLIST_CONFIG_EVENTS \| FSCACHE_OBJLIST_CONFIG_NOEVENTS;
	367	if (!(config & (FSCACHE_OBJLIST_CONFIG_WORK \| FSCACHE_OBJLIST_CONFIG_NOWORK)))
	368	config \|= FSCACHE_OBJLIST_CONFIG_WORK \| FSCACHE_OBJLIST_CONFIG_NOWORK;
	369
	370	data->config = config;
	371	return;
	372
	373	no_config:
	374	#endif
	375	data->config = ULONG_MAX;
	376	}
	377
	378	/*
	379	* open "/proc/fs/fscache/objects" to provide a list of active objects
	380	* - can be configured by a user-defined key added to the caller's keyrings
	381	*/
	382	static int fscache_objlist_open(struct inode inode, struct file file)
	383	{
	384	struct fscache_objlist_data *data;
4fbf4291	385
d5d96226 RJ	386	data = __seq_open_private(file, &fscache_objlist_ops, sizeof(*data));
d5d96226 RJ	387	if (!data)
4fbf4291	388	return -ENOMEM;
4fbf4291 DH	389
	390	/* get the configuration key */
	391	fscache_objlist_config(data);
	392
4fbf4291 DH	393	return 0;
	394	}
	395
	396	/*
	397	* clean up on close
	398	*/
	399	static int fscache_objlist_release(struct inode inode, struct file file)
	400	{
	401	struct seq_file *m = file->private_data;
	402
	403	kfree(m->private);
	404	m->private = NULL;
	405	return seq_release(inode, file);
	406	}
	407
	408	const struct file_operations fscache_objlist_fops = {
4fbf4291 DH	409	.open = fscache_objlist_open,
	410	.read = seq_read,
	411	.llseek = seq_lseek,
	412	.release = fscache_objlist_release,
	413	};