xref: /freebsd/sys/fs/nfs/nfsrvcache.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Rick Macklem at The University of Guelph.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34 
35 #ifndef _NFS_NFSRVCACHE_H_
36 #define	_NFS_NFSRVCACHE_H_
37 
38 /*
39  * Definitions for the server recent request cache
40  */
41 #define	NFSRVCACHE_MAX_SIZE	2048
42 #define	NFSRVCACHE_MIN_SIZE	  64
43 
44 #define	NFSRVCACHE_HASHSIZE	500
45 
46 /* Cache table entry. */
47 struct nfsrvcache {
48 	LIST_ENTRY(nfsrvcache) rc_hash;		/* Hash chain */
49 	LIST_ENTRY(nfsrvcache) rc_ahash;	/* ACK hash chain */
50 	TAILQ_ENTRY(nfsrvcache)	rc_lru;		/* UDP lru chain */
51 	u_int32_t	rc_xid;			/* rpc id number */
52 	time_t		rc_timestamp;		/* Time done */
53 	union {
54 		struct mbuf *repmb;		/* Reply mbuf list OR */
55 		int repstat;			/* Reply status */
56 	} rc_un;
57 	union {
58 		struct {
59 			union nethostaddr haddr; /* Host address */
60 		} udp;
61 		struct {
62 			u_int64_t	sockref;
63 			u_int32_t	len;
64 			u_int32_t	tcpseq;
65 			int16_t		refcnt;
66 			u_int16_t	cksum;
67 			time_t		cachetime;
68 			int		acked;
69 		} ot;
70 	} rc_un2;
71 	u_int16_t	rc_proc;		/* rpc proc number */
72 	u_int16_t	rc_flag;		/* Flag bits */
73 };
74 
75 #define	rc_reply	rc_un.repmb
76 #define	rc_status	rc_un.repstat
77 #define	rc_inet		rc_un2.udp.haddr.had_inet.s_addr
78 #define	rc_inet6	rc_un2.udp.haddr.had_inet6
79 #define	rc_haddr	rc_un2.udp.haddr
80 #define	rc_sockref	rc_un2.ot.sockref
81 #define	rc_tcpseq	rc_un2.ot.tcpseq
82 #define	rc_refcnt	rc_un2.ot.refcnt
83 #define	rc_reqlen	rc_un2.ot.len
84 #define	rc_cksum	rc_un2.ot.cksum
85 #define	rc_cachetime	rc_un2.ot.cachetime
86 #define	rc_acked	rc_un2.ot.acked
87 
88 /* TCP ACK values */
89 #define	RC_NO_SEQ		0
90 #define	RC_NO_ACK		1
91 #define	RC_ACK			2
92 #define	RC_NACK			3
93 
94 /* Return values */
95 #define	RC_DROPIT		0
96 #define	RC_REPLY		1
97 #define	RC_DOIT			2
98 
99 /* Flag bits */
100 #define	RC_LOCKED	0x0001
101 #define	RC_WANTED	0x0002
102 #define	RC_REPSTATUS	0x0004
103 #define	RC_REPMBUF	0x0008
104 #define	RC_UDP		0x0010
105 #define	RC_INETIPV6	0x0020
106 #define	RC_INPROG	0x0040
107 #define	RC_NFSV2	0x0100
108 #define	RC_NFSV3	0x0200
109 #define	RC_NFSV4	0x0400
110 #define	RC_NFSVERS	(RC_NFSV2 | RC_NFSV3 | RC_NFSV4)
111 #define	RC_REFCNT	0x0800
112 #define	RC_SAMETCPCONN	0x1000
113 
114 LIST_HEAD(nfsrvhashhead, nfsrvcache);
115 
116 /* The fine-grained locked cache hash table for TCP. */
117 struct nfsrchash_bucket {
118 	struct mtx		mtx;
119 	struct nfsrvhashhead	tbl;
120 };
121 
122 #endif	/* _NFS_NFSRVCACHE_H_ */
123