1 /* $NetBSD: svc_dg.c,v 1.4 2000/07/06 03:10:35 christos Exp $ */
4 * Copyright (c) 2009, Sun Microsystems, Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 * - Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 * - Neither the name of Sun Microsystems, Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived
16 * from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
32 * Copyright (c) 1986-1991 by Sun Microsystems Inc.
35 #if defined(LIBC_SCCS) && !defined(lint)
36 #ident "@(#)svc_dg.c 1.17 94/04/24 SMI"
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
42 * svc_dg.c, Server side for connectionless RPC.
44 * Does some caching in the hopes of achieving execute-at-most-once semantics.
47 #include "namespace.h"
48 #include "reentrant.h"
49 #include <sys/types.h>
50 #include <sys/socket.h>
52 #include <rpc/svc_dg.h>
59 #ifdef RPC_CACHE_DEBUG
60 #include <netconfig.h>
64 #include "un-namespace.h"
69 #define su_data(xprt) ((struct svc_dg_data *)(xprt->xp_p2))
70 #define rpc_buffer(xprt) ((xprt)->xp_p1)
73 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
76 static void svc_dg_ops(SVCXPRT *);
77 static enum xprt_stat svc_dg_stat(SVCXPRT *);
78 static bool_t svc_dg_recv(SVCXPRT *, struct rpc_msg *);
79 static bool_t svc_dg_reply(SVCXPRT *, struct rpc_msg *);
80 static bool_t svc_dg_getargs(SVCXPRT *, xdrproc_t, void *);
81 static bool_t svc_dg_freeargs(SVCXPRT *, xdrproc_t, void *);
82 static void svc_dg_destroy(SVCXPRT *);
83 static bool_t svc_dg_control(SVCXPRT *, const u_int, void *);
84 static int cache_get(SVCXPRT *, struct rpc_msg *, char **, size_t *);
85 static void cache_set(SVCXPRT *, size_t);
86 int svc_dg_enablecache(SVCXPRT *, u_int);
90 * xprt = svc_dg_create(sock, sendsize, recvsize);
91 * Does other connectionless specific initializations.
92 * Once *xprt is initialized, it is registered.
93 * see (svc.h, xprt_register). If recvsize or sendsize are 0 suitable
94 * system defaults are chosen.
95 * The routines returns NULL if a problem occurred.
97 static const char svc_dg_str[] = "svc_dg_create: %s";
98 static const char svc_dg_err1[] = "could not get transport information";
99 static const char svc_dg_err2[] = "transport does not support data transfer";
100 static const char svc_dg_err3[] = "getsockname failed";
101 static const char svc_dg_err4[] = "cannot set IP_RECVDSTADDR";
102 static const char __no_mem_str[] = "out of memory";
105 svc_dg_create(fd, sendsize, recvsize)
111 struct svc_dg_data *su = NULL;
112 struct __rpc_sockinfo si;
113 struct sockaddr_storage ss;
116 if (!__rpc_fd2sockinfo(fd, &si)) {
117 warnx(svc_dg_str, svc_dg_err1);
121 * Find the receive and the send size
123 sendsize = __rpc_get_t_size(si.si_af, si.si_proto, (int)sendsize);
124 recvsize = __rpc_get_t_size(si.si_af, si.si_proto, (int)recvsize);
125 if ((sendsize == 0) || (recvsize == 0)) {
126 warnx(svc_dg_str, svc_dg_err2);
130 xprt = svc_xprt_alloc();
134 su = mem_alloc(sizeof (*su));
137 su->su_iosz = ((MAX(sendsize, recvsize) + 3) / 4) * 4;
138 if ((rpc_buffer(xprt) = mem_alloc(su->su_iosz)) == NULL)
140 xdrmem_create(&(su->su_xdrs), rpc_buffer(xprt), su->su_iosz,
145 xprt->xp_verf.oa_base = su->su_verfbody;
147 xprt->xp_rtaddr.maxlen = sizeof (struct sockaddr_storage);
150 if (_getsockname(fd, (struct sockaddr *)(void *)&ss, &slen) < 0) {
151 warnx(svc_dg_str, svc_dg_err3);
152 goto freedata_nowarn;
154 xprt->xp_ltaddr.buf = mem_alloc(sizeof (struct sockaddr_storage));
155 xprt->xp_ltaddr.maxlen = sizeof (struct sockaddr_storage);
156 xprt->xp_ltaddr.len = slen;
157 memcpy(xprt->xp_ltaddr.buf, &ss, slen);
159 if (ss.ss_family == AF_INET) {
160 struct sockaddr_in *sin;
161 static const int true_value = 1;
163 sin = (struct sockaddr_in *)(void *)&ss;
164 if (sin->sin_addr.s_addr == INADDR_ANY) {
165 su->su_srcaddr.buf = mem_alloc(sizeof (ss));
166 su->su_srcaddr.maxlen = sizeof (ss);
168 if (_setsockopt(fd, IPPROTO_IP, IP_RECVDSTADDR,
169 &true_value, sizeof(true_value))) {
170 warnx(svc_dg_str, svc_dg_err4);
171 goto freedata_nowarn;
179 (void) warnx(svc_dg_str, __no_mem_str);
183 (void) mem_free(su, sizeof (*su));
190 static enum xprt_stat
198 svc_dg_recvfrom(int fd, char *buf, int buflen,
199 struct sockaddr *raddr, socklen_t *raddrlen,
200 struct sockaddr *laddr, socklen_t *laddrlen)
203 struct iovec msg_iov[1];
204 struct sockaddr_in *lin = (struct sockaddr_in *)laddr;
206 bool_t have_lin = FALSE;
207 char tmp[CMSG_LEN(sizeof(*lin))];
208 struct cmsghdr *cmsg;
210 memset((char *)&msg, 0, sizeof(msg));
211 msg_iov[0].iov_base = buf;
212 msg_iov[0].iov_len = buflen;
213 msg.msg_iov = msg_iov;
215 msg.msg_namelen = *raddrlen;
216 msg.msg_name = (char *)raddr;
218 msg.msg_control = (caddr_t)tmp;
219 msg.msg_controllen = CMSG_LEN(sizeof(*lin));
221 rlen = _recvmsg(fd, &msg, 0);
223 *raddrlen = msg.msg_namelen;
225 if (rlen == -1 || laddr == NULL ||
226 msg.msg_controllen < sizeof(struct cmsghdr) ||
227 msg.msg_flags & MSG_CTRUNC)
230 for (cmsg = CMSG_FIRSTHDR(&msg); cmsg != NULL;
231 cmsg = CMSG_NXTHDR(&msg, cmsg)) {
232 if (cmsg->cmsg_level == IPPROTO_IP &&
233 cmsg->cmsg_type == IP_RECVDSTADDR) {
235 memcpy(&lin->sin_addr,
236 (struct in_addr *)CMSG_DATA(cmsg),
237 sizeof(struct in_addr));
242 lin->sin_family = AF_INET;
244 *laddrlen = sizeof(struct sockaddr_in);
247 lin->sin_addr.s_addr = INADDR_ANY;
253 svc_dg_recv(xprt, msg)
257 struct svc_dg_data *su = su_data(xprt);
258 XDR *xdrs = &(su->su_xdrs);
260 struct sockaddr_storage ss;
266 alen = sizeof (struct sockaddr_storage);
267 rlen = svc_dg_recvfrom(xprt->xp_fd, rpc_buffer(xprt), su->su_iosz,
268 (struct sockaddr *)(void *)&ss, &alen,
269 (struct sockaddr *)su->su_srcaddr.buf, &su->su_srcaddr.len);
270 if (rlen == -1 && errno == EINTR)
272 if (rlen == -1 || (rlen < (ssize_t)(4 * sizeof (u_int32_t))))
274 if (xprt->xp_rtaddr.len < alen) {
275 if (xprt->xp_rtaddr.len != 0)
276 mem_free(xprt->xp_rtaddr.buf, xprt->xp_rtaddr.len);
277 xprt->xp_rtaddr.buf = mem_alloc(alen);
278 xprt->xp_rtaddr.len = alen;
280 memcpy(xprt->xp_rtaddr.buf, &ss, alen);
282 if (ss.ss_family == AF_INET) {
283 xprt->xp_raddr = *(struct sockaddr_in *)xprt->xp_rtaddr.buf;
284 xprt->xp_addrlen = sizeof (struct sockaddr_in);
287 xdrs->x_op = XDR_DECODE;
289 if (! xdr_callmsg(xdrs, msg)) {
292 su->su_xid = msg->rm_xid;
293 if (su->su_cache != NULL) {
294 if (cache_get(xprt, msg, &reply, &replylen)) {
295 (void)_sendto(xprt->xp_fd, reply, replylen, 0,
296 (struct sockaddr *)(void *)&ss, alen);
304 svc_dg_sendto(int fd, char *buf, int buflen,
305 const struct sockaddr *raddr, socklen_t raddrlen,
306 const struct sockaddr *laddr, socklen_t laddrlen)
309 struct iovec msg_iov[1];
310 struct sockaddr_in *laddr_in = (struct sockaddr_in *)laddr;
311 struct in_addr *lin = &laddr_in->sin_addr;
312 char tmp[CMSG_SPACE(sizeof(*lin))];
313 struct cmsghdr *cmsg;
315 memset((char *)&msg, 0, sizeof(msg));
316 msg_iov[0].iov_base = buf;
317 msg_iov[0].iov_len = buflen;
318 msg.msg_iov = msg_iov;
320 msg.msg_namelen = raddrlen;
321 msg.msg_name = (char *)raddr;
323 if (laddr != NULL && laddr->sa_family == AF_INET &&
324 lin->s_addr != INADDR_ANY) {
325 msg.msg_control = (caddr_t)tmp;
326 msg.msg_controllen = CMSG_LEN(sizeof(*lin));
327 cmsg = CMSG_FIRSTHDR(&msg);
328 cmsg->cmsg_len = CMSG_LEN(sizeof(*lin));
329 cmsg->cmsg_level = IPPROTO_IP;
330 cmsg->cmsg_type = IP_SENDSRCADDR;
331 memcpy(CMSG_DATA(cmsg), lin, sizeof(*lin));
334 return _sendmsg(fd, &msg, 0);
338 svc_dg_reply(xprt, msg)
342 struct svc_dg_data *su = su_data(xprt);
343 XDR *xdrs = &(su->su_xdrs);
349 xdrs->x_op = XDR_ENCODE;
351 msg->rm_xid = su->su_xid;
352 if (msg->rm_reply.rp_stat == MSG_ACCEPTED &&
353 msg->rm_reply.rp_acpt.ar_stat == SUCCESS) {
354 xdr_proc = msg->acpted_rply.ar_results.proc;
355 xdr_where = msg->acpted_rply.ar_results.where;
356 msg->acpted_rply.ar_results.proc = (xdrproc_t) xdr_void;
357 msg->acpted_rply.ar_results.where = NULL;
359 if (!xdr_replymsg(xdrs, msg) ||
360 !SVCAUTH_WRAP(&SVC_AUTH(xprt), xdrs, xdr_proc, xdr_where))
363 stat = xdr_replymsg(xdrs, msg);
366 slen = XDR_GETPOS(xdrs);
367 if (svc_dg_sendto(xprt->xp_fd, rpc_buffer(xprt), slen,
368 (struct sockaddr *)xprt->xp_rtaddr.buf,
369 (socklen_t)xprt->xp_rtaddr.len,
370 (struct sockaddr *)su->su_srcaddr.buf,
371 (socklen_t)su->su_srcaddr.len) == (ssize_t) slen) {
374 cache_set(xprt, slen);
381 svc_dg_getargs(xprt, xdr_args, args_ptr)
386 struct svc_dg_data *su;
388 assert(xprt != NULL);
390 return (SVCAUTH_UNWRAP(&SVC_AUTH(xprt),
391 &su->su_xdrs, xdr_args, args_ptr));
395 svc_dg_freeargs(xprt, xdr_args, args_ptr)
400 XDR *xdrs = &(su_data(xprt)->su_xdrs);
402 xdrs->x_op = XDR_FREE;
403 return (*xdr_args)(xdrs, args_ptr);
410 struct svc_dg_data *su = su_data(xprt);
412 xprt_unregister(xprt);
413 if (xprt->xp_fd != -1)
414 (void)_close(xprt->xp_fd);
415 XDR_DESTROY(&(su->su_xdrs));
416 (void) mem_free(rpc_buffer(xprt), su->su_iosz);
417 if (su->su_srcaddr.buf)
418 (void) mem_free(su->su_srcaddr.buf, su->su_srcaddr.maxlen);
419 (void) mem_free(su, sizeof (*su));
420 if (xprt->xp_rtaddr.buf)
421 (void) mem_free(xprt->xp_rtaddr.buf, xprt->xp_rtaddr.maxlen);
422 if (xprt->xp_ltaddr.buf)
423 (void) mem_free(xprt->xp_ltaddr.buf, xprt->xp_ltaddr.maxlen);
425 (void) free(xprt->xp_tp);
431 svc_dg_control(xprt, rq, in)
443 static struct xp_ops ops;
444 static struct xp_ops2 ops2;
446 /* VARIABLES PROTECTED BY ops_lock: ops */
448 mutex_lock(&ops_lock);
449 if (ops.xp_recv == NULL) {
450 ops.xp_recv = svc_dg_recv;
451 ops.xp_stat = svc_dg_stat;
452 ops.xp_getargs = svc_dg_getargs;
453 ops.xp_reply = svc_dg_reply;
454 ops.xp_freeargs = svc_dg_freeargs;
455 ops.xp_destroy = svc_dg_destroy;
456 ops2.xp_control = svc_dg_control;
459 xprt->xp_ops2 = &ops2;
460 mutex_unlock(&ops_lock);
463 /* The CACHING COMPONENT */
466 * Could have been a separate file, but some part of it depends upon the
467 * private structure of the client handle.
469 * Fifo cache for cl server
470 * Copies pointers to reply buffers into fifo cache
471 * Buffers are sent again if retransmissions are detected.
474 #define SPARSENESS 4 /* 75% sparse */
476 #define ALLOC(type, size) \
477 (type *) mem_alloc((sizeof (type) * (size)))
479 #define MEMZERO(addr, type, size) \
480 (void) memset((void *) (addr), 0, sizeof (type) * (int) (size))
482 #define FREE(addr, type, size) \
483 mem_free((addr), (sizeof (type) * (size)))
486 * An entry in the cache
488 typedef struct cache_node *cache_ptr;
491 * Index into cache is xid, proc, vers, prog and address
494 rpcproc_t cache_proc;
495 rpcvers_t cache_vers;
496 rpcprog_t cache_prog;
497 struct netbuf cache_addr;
499 * The cached reply and length
502 size_t cache_replylen;
504 * Next node on the list, if there is a collision
506 cache_ptr cache_next;
513 u_int uc_size; /* size of cache */
514 cache_ptr *uc_entries; /* hash table of entries in cache */
515 cache_ptr *uc_fifo; /* fifo list of entries in cache */
516 u_int uc_nextvictim; /* points to next victim in fifo list */
517 rpcprog_t uc_prog; /* saved program number */
518 rpcvers_t uc_vers; /* saved version number */
519 rpcproc_t uc_proc; /* saved procedure number */
524 * the hashing function
526 #define CACHE_LOC(transp, xid) \
527 (xid % (SPARSENESS * ((struct cl_cache *) \
528 su_data(transp)->su_cache)->uc_size))
531 * Enable use of the cache. Returns 1 on success, 0 on failure.
532 * Note: there is no disable.
534 static const char cache_enable_str[] = "svc_enablecache: %s %s";
535 static const char alloc_err[] = "could not allocate cache ";
536 static const char enable_err[] = "cache already enabled";
539 svc_dg_enablecache(transp, size)
543 struct svc_dg_data *su = su_data(transp);
546 mutex_lock(&dupreq_lock);
547 if (su->su_cache != NULL) {
548 (void) warnx(cache_enable_str, enable_err, " ");
549 mutex_unlock(&dupreq_lock);
552 uc = ALLOC(struct cl_cache, 1);
554 warnx(cache_enable_str, alloc_err, " ");
555 mutex_unlock(&dupreq_lock);
559 uc->uc_nextvictim = 0;
560 uc->uc_entries = ALLOC(cache_ptr, size * SPARSENESS);
561 if (uc->uc_entries == NULL) {
562 warnx(cache_enable_str, alloc_err, "data");
563 FREE(uc, struct cl_cache, 1);
564 mutex_unlock(&dupreq_lock);
567 MEMZERO(uc->uc_entries, cache_ptr, size * SPARSENESS);
568 uc->uc_fifo = ALLOC(cache_ptr, size);
569 if (uc->uc_fifo == NULL) {
570 warnx(cache_enable_str, alloc_err, "fifo");
571 FREE(uc->uc_entries, cache_ptr, size * SPARSENESS);
572 FREE(uc, struct cl_cache, 1);
573 mutex_unlock(&dupreq_lock);
576 MEMZERO(uc->uc_fifo, cache_ptr, size);
577 su->su_cache = (char *)(void *)uc;
578 mutex_unlock(&dupreq_lock);
583 * Set an entry in the cache. It assumes that the uc entry is set from
584 * the earlier call to cache_get() for the same procedure. This will always
585 * happen because cache_get() is calle by svc_dg_recv and cache_set() is called
586 * by svc_dg_reply(). All this hoopla because the right RPC parameters are
587 * not available at svc_dg_reply time.
590 static const char cache_set_str[] = "cache_set: %s";
591 static const char cache_set_err1[] = "victim not found";
592 static const char cache_set_err2[] = "victim alloc failed";
593 static const char cache_set_err3[] = "could not allocate new rpc buffer";
596 cache_set(xprt, replylen)
602 struct svc_dg_data *su = su_data(xprt);
603 struct cl_cache *uc = (struct cl_cache *) su->su_cache;
606 #ifdef RPC_CACHE_DEBUG
607 struct netconfig *nconf;
611 mutex_lock(&dupreq_lock);
613 * Find space for the new entry, either by
614 * reusing an old entry, or by mallocing a new one
616 victim = uc->uc_fifo[uc->uc_nextvictim];
617 if (victim != NULL) {
618 loc = CACHE_LOC(xprt, victim->cache_xid);
619 for (vicp = &uc->uc_entries[loc];
620 *vicp != NULL && *vicp != victim;
621 vicp = &(*vicp)->cache_next)
624 warnx(cache_set_str, cache_set_err1);
625 mutex_unlock(&dupreq_lock);
628 *vicp = victim->cache_next; /* remove from cache */
629 newbuf = victim->cache_reply;
631 victim = ALLOC(struct cache_node, 1);
632 if (victim == NULL) {
633 warnx(cache_set_str, cache_set_err2);
634 mutex_unlock(&dupreq_lock);
637 newbuf = mem_alloc(su->su_iosz);
638 if (newbuf == NULL) {
639 warnx(cache_set_str, cache_set_err3);
640 FREE(victim, struct cache_node, 1);
641 mutex_unlock(&dupreq_lock);
649 #ifdef RPC_CACHE_DEBUG
650 if (nconf = getnetconfigent(xprt->xp_netid)) {
651 uaddr = taddr2uaddr(nconf, &xprt->xp_rtaddr);
652 freenetconfigent(nconf);
654 "cache set for xid= %x prog=%d vers=%d proc=%d for rmtaddr=%s\n",
655 su->su_xid, uc->uc_prog, uc->uc_vers,
660 victim->cache_replylen = replylen;
661 victim->cache_reply = rpc_buffer(xprt);
662 rpc_buffer(xprt) = newbuf;
663 xdrmem_create(&(su->su_xdrs), rpc_buffer(xprt),
664 su->su_iosz, XDR_ENCODE);
665 victim->cache_xid = su->su_xid;
666 victim->cache_proc = uc->uc_proc;
667 victim->cache_vers = uc->uc_vers;
668 victim->cache_prog = uc->uc_prog;
669 victim->cache_addr = xprt->xp_rtaddr;
670 victim->cache_addr.buf = ALLOC(char, xprt->xp_rtaddr.len);
671 (void) memcpy(victim->cache_addr.buf, xprt->xp_rtaddr.buf,
672 (size_t)xprt->xp_rtaddr.len);
673 loc = CACHE_LOC(xprt, victim->cache_xid);
674 victim->cache_next = uc->uc_entries[loc];
675 uc->uc_entries[loc] = victim;
676 uc->uc_fifo[uc->uc_nextvictim++] = victim;
677 uc->uc_nextvictim %= uc->uc_size;
678 mutex_unlock(&dupreq_lock);
682 * Try to get an entry from the cache
683 * return 1 if found, 0 if not found and set the stage for cache_set()
686 cache_get(xprt, msg, replyp, replylenp)
694 struct svc_dg_data *su = su_data(xprt);
695 struct cl_cache *uc = (struct cl_cache *) su->su_cache;
696 #ifdef RPC_CACHE_DEBUG
697 struct netconfig *nconf;
701 mutex_lock(&dupreq_lock);
702 loc = CACHE_LOC(xprt, su->su_xid);
703 for (ent = uc->uc_entries[loc]; ent != NULL; ent = ent->cache_next) {
704 if (ent->cache_xid == su->su_xid &&
705 ent->cache_proc == msg->rm_call.cb_proc &&
706 ent->cache_vers == msg->rm_call.cb_vers &&
707 ent->cache_prog == msg->rm_call.cb_prog &&
708 ent->cache_addr.len == xprt->xp_rtaddr.len &&
709 (memcmp(ent->cache_addr.buf, xprt->xp_rtaddr.buf,
710 xprt->xp_rtaddr.len) == 0)) {
711 #ifdef RPC_CACHE_DEBUG
712 if (nconf = getnetconfigent(xprt->xp_netid)) {
713 uaddr = taddr2uaddr(nconf, &xprt->xp_rtaddr);
714 freenetconfigent(nconf);
716 "cache entry found for xid=%x prog=%d vers=%d proc=%d for rmtaddr=%s\n",
717 su->su_xid, msg->rm_call.cb_prog,
718 msg->rm_call.cb_vers,
719 msg->rm_call.cb_proc, uaddr);
723 *replyp = ent->cache_reply;
724 *replylenp = ent->cache_replylen;
725 mutex_unlock(&dupreq_lock);
730 * Failed to find entry
731 * Remember a few things so we can do a set later
733 uc->uc_proc = msg->rm_call.cb_proc;
734 uc->uc_vers = msg->rm_call.cb_vers;
735 uc->uc_prog = msg->rm_call.cb_prog;
736 mutex_unlock(&dupreq_lock);