1 /* $NetBSD: svc_vc.c,v 1.7 2000/08/03 00:01:53 fvdl 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.
31 #if defined(LIBC_SCCS) && !defined(lint)
32 static char *sccsid2 = "@(#)svc_tcp.c 1.21 87/08/11 Copyr 1984 Sun Micro";
33 static char *sccsid = "@(#)svc_tcp.c 2.2 88/08/01 4.0 RPCSRC";
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
39 * svc_vc.c, Server side for Connection Oriented based RPC.
41 * Actually implements two flavors of transporter -
42 * a tcp rendezvouser (a listner and connection establisher)
43 * and a record/tcp stream.
46 #include "namespace.h"
47 #include "reentrant.h"
48 #include <sys/types.h>
49 #include <sys/param.h>
51 #include <sys/socket.h>
55 #include <netinet/in.h>
56 #include <netinet/tcp.h>
71 #include "un-namespace.h"
73 static SVCXPRT *makefd_xprt(int, u_int, u_int);
74 static bool_t rendezvous_request(SVCXPRT *, struct rpc_msg *);
75 static enum xprt_stat rendezvous_stat(SVCXPRT *);
76 static void svc_vc_destroy(SVCXPRT *);
77 static void __svc_vc_dodestroy (SVCXPRT *);
78 static int read_vc(void *, void *, int);
79 static int write_vc(void *, void *, int);
80 static enum xprt_stat svc_vc_stat(SVCXPRT *);
81 static bool_t svc_vc_recv(SVCXPRT *, struct rpc_msg *);
82 static bool_t svc_vc_getargs(SVCXPRT *, xdrproc_t, void *);
83 static bool_t svc_vc_freeargs(SVCXPRT *, xdrproc_t, void *);
84 static bool_t svc_vc_reply(SVCXPRT *, struct rpc_msg *);
85 static void svc_vc_rendezvous_ops(SVCXPRT *);
86 static void svc_vc_ops(SVCXPRT *);
87 static bool_t svc_vc_control(SVCXPRT *xprt, const u_int rq, void *in);
88 static bool_t svc_vc_rendezvous_control (SVCXPRT *xprt, const u_int rq,
91 struct cf_rendezvous { /* kept in xprt->xp_p1 for rendezvouser */
97 struct cf_conn { /* kept in xprt->xp_p1 for actual connection */
98 enum xprt_stat strm_stat;
101 char verf_body[MAX_AUTH_BYTES];
106 struct timeval last_recv_time;
111 * xprt = svc_vc_create(sock, send_buf_size, recv_buf_size);
113 * Creates, registers, and returns a (rpc) tcp based transporter.
114 * Once *xprt is initialized, it is registered as a transporter
115 * see (svc.h, xprt_register). This routine returns
116 * a NULL if a problem occurred.
118 * The filedescriptor passed in is expected to refer to a bound, but
119 * not yet connected socket.
121 * Since streams do buffered io similar to stdio, the caller can specify
122 * how big the send and receive buffers are via the second and third parms;
123 * 0 => use the system default.
126 svc_vc_create(int fd, u_int sendsize, u_int recvsize)
128 SVCXPRT *xprt = NULL;
129 struct cf_rendezvous *r = NULL;
130 struct __rpc_sockinfo si;
131 struct sockaddr_storage sslocal;
134 if (!__rpc_fd2sockinfo(fd, &si))
137 r = mem_alloc(sizeof(*r));
139 warnx("svc_vc_create: out of memory");
140 goto cleanup_svc_vc_create;
142 r->sendsize = __rpc_get_t_size(si.si_af, si.si_proto, (int)sendsize);
143 r->recvsize = __rpc_get_t_size(si.si_af, si.si_proto, (int)recvsize);
144 r->maxrec = __svc_maxrec;
145 xprt = svc_xprt_alloc();
147 warnx("svc_vc_create: out of memory");
148 goto cleanup_svc_vc_create;
151 xprt->xp_verf = _null_auth;
152 svc_vc_rendezvous_ops(xprt);
153 xprt->xp_port = (u_short)-1; /* It is the rendezvouser */
156 slen = sizeof (struct sockaddr_storage);
157 if (_getsockname(fd, (struct sockaddr *)(void *)&sslocal, &slen) < 0) {
158 warnx("svc_vc_create: could not retrieve local addr");
159 goto cleanup_svc_vc_create;
162 xprt->xp_ltaddr.maxlen = xprt->xp_ltaddr.len = sslocal.ss_len;
163 xprt->xp_ltaddr.buf = mem_alloc((size_t)sslocal.ss_len);
164 if (xprt->xp_ltaddr.buf == NULL) {
165 warnx("svc_vc_create: no mem for local addr");
166 goto cleanup_svc_vc_create;
168 memcpy(xprt->xp_ltaddr.buf, &sslocal, (size_t)sslocal.ss_len);
170 xprt->xp_rtaddr.maxlen = sizeof (struct sockaddr_storage);
173 cleanup_svc_vc_create:
175 mem_free(xprt, sizeof(*xprt));
177 mem_free(r, sizeof(*r));
182 * Like svtcp_create(), except the routine takes any *open* UNIX file
183 * descriptor as its first input.
186 svc_fd_create(int fd, u_int sendsize, u_int recvsize)
188 struct sockaddr_storage ss;
194 ret = makefd_xprt(fd, sendsize, recvsize);
198 slen = sizeof (struct sockaddr_storage);
199 if (_getsockname(fd, (struct sockaddr *)(void *)&ss, &slen) < 0) {
200 warnx("svc_fd_create: could not retrieve local addr");
203 ret->xp_ltaddr.maxlen = ret->xp_ltaddr.len = ss.ss_len;
204 ret->xp_ltaddr.buf = mem_alloc((size_t)ss.ss_len);
205 if (ret->xp_ltaddr.buf == NULL) {
206 warnx("svc_fd_create: no mem for local addr");
209 memcpy(ret->xp_ltaddr.buf, &ss, (size_t)ss.ss_len);
211 slen = sizeof (struct sockaddr_storage);
212 if (_getpeername(fd, (struct sockaddr *)(void *)&ss, &slen) < 0) {
213 warnx("svc_fd_create: could not retrieve remote addr");
216 ret->xp_rtaddr.maxlen = ret->xp_rtaddr.len = ss.ss_len;
217 ret->xp_rtaddr.buf = mem_alloc((size_t)ss.ss_len);
218 if (ret->xp_rtaddr.buf == NULL) {
219 warnx("svc_fd_create: no mem for local addr");
222 memcpy(ret->xp_rtaddr.buf, &ss, (size_t)ss.ss_len);
224 if (ss.ss_family == AF_INET || ss.ss_family == AF_LOCAL) {
225 ret->xp_raddr = *(struct sockaddr_in *)ret->xp_rtaddr.buf;
226 ret->xp_addrlen = sizeof (struct sockaddr_in);
233 if (ret->xp_ltaddr.buf != NULL)
234 mem_free(ret->xp_ltaddr.buf, rep->xp_ltaddr.maxlen);
240 makefd_xprt(int fd, u_int sendsize, u_int recvsize)
245 struct __rpc_sockinfo si;
249 xprt = svc_xprt_alloc();
251 warnx("svc_vc: makefd_xprt: out of memory");
254 cd = mem_alloc(sizeof(struct cf_conn));
256 warnx("svc_tcp: makefd_xprt: out of memory");
261 cd->strm_stat = XPRT_IDLE;
262 xdrrec_create(&(cd->xdrs), sendsize, recvsize,
263 xprt, read_vc, write_vc);
265 xprt->xp_verf.oa_base = cd->verf_body;
266 svc_vc_ops(xprt); /* truely deals with calls */
267 xprt->xp_port = 0; /* this is a connection, not a rendezvouser */
269 if (__rpc_fd2sockinfo(fd, &si) && __rpc_sockinfo2netid(&si, &netid))
270 xprt->xp_netid = strdup(netid);
279 rendezvous_request(SVCXPRT *xprt, struct rpc_msg *msg)
282 struct cf_rendezvous *r;
284 struct sockaddr_storage addr, sslocal;
286 struct __rpc_sockinfo si;
290 assert(xprt != NULL);
293 r = (struct cf_rendezvous *)xprt->xp_p1;
296 if ((sock = _accept(xprt->xp_fd, (struct sockaddr *)(void *)&addr,
301 * Clean out the most idle file descriptor when we're
304 if (errno == EMFILE || errno == ENFILE) {
305 cleanfds = svc_fdset;
306 __svc_clean_idle(&cleanfds, 0, FALSE);
312 * make a new transporter (re-uses xprt)
314 newxprt = makefd_xprt(sock, r->sendsize, r->recvsize);
315 newxprt->xp_rtaddr.buf = mem_alloc(len);
316 if (newxprt->xp_rtaddr.buf == NULL)
318 memcpy(newxprt->xp_rtaddr.buf, &addr, len);
319 newxprt->xp_rtaddr.len = len;
321 if (addr.ss_family == AF_INET || addr.ss_family == AF_LOCAL) {
322 newxprt->xp_raddr = *(struct sockaddr_in *)newxprt->xp_rtaddr.buf;
323 newxprt->xp_addrlen = sizeof (struct sockaddr_in);
326 if (__rpc_fd2sockinfo(sock, &si) && si.si_proto == IPPROTO_TCP) {
328 /* XXX fvdl - is this useful? */
329 _setsockopt(sock, IPPROTO_TCP, TCP_NODELAY, &len, sizeof (len));
332 cd = (struct cf_conn *)newxprt->xp_p1;
334 cd->recvsize = r->recvsize;
335 cd->sendsize = r->sendsize;
336 cd->maxrec = r->maxrec;
338 if (cd->maxrec != 0) {
339 flags = _fcntl(sock, F_GETFL, 0);
342 if (_fcntl(sock, F_SETFL, flags | O_NONBLOCK) == -1)
344 if (cd->recvsize > cd->maxrec)
345 cd->recvsize = cd->maxrec;
347 __xdrrec_setnonblock(&cd->xdrs, cd->maxrec);
349 cd->nonblock = FALSE;
350 slen = sizeof(struct sockaddr_storage);
351 if(_getsockname(sock, (struct sockaddr *)(void *)&sslocal, &slen) < 0) {
352 warnx("svc_vc_create: could not retrieve local addr");
353 newxprt->xp_ltaddr.maxlen = newxprt->xp_ltaddr.len = 0;
355 newxprt->xp_ltaddr.maxlen = newxprt->xp_ltaddr.len = sslocal.ss_len;
356 newxprt->xp_ltaddr.buf = mem_alloc((size_t)sslocal.ss_len);
357 if (newxprt->xp_ltaddr.buf == NULL) {
358 warnx("svc_vc_create: no mem for local addr");
359 newxprt->xp_ltaddr.maxlen = newxprt->xp_ltaddr.len = 0;
361 memcpy(newxprt->xp_ltaddr.buf, &sslocal, (size_t)sslocal.ss_len);
365 gettimeofday(&cd->last_recv_time, NULL);
367 return (FALSE); /* there is never an rpc msg to be processed */
371 static enum xprt_stat
372 rendezvous_stat(SVCXPRT *xprt)
379 svc_vc_destroy(SVCXPRT *xprt)
381 assert(xprt != NULL);
383 xprt_unregister(xprt);
384 __svc_vc_dodestroy(xprt);
388 __svc_vc_dodestroy(SVCXPRT *xprt)
391 struct cf_rendezvous *r;
393 cd = (struct cf_conn *)xprt->xp_p1;
395 if (xprt->xp_fd != RPC_ANYFD)
396 (void)_close(xprt->xp_fd);
397 if (xprt->xp_port != 0) {
398 /* a rendezvouser socket */
399 r = (struct cf_rendezvous *)xprt->xp_p1;
400 mem_free(r, sizeof (struct cf_rendezvous));
403 /* an actual connection socket */
404 XDR_DESTROY(&(cd->xdrs));
405 mem_free(cd, sizeof(struct cf_conn));
407 if (xprt->xp_rtaddr.buf)
408 mem_free(xprt->xp_rtaddr.buf, xprt->xp_rtaddr.maxlen);
409 if (xprt->xp_ltaddr.buf)
410 mem_free(xprt->xp_ltaddr.buf, xprt->xp_ltaddr.maxlen);
412 free(xprt->xp_netid);
418 svc_vc_control(SVCXPRT *xprt, const u_int rq, void *in)
424 svc_vc_rendezvous_control(SVCXPRT *xprt, const u_int rq, void *in)
426 struct cf_rendezvous *cfp;
428 cfp = (struct cf_rendezvous *)xprt->xp_p1;
432 case SVCGET_CONNMAXREC:
433 *(int *)in = cfp->maxrec;
435 case SVCSET_CONNMAXREC:
436 cfp->maxrec = *(int *)in;
445 * reads data from the tcp or uip connection.
446 * any error is fatal and the connection is closed.
447 * (And a read of zero bytes is a half closed stream => error.)
448 * All read operations timeout after 35 seconds. A timeout is
449 * fatal for the connection.
452 read_vc(void *xprtp, void *buf, int len)
456 int milliseconds = 35 * 1000;
457 struct pollfd pollfd;
460 xprt = (SVCXPRT *)xprtp;
461 assert(xprt != NULL);
465 cfp = (struct cf_conn *)xprt->xp_p1;
468 len = _read(sock, buf, (size_t)len);
476 gettimeofday(&cfp->last_recv_time, NULL);
482 pollfd.events = POLLIN;
484 switch (_poll(&pollfd, 1, milliseconds)) {
495 } while ((pollfd.revents & POLLIN) == 0);
497 if ((len = _read(sock, buf, (size_t)len)) > 0) {
498 gettimeofday(&cfp->last_recv_time, NULL);
503 ((struct cf_conn *)(xprt->xp_p1))->strm_stat = XPRT_DIED;
508 * writes data to the tcp connection.
509 * Any error is fatal and the connection is closed.
512 write_vc(void *xprtp, void *buf, int len)
517 struct timeval tv0, tv1;
519 xprt = (SVCXPRT *)xprtp;
520 assert(xprt != NULL);
522 cd = (struct cf_conn *)xprt->xp_p1;
525 gettimeofday(&tv0, NULL);
527 for (cnt = len; cnt > 0; cnt -= i, buf = (char *)buf + i) {
528 i = _write(xprt->xp_fd, buf, (size_t)cnt);
530 if (errno != EAGAIN || !cd->nonblock) {
531 cd->strm_stat = XPRT_DIED;
536 * For non-blocking connections, do not
537 * take more than 2 seconds writing the
540 * XXX 2 is an arbitrary amount.
542 gettimeofday(&tv1, NULL);
543 if (tv1.tv_sec - tv0.tv_sec >= 2) {
544 cd->strm_stat = XPRT_DIED;
555 static enum xprt_stat
556 svc_vc_stat(SVCXPRT *xprt)
560 assert(xprt != NULL);
562 cd = (struct cf_conn *)(xprt->xp_p1);
564 if (cd->strm_stat == XPRT_DIED)
566 if (! xdrrec_eof(&(cd->xdrs)))
567 return (XPRT_MOREREQS);
572 svc_vc_recv(SVCXPRT *xprt, struct rpc_msg *msg)
577 assert(xprt != NULL);
580 cd = (struct cf_conn *)(xprt->xp_p1);
584 if (!__xdrrec_getrec(xdrs, &cd->strm_stat, TRUE))
587 (void)xdrrec_skiprecord(xdrs);
590 xdrs->x_op = XDR_DECODE;
591 if (xdr_callmsg(xdrs, msg)) {
592 cd->x_id = msg->rm_xid;
595 cd->strm_stat = XPRT_DIED;
600 svc_vc_getargs(SVCXPRT *xprt, xdrproc_t xdr_args, void *args_ptr)
604 assert(xprt != NULL);
605 cd = (struct cf_conn *)(xprt->xp_p1);
606 return (SVCAUTH_UNWRAP(&SVC_AUTH(xprt),
607 &cd->xdrs, xdr_args, args_ptr));
611 svc_vc_freeargs(SVCXPRT *xprt, xdrproc_t xdr_args, void *args_ptr)
615 assert(xprt != NULL);
616 /* args_ptr may be NULL */
618 xdrs = &(((struct cf_conn *)(xprt->xp_p1))->xdrs);
620 xdrs->x_op = XDR_FREE;
621 return ((*xdr_args)(xdrs, args_ptr));
625 svc_vc_reply(SVCXPRT *xprt, struct rpc_msg *msg)
634 assert(xprt != NULL);
637 cd = (struct cf_conn *)(xprt->xp_p1);
640 xdrs->x_op = XDR_ENCODE;
641 msg->rm_xid = cd->x_id;
643 if (msg->rm_reply.rp_stat == MSG_ACCEPTED &&
644 msg->rm_reply.rp_acpt.ar_stat == SUCCESS) {
645 xdr_proc = msg->acpted_rply.ar_results.proc;
646 xdr_where = msg->acpted_rply.ar_results.where;
647 msg->acpted_rply.ar_results.proc = (xdrproc_t) xdr_void;
648 msg->acpted_rply.ar_results.where = NULL;
650 pos = XDR_GETPOS(xdrs);
651 if (!xdr_replymsg(xdrs, msg) ||
652 !SVCAUTH_WRAP(&SVC_AUTH(xprt), xdrs, xdr_proc, xdr_where)) {
653 XDR_SETPOS(xdrs, pos);
657 rstat = xdr_replymsg(xdrs, msg);
661 (void)xdrrec_endofrecord(xdrs, TRUE);
667 svc_vc_ops(SVCXPRT *xprt)
669 static struct xp_ops ops;
670 static struct xp_ops2 ops2;
672 /* VARIABLES PROTECTED BY ops_lock: ops, ops2 */
674 mutex_lock(&ops_lock);
675 if (ops.xp_recv == NULL) {
676 ops.xp_recv = svc_vc_recv;
677 ops.xp_stat = svc_vc_stat;
678 ops.xp_getargs = svc_vc_getargs;
679 ops.xp_reply = svc_vc_reply;
680 ops.xp_freeargs = svc_vc_freeargs;
681 ops.xp_destroy = svc_vc_destroy;
682 ops2.xp_control = svc_vc_control;
685 xprt->xp_ops2 = &ops2;
686 mutex_unlock(&ops_lock);
690 svc_vc_rendezvous_ops(SVCXPRT *xprt)
692 static struct xp_ops ops;
693 static struct xp_ops2 ops2;
695 mutex_lock(&ops_lock);
696 if (ops.xp_recv == NULL) {
697 ops.xp_recv = rendezvous_request;
698 ops.xp_stat = rendezvous_stat;
700 (bool_t (*)(SVCXPRT *, xdrproc_t, void *))abort;
702 (bool_t (*)(SVCXPRT *, struct rpc_msg *))abort;
704 (bool_t (*)(SVCXPRT *, xdrproc_t, void *))abort;
705 ops.xp_destroy = svc_vc_destroy;
706 ops2.xp_control = svc_vc_rendezvous_control;
709 xprt->xp_ops2 = &ops2;
710 mutex_unlock(&ops_lock);
714 * Get the effective UID of the sending process. Used by rpcbind, keyserv
715 * and rpc.yppasswdd on AF_LOCAL.
718 __rpc_get_local_uid(SVCXPRT *transp, uid_t *uid) {
724 sock = transp->xp_fd;
725 sa = (struct sockaddr *)transp->xp_rtaddr.buf;
726 if (sa->sa_family == AF_LOCAL) {
727 ret = getpeereid(sock, &euid, &egid);
736 * Destroy xprts that have not have had any activity in 'timeout' seconds.
737 * If 'cleanblock' is true, blocking connections (the default) are also
738 * cleaned. If timeout is 0, the least active connection is picked.
741 __svc_clean_idle(fd_set *fds, int timeout, bool_t cleanblock)
744 SVCXPRT *xprt, *least_active;
745 struct timeval tv, tdiff, tmax;
748 gettimeofday(&tv, NULL);
749 tmax.tv_sec = tmax.tv_usec = 0;
751 rwlock_wrlock(&svc_fd_lock);
752 for (i = ncleaned = 0; i <= svc_maxfd; i++) {
753 if (FD_ISSET(i, fds)) {
754 xprt = __svc_xports[i];
755 if (xprt == NULL || xprt->xp_ops == NULL ||
756 xprt->xp_ops->xp_recv != svc_vc_recv)
758 cd = (struct cf_conn *)xprt->xp_p1;
759 if (!cleanblock && !cd->nonblock)
762 timersub(&tv, &cd->last_recv_time, &tdiff);
763 if (timercmp(&tdiff, &tmax, >)) {
769 if (tv.tv_sec - cd->last_recv_time.tv_sec > timeout) {
770 __xprt_unregister_unlocked(xprt);
771 __svc_vc_dodestroy(xprt);
776 if (timeout == 0 && least_active != NULL) {
777 __xprt_unregister_unlocked(least_active);
778 __svc_vc_dodestroy(least_active);
781 rwlock_unlock(&svc_fd_lock);
782 return ncleaned > 0 ? TRUE : FALSE;