blob: f8c6df8649dce05b7a9269e1968557e902a50046 [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;
32 unsigned long c_timestamp;
33 union {
34 struct kvec u_vec;
Al Viroc7afef12006-10-19 23:29:02 -070035 __be32 u_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 } c_u;
37};
38
39#define c_replvec c_u.u_vec
40#define c_replstat c_u.u_status
41
42/* cache entry states */
43enum {
44 RC_UNUSED,
45 RC_INPROG,
46 RC_DONE
47};
48
49/* return values */
50enum {
51 RC_DROPIT,
52 RC_REPLY,
Jeff Layton09662d52013-01-28 14:41:09 -050053 RC_DOIT
Linus Torvalds1da177e2005-04-16 15:20:36 -070054};
55
56/*
57 * Cache types.
58 * We may want to add more types one day, e.g. for diropres and
59 * attrstat replies. Using cache entries with fixed length instead
60 * of buffer pointers may be more efficient.
61 */
62enum {
63 RC_NOCACHE,
64 RC_REPLSTAT,
65 RC_REPLBUFF,
66};
67
68/*
69 * If requests are retransmitted within this interval, they're dropped.
70 */
71#define RC_DELAY (HZ/5)
72
J. Bruce Fieldsd5c34282007-11-09 14:10:56 -050073int nfsd_reply_cache_init(void);
74void nfsd_reply_cache_shutdown(void);
J. Bruce Fields10910062011-01-24 12:11:02 -050075int nfsd_cache_lookup(struct svc_rqst *);
Al Viroc7afef12006-10-19 23:29:02 -070076void nfsd_cache_update(struct svc_rqst *, int, __be32 *);
Benny Halevy04826f42009-04-06 12:00:49 +030077
78#ifdef CONFIG_NFSD_V4
Andy Adamson074fe892009-04-03 08:28:15 +030079void nfsd4_set_statp(struct svc_rqst *rqstp, __be32 *statp);
Benny Halevy04826f42009-04-06 12:00:49 +030080#else /* CONFIG_NFSD_V4 */
81static inline void nfsd4_set_statp(struct svc_rqst *rqstp, __be32 *statp)
82{
83}
84#endif /* CONFIG_NFSD_V4 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Linus Torvalds1da177e2005-04-16 15:20:36 -070086#endif /* NFSCACHE_H */