[deliverable/linux.git] / include / linux / sunrpc / cache.h

/*
 * include/linux/sunrpc/cache.h
 *
 * Generic code for various authentication-related caches
 * used by sunrpc clients and servers.
 *
 * Copyright (C) 2002 Neil Brown <neilb@cse.unsw.edu.au>
 *
 * Released under terms in GPL version 2.  See COPYING.
 *
 */

#ifndef _LINUX_SUNRPC_CACHE_H_
#define _LINUX_SUNRPC_CACHE_H_

#include <linux/kref.h>
#include <linux/slab.h>
#include <linux/atomic.h>
#include <linux/proc_fs.h>

/*
 * Each cache requires:
 *  - A 'struct cache_detail' which contains information specific to the cache
 *    for common code to use.
 *  - An item structure that must contain a "struct cache_head"
 *  - A lookup function defined using DefineCacheLookup
 *  - A 'put' function that can release a cache item. It will only
 *    be called after cache_put has succeed, so there are guarantee
 *    to be no references.
 *  - A function to calculate a hash of an item's key.
 *
 * as well as assorted code fragments (e.g. compare keys) and numbers
 * (e.g. hash size, goal_age, etc).
 *
 * Each cache must be registered so that it can be cleaned regularly.
 * When the cache is unregistered, it is flushed completely.
 *
 * Entries have a ref count and a 'hashed' flag which counts the existence
 * in the hash table.
 * We only expire entries when refcount is zero.
 * Existence in the cache is counted  the refcount.
 */

/* Every cache item has a common header that is used
 * for expiring and refreshing entries.
 * 
 */
struct cache_head {
	struct hlist_node	cache_list;
	time_t		expiry_time;	/* After time time, don't use the data */
	time_t		last_refresh;   /* If CACHE_PENDING, this is when upcall was
					 * sent, else this is when update was
					 * received, though it is alway set to
					 * be *after* ->flush_time.
					 */
	struct kref	ref;
	unsigned long	flags;
};
#define	CACHE_VALID	0	/* Entry contains valid data */
#define	CACHE_NEGATIVE	1	/* Negative entry - there is no match for the key */
#define	CACHE_PENDING	2	/* An upcall has been sent but no reply received yet*/
#define	CACHE_CLEANED	3	/* Entry has been cleaned from cache */

#define	CACHE_NEW_EXPIRY 120	/* keep new things pending confirmation for 120 seconds */

struct cache_detail_procfs {
	struct proc_dir_entry	*proc_ent;
	struct proc_dir_entry   *flush_ent, *channel_ent, *content_ent;
};

struct cache_detail_pipefs {
	struct dentry *dir;
};

struct cache_detail {
	struct module *		owner;
	int			hash_size;
	struct hlist_head *	hash_table;
	rwlock_t		hash_lock;

	atomic_t		inuse; /* active user-space update or lookup */

	char			*name;
	void			(*cache_put)(struct kref *);

	int			(*cache_upcall)(struct cache_detail *,
						struct cache_head *);

	void			(*cache_request)(struct cache_detail *cd,
						 struct cache_head *ch,
						 char **bpp, int *blen);

	int			(*cache_parse)(struct cache_detail *,
					       char *buf, int len);

	int			(*cache_show)(struct seq_file *m,
					      struct cache_detail *cd,
					      struct cache_head *h);
	void			(*warn_no_listener)(struct cache_detail *cd,
					      int has_died);

	struct cache_head *	(*alloc)(void);
	int			(*match)(struct cache_head *orig, struct cache_head *new);
	void			(*init)(struct cache_head *orig, struct cache_head *new);
	void			(*update)(struct cache_head *orig, struct cache_head *new);

	/* fields below this comment are for internal use
	 * and should not be touched by cache owners
	 */
	time_t			flush_time;		/* flush all cache items with
							 * last_refresh at or earlier
							 * than this.  last_refresh
							 * is never set at or earlier
							 * than this.
							 */
	struct list_head	others;
	time_t			nextcheck;
	int			entries;

	/* fields for communication over channel */
	struct list_head	queue;

	atomic_t		readers;		/* how many time is /chennel open */
	time_t			last_close;		/* if no readers, when did last close */
	time_t			last_warn;		/* when we last warned about no readers */

	union {
		struct cache_detail_procfs procfs;
		struct cache_detail_pipefs pipefs;
	} u;
	struct net		*net;
};


/* this must be embedded in any request structure that
 * identifies an object that will want a callback on
 * a cache fill
 */
struct cache_req {
	struct cache_deferred_req *(*defer)(struct cache_req *req);
	int thread_wait;  /* How long (jiffies) we can block the
			   * current thread to wait for updates.
			   */
};
/* this must be embedded in a deferred_request that is being
 * delayed awaiting cache-fill
 */
struct cache_deferred_req {
	struct hlist_node	hash;	/* on hash chain */
	struct list_head	recent; /* on fifo */
	struct cache_head	*item;  /* cache item we wait on */
	void			*owner; /* we might need to discard all defered requests
					 * owned by someone */
	void			(*revisit)(struct cache_deferred_req *req,
					   int too_many);
};

/*
 * timestamps kept in the cache are expressed in seconds
 * since boot.  This is the best for measuring differences in
 * real time.
 */
static inline time_t seconds_since_boot(void)
{
	struct timespec boot;
	getboottime(&boot);
	return get_seconds() - boot.tv_sec;
}

static inline time_t convert_to_wallclock(time_t sinceboot)
{
	struct timespec boot;
	getboottime(&boot);
	return boot.tv_sec + sinceboot;
}

extern const struct file_operations cache_file_operations_pipefs;
extern const struct file_operations content_file_operations_pipefs;
extern const struct file_operations cache_flush_operations_pipefs;

extern struct cache_head *
sunrpc_cache_lookup(struct cache_detail *detail,
		    struct cache_head *key, int hash);
extern struct cache_head *
sunrpc_cache_update(struct cache_detail *detail,
		    struct cache_head *new, struct cache_head *old, int hash);

extern int
sunrpc_cache_pipe_upcall(struct cache_detail *detail, struct cache_head *h);


extern void cache_clean_deferred(void *owner);

static inline struct cache_head  *cache_get(struct cache_head *h)
{
	kref_get(&h->ref);
	return h;
}


static inline void cache_put(struct cache_head *h, struct cache_detail *cd)
{
	if (atomic_read(&h->ref.refcount) <= 2 &&
	    h->expiry_time < cd->nextcheck)
		cd->nextcheck = h->expiry_time;
	kref_put(&h->ref, cd->cache_put);
}

static inline int cache_is_expired(struct cache_detail *detail, struct cache_head *h)
{
	return  (h->expiry_time < seconds_since_boot()) ||
		(detail->flush_time >= h->last_refresh);
}

extern int cache_check(struct cache_detail *detail,
		       struct cache_head *h, struct cache_req *rqstp);
extern void cache_flush(void);
extern void cache_purge(struct cache_detail *detail);
#define NEVER (0x7FFFFFFF)
extern void __init cache_initialize(void);
extern int cache_register_net(struct cache_detail *cd, struct net *net);
extern void cache_unregister_net(struct cache_detail *cd, struct net *net);

extern struct cache_detail *cache_create_net(struct cache_detail *tmpl, struct net *net);
extern void cache_destroy_net(struct cache_detail *cd, struct net *net);

extern void sunrpc_init_cache_detail(struct cache_detail *cd);
extern void sunrpc_destroy_cache_detail(struct cache_detail *cd);
extern int sunrpc_cache_register_pipefs(struct dentry *parent, const char *,
					umode_t, struct cache_detail *);
extern void sunrpc_cache_unregister_pipefs(struct cache_detail *);

/* Must store cache_detail in seq_file->private if using next three functions */
extern void *cache_seq_start(struct seq_file *file, loff_t *pos);
extern void *cache_seq_next(struct seq_file *file, void *p, loff_t *pos);
extern void cache_seq_stop(struct seq_file *file, void *p);

extern void qword_add(char **bpp, int *lp, char *str);
extern void qword_addhex(char **bpp, int *lp, char *buf, int blen);
extern int qword_get(char **bpp, char *dest, int bufsize);

static inline int get_int(char **bpp, int *anint)
{
	char buf[50];
	char *ep;
	int rv;
	int len = qword_get(bpp, buf, sizeof(buf));

	if (len < 0)
		return -EINVAL;
	if (len == 0)
		return -ENOENT;

	rv = simple_strtol(buf, &ep, 0);
	if (*ep)
		return -EINVAL;

	*anint = rv;
	return 0;
}

static inline int get_uint(char **bpp, unsigned int *anint)
{
	char buf[50];
	int len = qword_get(bpp, buf, sizeof(buf));

	if (len < 0)
		return -EINVAL;
	if (len == 0)
		return -ENOENT;

	if (kstrtouint(buf, 0, anint))
		return -EINVAL;

	return 0;
}

static inline int get_time(char **bpp, time_t *time)
{
	char buf[50];
	long long ll;
	int len = qword_get(bpp, buf, sizeof(buf));

	if (len < 0)
		return -EINVAL;
	if (len == 0)
		return -ENOENT;

	if (kstrtoll(buf, 0, &ll))
		return -EINVAL;

	*time = (time_t)ll;
	return 0;
}

static inline time_t get_expiry(char **bpp)
{
	time_t rv;
	struct timespec boot;

	if (get_time(bpp, &rv))
		return 0;
	if (rv < 0)
		return 0;
	getboottime(&boot);
	return rv - boot.tv_sec;
}

#endif /*  _LINUX_SUNRPC_CACHE_H_ */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* include/linux/sunrpc/cache.h
	3	*
	4	* Generic code for various authentication-related caches
	5	* used by sunrpc clients and servers.
	6	*
	7	* Copyright (C) 2002 Neil Brown <neilb@cse.unsw.edu.au>
	8	*
	9	* Released under terms in GPL version 2. See COPYING.
	10	*
	11	*/
	12
	13	#ifndef _LINUX_SUNRPC_CACHE_H_
	14	#define _LINUX_SUNRPC_CACHE_H_
	15
57cc7215	16	#include <linux/kref.h>
1da177e4	17	#include <linux/slab.h>
60063497	18	#include <linux/atomic.h>
1da177e4 LT	19	#include <linux/proc_fs.h>
	20
	21	/*
	22	* Each cache requires:
	23	* - A 'struct cache_detail' which contains information specific to the cache
	24	* for common code to use.
	25	* - An item structure that must contain a "struct cache_head"
	26	* - A lookup function defined using DefineCacheLookup
	27	* - A 'put' function that can release a cache item. It will only
	28	* be called after cache_put has succeed, so there are guarantee
	29	* to be no references.
	30	* - A function to calculate a hash of an item's key.
	31	*
	32	* as well as assorted code fragments (e.g. compare keys) and numbers
	33	* (e.g. hash size, goal_age, etc).
	34	*
	35	* Each cache must be registered so that it can be cleaned regularly.
	36	* When the cache is unregistered, it is flushed completely.
	37	*
25985edc	38	* Entries have a ref count and a 'hashed' flag which counts the existence
1da177e4 LT	39	* in the hash table.
1da177e4 LT	40	* We only expire entries when refcount is zero.
25985edc	41	* Existence in the cache is counted the refcount.
1da177e4 LT	42	*/
	43
	44	/* Every cache item has a common header that is used
	45	* for expiring and refreshing entries.
	46	*
	47	*/
	48	struct cache_head {
129e5824	49	struct hlist_node cache_list;
1da177e4	50	time_t expiry_time; /* After time time, don't use the data */
77862036 NB	51	time_t last_refresh; /* If CACHE_PENDING, this is when upcall was
	52	* sent, else this is when update was
	53	* received, though it is alway set to
	54	* be after ->flush_time.
1da177e4	55	*/
baab935f	56	struct kref ref;
1da177e4 LT	57	unsigned long flags;
	58	};
	59	#define CACHE_VALID 0 /* Entry contains valid data */
	60	#define CACHE_NEGATIVE 1 /* Negative entry - there is no match for the key */
	61	#define CACHE_PENDING 2 /* An upcall has been sent but no reply received yet*/
013920eb	62	#define CACHE_CLEANED 3 /* Entry has been cleaned from cache */
1da177e4 LT	63
	64	#define CACHE_NEW_EXPIRY 120 /* keep new things pending confirmation for 120 seconds */
	65
173912a6 TM	66	struct cache_detail_procfs {
	67	struct proc_dir_entry *proc_ent;
	68	struct proc_dir_entry flush_ent, channel_ent, *content_ent;
	69	};
	70
8854e82d TM	71	struct cache_detail_pipefs {
	72	struct dentry *dir;
	73	};
	74
1da177e4	75	struct cache_detail {
f35279d3	76	struct module * owner;
1da177e4	77	int hash_size;
129e5824	78	struct hlist_head * hash_table;
1da177e4 LT	79	rwlock_t hash_lock;
	80
	81	atomic_t inuse; /* active user-space update or lookup */
	82
	83	char *name;
baab935f	84	void (cache_put)(struct kref );
1da177e4	85
bc74b4f5 TM	86	int (cache_upcall)(struct cache_detail ,
	87	struct cache_head *);
	88
73fb847a SK	89	void (cache_request)(struct cache_detail cd,
	90	struct cache_head *ch,
	91	char *bpp, int blen);
	92
1da177e4 LT	93	int (cache_parse)(struct cache_detail ,
	94	char *buf, int len);
	95
	96	int (cache_show)(struct seq_file m,
	97	struct cache_detail *cd,
	98	struct cache_head *h);
2da8ca26 TM	99	void (warn_no_listener)(struct cache_detail cd,
2da8ca26 TM	100	int has_died);
1da177e4	101
15a5f6bd N	102	struct cache_head * (*alloc)(void);
	103	int (match)(struct cache_head orig, struct cache_head *new);
	104	void (init)(struct cache_head orig, struct cache_head *new);
	105	void (update)(struct cache_head orig, struct cache_head *new);
	106
1da177e4 LT	107	/* fields below this comment are for internal use
	108	* and should not be touched by cache owners
	109	*/
77862036 NB	110	time_t flush_time; /* flush all cache items with
	111	* last_refresh at or earlier
	112	* than this. last_refresh
	113	* is never set at or earlier
	114	* than this.
	115	*/
1da177e4 LT	116	struct list_head others;
	117	time_t nextcheck;
	118	int entries;
	119
	120	/* fields for communication over channel */
	121	struct list_head queue;
1da177e4 LT	122
	123	atomic_t readers; /* how many time is /chennel open */
	124	time_t last_close; /* if no readers, when did last close */
	125	time_t last_warn; /* when we last warned about no readers */
173912a6 TM	126
	127	union {
	128	struct cache_detail_procfs procfs;
8854e82d	129	struct cache_detail_pipefs pipefs;
173912a6	130	} u;
0a402d5a	131	struct net *net;
1da177e4 LT	132	};
	133
	134
	135	/* this must be embedded in any request structure that
	136	* identifies an object that will want a callback on
	137	* a cache fill
	138	*/
	139	struct cache_req {
	140	struct cache_deferred_req (defer)(struct cache_req *req);
f16b6e8d N	141	int thread_wait; /* How long (jiffies) we can block the
	142	* current thread to wait for updates.
	143	*/
1da177e4 LT	144	};
	145	/* this must be embedded in a deferred_request that is being
	146	* delayed awaiting cache-fill
	147	*/
	148	struct cache_deferred_req {
11174492	149	struct hlist_node hash; /* on hash chain */
1da177e4 LT	150	struct list_head recent; /* on fifo */
1da177e4 LT	151	struct cache_head item; / cache item we wait on */
1da177e4 LT	152	void owner; / we might need to discard all defered requests
	153	* owned by someone */
	154	void (revisit)(struct cache_deferred_req req,
	155	int too_many);
	156	};
	157
7715cde8 N	158	/*
	159	* timestamps kept in the cache are expressed in seconds
	160	* since boot. This is the best for measuring differences in
	161	* real time.
	162	*/
	163	static inline time_t seconds_since_boot(void)
	164	{
	165	struct timespec boot;
	166	getboottime(&boot);
	167	return get_seconds() - boot.tv_sec;
	168	}
	169
	170	static inline time_t convert_to_wallclock(time_t sinceboot)
	171	{
	172	struct timespec boot;
	173	getboottime(&boot);
	174	return boot.tv_sec + sinceboot;
	175	}
7d317f2c	176
8854e82d TM	177	extern const struct file_operations cache_file_operations_pipefs;
	178	extern const struct file_operations content_file_operations_pipefs;
	179	extern const struct file_operations cache_flush_operations_pipefs;
	180
15a5f6bd N	181	extern struct cache_head *
	182	sunrpc_cache_lookup(struct cache_detail *detail,
	183	struct cache_head *key, int hash);
	184	extern struct cache_head *
	185	sunrpc_cache_update(struct cache_detail *detail,
	186	struct cache_head new, struct cache_head old, int hash);
	187
bc74b4f5	188	extern int
21cd1254	189	sunrpc_cache_pipe_upcall(struct cache_detail detail, struct cache_head h);
bc74b4f5	190
1da177e4	191
1da177e4 LT	192	extern void cache_clean_deferred(void *owner);
	193
	194	static inline struct cache_head cache_get(struct cache_head h)
	195	{
baab935f	196	kref_get(&h->ref);
1da177e4 LT	197	return h;
	198	}
	199
	200
baab935f	201	static inline void cache_put(struct cache_head h, struct cache_detail cd)
1da177e4	202	{
baab935f	203	if (atomic_read(&h->ref.refcount) <= 2 &&
1da177e4 LT	204	h->expiry_time < cd->nextcheck)
1da177e4 LT	205	cd->nextcheck = h->expiry_time;
baab935f	206	kref_put(&h->ref, cd->cache_put);
1da177e4 LT	207	}
1da177e4 LT	208
7715cde8	209	static inline int cache_is_expired(struct cache_detail detail, struct cache_head h)
7b2b1fee	210	{
7715cde8	211	return (h->expiry_time < seconds_since_boot()) \|\|
77862036	212	(detail->flush_time >= h->last_refresh);
7b2b1fee GB	213	}
7b2b1fee GB	214
1da177e4 LT	215	extern int cache_check(struct cache_detail *detail,
	216	struct cache_head h, struct cache_req rqstp);
	217	extern void cache_flush(void);
	218	extern void cache_purge(struct cache_detail *detail);
	219	#define NEVER (0x7FFFFFFF)
8eab945c	220	extern void __init cache_initialize(void);
593ce16b	221	extern int cache_register_net(struct cache_detail cd, struct net net);
593ce16b	222	extern void cache_unregister_net(struct cache_detail cd, struct net net);
1da177e4	223
0a402d5a SK	224	extern struct cache_detail cache_create_net(struct cache_detail tmpl, struct net *net);
	225	extern void cache_destroy_net(struct cache_detail cd, struct net net);
	226
820f9442 SK	227	extern void sunrpc_init_cache_detail(struct cache_detail *cd);
820f9442 SK	228	extern void sunrpc_destroy_cache_detail(struct cache_detail *cd);
8854e82d	229	extern int sunrpc_cache_register_pipefs(struct dentry parent, const char ,
64f1426f	230	umode_t, struct cache_detail *);
8854e82d TM	231	extern void sunrpc_cache_unregister_pipefs(struct cache_detail *);
8854e82d TM	232
c8c081b7 KM	233	/* Must store cache_detail in seq_file->private if using next three functions */
	234	extern void cache_seq_start(struct seq_file file, loff_t *pos);
	235	extern void cache_seq_next(struct seq_file file, void p, loff_t pos);
	236	extern void cache_seq_stop(struct seq_file file, void p);
	237
1da177e4 LT	238	extern void qword_add(char *bpp, int lp, char *str);
	239	extern void qword_addhex(char *bpp, int lp, char *buf, int blen);
	240	extern int qword_get(char *bpp, char dest, int bufsize);
	241
	242	static inline int get_int(char *bpp, int anint)
	243	{
	244	char buf[50];
621eb19c BF	245	char *ep;
621eb19c BF	246	int rv;
d9c2ede6 EZ	247	int len = qword_get(bpp, buf, sizeof(buf));
	248
	249	if (len < 0)
	250	return -EINVAL;
	251	if (len == 0)
	252	return -ENOENT;
	253
621eb19c BF	254	rv = simple_strtol(buf, &ep, 0);
621eb19c BF	255	if (*ep)
d9c2ede6 EZ	256	return -EINVAL;
d9c2ede6 EZ	257
621eb19c	258	*anint = rv;
1da177e4 LT	259	return 0;
	260	}
	261
a007c4c3 BF	262	static inline int get_uint(char *bpp, unsigned int anint)
	263	{
	264	char buf[50];
	265	int len = qword_get(bpp, buf, sizeof(buf));
	266
	267	if (len < 0)
	268	return -EINVAL;
	269	if (len == 0)
	270	return -ENOENT;
	271
	272	if (kstrtouint(buf, 0, anint))
	273	return -EINVAL;
	274
	275	return 0;
	276	}
	277
2f74f972 HJ	278	static inline int get_time(char *bpp, time_t time)
	279	{
	280	char buf[50];
	281	long long ll;
	282	int len = qword_get(bpp, buf, sizeof(buf));
	283
	284	if (len < 0)
	285	return -EINVAL;
	286	if (len == 0)
	287	return -ENOENT;
	288
	289	if (kstrtoll(buf, 0, &ll))
	290	return -EINVAL;
	291
	292	*time = (time_t)ll;
	293	return 0;
	294	}
	295
1da177e4 LT	296	static inline time_t get_expiry(char **bpp)
1da177e4 LT	297	{
2f74f972	298	time_t rv;
c5b29f88 N	299	struct timespec boot;
c5b29f88 N	300
2f74f972	301	if (get_time(bpp, &rv))
1da177e4 LT	302	return 0;
	303	if (rv < 0)
	304	return 0;
c5b29f88 N	305	getboottime(&boot);
c5b29f88 N	306	return rv - boot.tv_sec;
1da177e4 LT	307	}
	308
	309	#endif /* _LINUX_SUNRPC_CACHE_H_ */