1 /*
2 * Copyright (c) 1989, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * This code is derived from software contributed to Berkeley by
6 * Rick Macklem at The University of Guelph.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by the University of
19 * California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 * @(#)nfs_srvcache.c 8.3 (Berkeley) 3/30/95
37 * $FreeBSD$
38 */
39
40 /*
41 * Reference: Chet Juszczak, "Improving the Performance and Correctness
42 * of an NFS Server", in Proc. Winter 1989 USENIX Conference,
43 * pages 53-63. San Diego, February 1989.
44 */
45 #include <sys/param.h>
46 #include <sys/malloc.h>
47 #include <sys/mount.h>
48 #include <sys/systm.h>
49 #include <sys/mbuf.h>
50 #include <sys/socket.h>
51 #include <sys/socketvar.h> /* for dup_sockaddr */
52
53 #include <netinet/in.h>
54 #include <nfs/rpcv2.h>
55 #include <nfs/nfsproto.h>
56 #include <nfs/nfs.h>
57 #include <nfs/nfsrvcache.h>
58
59 #ifndef NFS_NOSERVER
60 extern struct nfsstats nfsstats;
61 extern int nfsv2_procid[NFS_NPROCS];
62 static long numnfsrvcache;
63 static long desirednfsrvcache = NFSRVCACHESIZ;
64
65 #define NFSRCHASH(xid) \
66 (&nfsrvhashtbl[((xid) + ((xid) >> 24)) & nfsrvhash])
67 static LIST_HEAD(nfsrvhash, nfsrvcache) *nfsrvhashtbl;
68 static TAILQ_HEAD(nfsrvlru, nfsrvcache) nfsrvlruhead;
69 static u_long nfsrvhash;
70
71 #define TRUE 1
72 #define FALSE 0
73
74 #define NETFAMILY(rp) \
75 (((rp)->rc_flag & RC_INETADDR) ? AF_INET : AF_ISO)
76
77 /*
78 * Static array that defines which nfs rpc's are nonidempotent
79 */
80 static int nonidempotent[NFS_NPROCS] = {
81 FALSE,
82 FALSE,
83 TRUE,
84 FALSE,
85 FALSE,
86 FALSE,
87 FALSE,
88 TRUE,
89 TRUE,
90 TRUE,
91 TRUE,
92 TRUE,
93 TRUE,
94 TRUE,
95 TRUE,
96 TRUE,
97 FALSE,
98 FALSE,
99 FALSE,
100 FALSE,
101 FALSE,
102 FALSE,
103 FALSE,
104 FALSE,
105 FALSE,
106 FALSE,
107 };
108
109 /* True iff the rpc reply is an nfs status ONLY! */
110 static int nfsv2_repstat[NFS_NPROCS] = {
111 FALSE,
112 FALSE,
113 FALSE,
114 FALSE,
115 FALSE,
116 FALSE,
117 FALSE,
118 FALSE,
119 FALSE,
120 FALSE,
121 TRUE,
122 TRUE,
123 TRUE,
124 TRUE,
125 FALSE,
126 TRUE,
127 FALSE,
128 FALSE,
129 };
130
131 /*
132 * Initialize the server request cache list
133 */
134 void
135 nfsrv_initcache()
136 {
137
138 nfsrvhashtbl = hashinit(desirednfsrvcache, M_NFSD, &nfsrvhash);
139 TAILQ_INIT(&nfsrvlruhead);
140 }
141
142 /*
143 * Look for the request in the cache
144 * If found then
145 * return action and optionally reply
146 * else
147 * insert it in the cache
148 *
149 * The rules are as follows:
150 * - if in progress, return DROP request
151 * - if completed within DELAY of the current time, return DROP it
152 * - if completed a longer time ago return REPLY if the reply was cached or
153 * return DOIT
154 * Update/add new request at end of lru list
155 */
156 int
157 nfsrv_getcache(nd, slp, repp)
158 register struct nfsrv_descript *nd;
159 struct nfssvc_sock *slp;
160 struct mbuf **repp;
161 {
162 register struct nfsrvcache *rp;
163 struct mbuf *mb;
164 struct sockaddr_in *saddr;
165 caddr_t bpos;
166 int ret;
167
168 /*
169 * Don't cache recent requests for reliable transport protocols.
170 * (Maybe we should for the case of a reconnect, but..)
171 */
172 if (!nd->nd_nam2)
173 return (RC_DOIT);
174 loop:
175 for (rp = NFSRCHASH(nd->nd_retxid)->lh_first; rp != 0;
176 rp = rp->rc_hash.le_next) {
177 if (nd->nd_retxid == rp->rc_xid && nd->nd_procnum == rp->rc_proc &&
178 netaddr_match(NETFAMILY(rp), &rp->rc_haddr, nd->nd_nam)) {
179 NFS_DPF(RC, ("H%03x", rp->rc_xid & 0xfff));
180 if ((rp->rc_flag & RC_LOCKED) != 0) {
181 rp->rc_flag |= RC_WANTED;
182 (void) tsleep((caddr_t)rp, PZERO-1, "nfsrc", 0);
183 goto loop;
184 }
185 rp->rc_flag |= RC_LOCKED;
186 /* If not at end of LRU chain, move it there */
187 if (rp->rc_lru.tqe_next) {
188 TAILQ_REMOVE(&nfsrvlruhead, rp, rc_lru);
189 TAILQ_INSERT_TAIL(&nfsrvlruhead, rp, rc_lru);
190 }
191 if (rp->rc_state == RC_UNUSED)
192 panic("nfsrv cache");
193 if (rp->rc_state == RC_INPROG) {
194 nfsstats.srvcache_inproghits++;
195 ret = RC_DROPIT;
196 } else if (rp->rc_flag & RC_REPSTATUS) {
197 nfsstats.srvcache_nonidemdonehits++;
198 nfs_rephead(0, nd, slp, rp->rc_status,
199 0, (u_quad_t *)0, repp, &mb, &bpos);
200 ret = RC_REPLY;
201 } else if (rp->rc_flag & RC_REPMBUF) {
202 nfsstats.srvcache_nonidemdonehits++;
203 *repp = m_copym(rp->rc_reply, 0, M_COPYALL,
204 M_WAIT);
205 ret = RC_REPLY;
206 } else {
207 nfsstats.srvcache_idemdonehits++;
208 rp->rc_state = RC_INPROG;
209 ret = RC_DOIT;
210 }
211 rp->rc_flag &= ~RC_LOCKED;
212 if (rp->rc_flag & RC_WANTED) {
213 rp->rc_flag &= ~RC_WANTED;
214 wakeup((caddr_t)rp);
215 }
216 return (ret);
217 }
218 }
219 nfsstats.srvcache_misses++;
220 NFS_DPF(RC, ("M%03x", nd->nd_retxid & 0xfff));
221 if (numnfsrvcache < desirednfsrvcache) {
222 rp = (struct nfsrvcache *)malloc((u_long)sizeof *rp,
223 M_NFSD, M_WAITOK);
224 bzero((char *)rp, sizeof *rp);
225 numnfsrvcache++;
226 rp->rc_flag = RC_LOCKED;
227 } else {
228 rp = nfsrvlruhead.tqh_first;
229 while ((rp->rc_flag & RC_LOCKED) != 0) {
230 rp->rc_flag |= RC_WANTED;
231 (void) tsleep((caddr_t)rp, PZERO-1, "nfsrc", 0);
232 rp = nfsrvlruhead.tqh_first;
233 }
234 rp->rc_flag |= RC_LOCKED;
235 LIST_REMOVE(rp, rc_hash);
236 TAILQ_REMOVE(&nfsrvlruhead, rp, rc_lru);
237 if (rp->rc_flag & RC_REPMBUF)
238 m_freem(rp->rc_reply);
239 if (rp->rc_flag & RC_NAM)
240 FREE(rp->rc_nam, M_SONAME);
241 rp->rc_flag &= (RC_LOCKED | RC_WANTED);
242 }
243 TAILQ_INSERT_TAIL(&nfsrvlruhead, rp, rc_lru);
244 rp->rc_state = RC_INPROG;
245 rp->rc_xid = nd->nd_retxid;
246 saddr = (struct sockaddr_in *)nd->nd_nam;
247 switch (saddr->sin_family) {
248 case AF_INET:
249 rp->rc_flag |= RC_INETADDR;
250 rp->rc_inetaddr = saddr->sin_addr.s_addr;
251 break;
252 case AF_ISO:
253 default:
254 rp->rc_flag |= RC_NAM;
255 rp->rc_nam = dup_sockaddr(nd->nd_nam, 1);
256 break;
257 };
258 rp->rc_proc = nd->nd_procnum;
259 LIST_INSERT_HEAD(NFSRCHASH(nd->nd_retxid), rp, rc_hash);
260 rp->rc_flag &= ~RC_LOCKED;
261 if (rp->rc_flag & RC_WANTED) {
262 rp->rc_flag &= ~RC_WANTED;
263 wakeup((caddr_t)rp);
264 }
265 return (RC_DOIT);
266 }
267
268 /*
269 * Update a request cache entry after the rpc has been done
270 */
271 void
272 nfsrv_updatecache(nd, repvalid, repmbuf)
273 register struct nfsrv_descript *nd;
274 int repvalid;
275 struct mbuf *repmbuf;
276 {
277 register struct nfsrvcache *rp;
278
279 if (!nd->nd_nam2)
280 return;
281 loop:
282 for (rp = NFSRCHASH(nd->nd_retxid)->lh_first; rp != 0;
283 rp = rp->rc_hash.le_next) {
284 if (nd->nd_retxid == rp->rc_xid && nd->nd_procnum == rp->rc_proc &&
285 netaddr_match(NETFAMILY(rp), &rp->rc_haddr, nd->nd_nam)) {
286 NFS_DPF(RC, ("U%03x", rp->rc_xid & 0xfff));
287 if ((rp->rc_flag & RC_LOCKED) != 0) {
288 rp->rc_flag |= RC_WANTED;
289 (void) tsleep((caddr_t)rp, PZERO-1, "nfsrc", 0);
290 goto loop;
291 }
292 rp->rc_flag |= RC_LOCKED;
293 if (rp->rc_state == RC_DONE) {
294 /*
295 * This can occur if the cache is too small.
296 * Retransmits of the same request aren't
297 * dropped so we may see the operation
298 * complete more then once.
299 */
300 if (rp->rc_flag & RC_REPMBUF) {
301 m_freem(rp->rc_reply);
302 rp->rc_flag &= ~RC_REPMBUF;
303 }
304 }
305 rp->rc_state = RC_DONE;
306 /*
307 * If we have a valid reply update status and save
308 * the reply for non-idempotent rpc's.
309 */
310 if (repvalid && nonidempotent[nd->nd_procnum]) {
311 if ((nd->nd_flag & ND_NFSV3) == 0 &&
312 nfsv2_repstat[nfsv2_procid[nd->nd_procnum]]) {
313 rp->rc_status = nd->nd_repstat;
314 rp->rc_flag |= RC_REPSTATUS;
315 } else {
316 rp->rc_reply = m_copym(repmbuf,
317 0, M_COPYALL, M_WAIT);
318 rp->rc_flag |= RC_REPMBUF;
319 }
320 }
321 rp->rc_flag &= ~RC_LOCKED;
322 if (rp->rc_flag & RC_WANTED) {
323 rp->rc_flag &= ~RC_WANTED;
324 wakeup((caddr_t)rp);
325 }
326 return;
327 }
328 }
329 NFS_DPF(RC, ("L%03x", nd->nd_retxid & 0xfff));
330 }
331
332 /*
333 * Clean out the cache. Called when the last nfsd terminates.
334 */
335 void
336 nfsrv_cleancache()
337 {
338 register struct nfsrvcache *rp, *nextrp;
339
340 for (rp = nfsrvlruhead.tqh_first; rp != 0; rp = nextrp) {
341 nextrp = rp->rc_lru.tqe_next;
342 LIST_REMOVE(rp, rc_hash);
343 TAILQ_REMOVE(&nfsrvlruhead, rp, rc_lru);
344 if (rp->rc_flag & RC_REPMBUF)
345 m_freem(rp->rc_reply);
346 if (rp->rc_flag & RC_NAM)
347 free(rp->rc_nam, M_SONAME);
348 free(rp, M_NFSD);
349 }
350 numnfsrvcache = 0;
351 }
352
353 #endif /* NFS_NOSERVER */
Cache object: 53e412ab079cd738129ed5a4d528ac98
|