blob: b582f9ab6b2a9a492a31abc60625ec56ab5d3912 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * Request reply cache. This was heavily inspired by the
3 * implementation in 4.3BSD/4.4BSD.
4 *
5 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
6 */
7
8#ifndef NFSCACHE_H
9#define NFSCACHE_H
10
Boaz Harrosh72579ac2009-12-03 20:28:59 +020011#include <linux/sunrpc/svc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012
13/*
Greg Banksfca42172009-04-01 07:28:13 +110014 * Representation of a reply cache entry.
Jeff Layton7b9e8522013-01-28 14:41:07 -050015 *
16 * Note that we use a sockaddr_in6 to hold the address instead of the more
17 * typical sockaddr_storage. This is for space reasons, since sockaddr_storage
18 * is much larger than a sockaddr_in6.
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 */
20struct svc_cacherep {
21 struct hlist_node c_hash;
22 struct list_head c_lru;
23
24 unsigned char c_state, /* unused, inprog, done */
25 c_type, /* status, buffer */
26 c_secure : 1; /* req came from port < 1024 */
Jeff Layton7b9e8522013-01-28 14:41:07 -050027 struct sockaddr_in6 c_addr;
Al Viroc7afef12006-10-19 23:29:02 -070028 __be32 c_xid;
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 u32 c_prot;
30 u32 c_proc;
31 u32 c_vers;
Jeff Layton01a7dec2013-02-04 11:57:27 -050032 unsigned int c_len;
33 __wsum c_csum;
Linus Torvalds1da177e2005-04-16 15:20:36 -070034 unsigned long c_timestamp;
35 union {
36 struct kvec u_vec;
Al Viroc7afef12006-10-19 23:29:02 -070037 __be32 u_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 } c_u;
39};
40
41#define c_replvec c_u.u_vec
42#define c_replstat c_u.u_status
43
44/* cache entry states */
45enum {
46 RC_UNUSED,
47 RC_INPROG,
48 RC_DONE
49};
50
51/* return values */
52enum {
53 RC_DROPIT,
54 RC_REPLY,
Jeff Layton09662d52013-01-28 14:41:09 -050055 RC_DOIT
Linus Torvalds1da177e2005-04-16 15:20:36 -070056};
57
58/*
59 * Cache types.
60 * We may want to add more types one day, e.g. for diropres and
61 * attrstat replies. Using cache entries with fixed length instead
62 * of buffer pointers may be more efficient.
63 */
64enum {
65 RC_NOCACHE,
66 RC_REPLSTAT,
67 RC_REPLBUFF,
68};
69
70/*
71 * If requests are retransmitted within this interval, they're dropped.
72 */
73#define RC_DELAY (HZ/5)
74
Jeff Laytond1a07742013-01-28 14:41:13 -050075/* Cache entries expire after this time period */
76#define RC_EXPIRE (120 * HZ)
77
Jeff Layton01a7dec2013-02-04 11:57:27 -050078/* Checksum this amount of the request */
79#define RC_CSUMLEN (256U)
80
J. Bruce Fieldsd5c34282007-11-09 14:10:56 -050081int nfsd_reply_cache_init(void);
82void nfsd_reply_cache_shutdown(void);
J. Bruce Fields10910062011-01-24 12:11:02 -050083int nfsd_cache_lookup(struct svc_rqst *);
Al Viroc7afef12006-10-19 23:29:02 -070084void nfsd_cache_update(struct svc_rqst *, int, __be32 *);
Jeff Laytona2f999a2013-03-27 10:15:38 -040085int nfsd_reply_cache_stats_open(struct inode *, struct file *);
Benny Halevy04826f42009-04-06 12:00:49 +030086
Linus Torvalds1da177e2005-04-16 15:20:36 -070087#endif /* NFSCACHE_H */