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(fd, sendsize, recvsize)
132 struct cf_rendezvous *r = NULL;
133 struct __rpc_sockinfo si;
134 struct sockaddr_storage sslocal;
137 if (!__rpc_fd2sockinfo(fd, &si))
140 r = mem_alloc(sizeof(*r));
142 warnx("svc_vc_create: out of memory");
143 goto cleanup_svc_vc_create;
145 r->sendsize = __rpc_get_t_size(si.si_af, si.si_proto, (int)sendsize);
146 r->recvsize = __rpc_get_t_size(si.si_af, si.si_proto, (int)recvsize);
147 r->maxrec = __svc_maxrec;
148 xprt = svc_xprt_alloc();
150 warnx("svc_vc_create: out of memory");
151 goto cleanup_svc_vc_create;
154 xprt->xp_verf = _null_auth;
155 svc_vc_rendezvous_ops(xprt);
156 xprt->xp_port = (u_short)-1; /* It is the rendezvouser */
159 slen = sizeof (struct sockaddr_storage);
160 if (_getsockname(fd, (struct sockaddr *)(void *)&sslocal, &slen) < 0) {
161 warnx("svc_vc_create: could not retrieve local addr");
162 goto cleanup_svc_vc_create;
165 xprt->xp_ltaddr.maxlen = xprt->xp_ltaddr.len = sslocal.ss_len;
166 xprt->xp_ltaddr.buf = mem_alloc((size_t)sslocal.ss_len);
167 if (xprt->xp_ltaddr.buf == NULL) {
168 warnx("svc_vc_create: no mem for local addr");
169 goto cleanup_svc_vc_create;
171 memcpy(xprt->xp_ltaddr.buf, &sslocal, (size_t)sslocal.ss_len);
173 xprt->xp_rtaddr.maxlen = sizeof (struct sockaddr_storage);
176 cleanup_svc_vc_create:
178 mem_free(xprt, sizeof(*xprt));
180 mem_free(r, sizeof(*r));
185 * Like svtcp_create(), except the routine takes any *open* UNIX file
186 * descriptor as its first input.
189 svc_fd_create(fd, sendsize, recvsize)
194 struct sockaddr_storage ss;
200 ret = makefd_xprt(fd, sendsize, recvsize);
204 slen = sizeof (struct sockaddr_storage);
205 if (_getsockname(fd, (struct sockaddr *)(void *)&ss, &slen) < 0) {
206 warnx("svc_fd_create: could not retrieve local addr");
209 ret->xp_ltaddr.maxlen = ret->xp_ltaddr.len = ss.ss_len;
210 ret->xp_ltaddr.buf = mem_alloc((size_t)ss.ss_len);
211 if (ret->xp_ltaddr.buf == NULL) {
212 warnx("svc_fd_create: no mem for local addr");
215 memcpy(ret->xp_ltaddr.buf, &ss, (size_t)ss.ss_len);
217 slen = sizeof (struct sockaddr_storage);
218 if (_getpeername(fd, (struct sockaddr *)(void *)&ss, &slen) < 0) {
219 warnx("svc_fd_create: could not retrieve remote addr");
222 ret->xp_rtaddr.maxlen = ret->xp_rtaddr.len = ss.ss_len;
223 ret->xp_rtaddr.buf = mem_alloc((size_t)ss.ss_len);
224 if (ret->xp_rtaddr.buf == NULL) {
225 warnx("svc_fd_create: no mem for local addr");
228 memcpy(ret->xp_rtaddr.buf, &ss, (size_t)ss.ss_len);
230 if (ss.ss_family == AF_INET || ss.ss_family == AF_LOCAL) {
231 ret->xp_raddr = *(struct sockaddr_in *)ret->xp_rtaddr.buf;
232 ret->xp_addrlen = sizeof (struct sockaddr_in);
239 if (ret->xp_ltaddr.buf != NULL)
240 mem_free(ret->xp_ltaddr.buf, rep->xp_ltaddr.maxlen);
246 makefd_xprt(fd, sendsize, recvsize)
254 struct __rpc_sockinfo si;
258 xprt = svc_xprt_alloc();
260 warnx("svc_vc: makefd_xprt: out of memory");
263 cd = mem_alloc(sizeof(struct cf_conn));
265 warnx("svc_tcp: makefd_xprt: out of memory");
270 cd->strm_stat = XPRT_IDLE;
271 xdrrec_create(&(cd->xdrs), sendsize, recvsize,
272 xprt, read_vc, write_vc);
274 xprt->xp_verf.oa_base = cd->verf_body;
275 svc_vc_ops(xprt); /* truely deals with calls */
276 xprt->xp_port = 0; /* this is a connection, not a rendezvouser */
278 if (__rpc_fd2sockinfo(fd, &si) && __rpc_sockinfo2netid(&si, &netid))
279 xprt->xp_netid = strdup(netid);
288 rendezvous_request(xprt, msg)
293 struct cf_rendezvous *r;
295 struct sockaddr_storage addr, sslocal;
297 struct __rpc_sockinfo si;
301 assert(xprt != NULL);
304 r = (struct cf_rendezvous *)xprt->xp_p1;
307 if ((sock = _accept(xprt->xp_fd, (struct sockaddr *)(void *)&addr,
312 * Clean out the most idle file descriptor when we're
315 if (errno == EMFILE || errno == ENFILE) {
316 cleanfds = svc_fdset;
317 __svc_clean_idle(&cleanfds, 0, FALSE);
323 * make a new transporter (re-uses xprt)
325 newxprt = makefd_xprt(sock, r->sendsize, r->recvsize);
326 newxprt->xp_rtaddr.buf = mem_alloc(len);
327 if (newxprt->xp_rtaddr.buf == NULL)
329 memcpy(newxprt->xp_rtaddr.buf, &addr, len);
330 newxprt->xp_rtaddr.len = len;
332 if (addr.ss_family == AF_INET || addr.ss_family == AF_LOCAL) {
333 newxprt->xp_raddr = *(struct sockaddr_in *)newxprt->xp_rtaddr.buf;
334 newxprt->xp_addrlen = sizeof (struct sockaddr_in);
337 if (__rpc_fd2sockinfo(sock, &si) && si.si_proto == IPPROTO_TCP) {
339 /* XXX fvdl - is this useful? */
340 _setsockopt(sock, IPPROTO_TCP, TCP_NODELAY, &len, sizeof (len));
343 cd = (struct cf_conn *)newxprt->xp_p1;
345 cd->recvsize = r->recvsize;
346 cd->sendsize = r->sendsize;
347 cd->maxrec = r->maxrec;
349 if (cd->maxrec != 0) {
350 flags = _fcntl(sock, F_GETFL, 0);
353 if (_fcntl(sock, F_SETFL, flags | O_NONBLOCK) == -1)
355 if (cd->recvsize > cd->maxrec)
356 cd->recvsize = cd->maxrec;
358 __xdrrec_setnonblock(&cd->xdrs, cd->maxrec);
360 cd->nonblock = FALSE;
361 slen = sizeof(struct sockaddr_storage);
362 if(_getsockname(sock, (struct sockaddr *)(void *)&sslocal, &slen) < 0) {
363 warnx("svc_vc_create: could not retrieve local addr");
364 newxprt->xp_ltaddr.maxlen = newxprt->xp_ltaddr.len = 0;
366 newxprt->xp_ltaddr.maxlen = newxprt->xp_ltaddr.len = sslocal.ss_len;
367 newxprt->xp_ltaddr.buf = mem_alloc((size_t)sslocal.ss_len);
368 if (newxprt->xp_ltaddr.buf == NULL) {
369 warnx("svc_vc_create: no mem for local addr");
370 newxprt->xp_ltaddr.maxlen = newxprt->xp_ltaddr.len = 0;
372 memcpy(newxprt->xp_ltaddr.buf, &sslocal, (size_t)sslocal.ss_len);
376 gettimeofday(&cd->last_recv_time, NULL);
378 return (FALSE); /* there is never an rpc msg to be processed */
382 static enum xprt_stat
383 rendezvous_stat(xprt)
394 assert(xprt != NULL);
396 xprt_unregister(xprt);
397 __svc_vc_dodestroy(xprt);
401 __svc_vc_dodestroy(xprt)
405 struct cf_rendezvous *r;
407 cd = (struct cf_conn *)xprt->xp_p1;
409 if (xprt->xp_fd != RPC_ANYFD)
410 (void)_close(xprt->xp_fd);
411 if (xprt->xp_port != 0) {
412 /* a rendezvouser socket */
413 r = (struct cf_rendezvous *)xprt->xp_p1;
414 mem_free(r, sizeof (struct cf_rendezvous));
417 /* an actual connection socket */
418 XDR_DESTROY(&(cd->xdrs));
419 mem_free(cd, sizeof(struct cf_conn));
421 if (xprt->xp_rtaddr.buf)
422 mem_free(xprt->xp_rtaddr.buf, xprt->xp_rtaddr.maxlen);
423 if (xprt->xp_ltaddr.buf)
424 mem_free(xprt->xp_ltaddr.buf, xprt->xp_ltaddr.maxlen);
426 free(xprt->xp_netid);
432 svc_vc_control(xprt, rq, in)
441 svc_vc_rendezvous_control(xprt, rq, in)
446 struct cf_rendezvous *cfp;
448 cfp = (struct cf_rendezvous *)xprt->xp_p1;
452 case SVCGET_CONNMAXREC:
453 *(int *)in = cfp->maxrec;
455 case SVCSET_CONNMAXREC:
456 cfp->maxrec = *(int *)in;
465 * reads data from the tcp or uip connection.
466 * any error is fatal and the connection is closed.
467 * (And a read of zero bytes is a half closed stream => error.)
468 * All read operations timeout after 35 seconds. A timeout is
469 * fatal for the connection.
472 read_vc(xprtp, buf, len)
479 int milliseconds = 35 * 1000;
480 struct pollfd pollfd;
483 xprt = (SVCXPRT *)xprtp;
484 assert(xprt != NULL);
488 cfp = (struct cf_conn *)xprt->xp_p1;
491 len = _read(sock, buf, (size_t)len);
499 gettimeofday(&cfp->last_recv_time, NULL);
505 pollfd.events = POLLIN;
507 switch (_poll(&pollfd, 1, milliseconds)) {
518 } while ((pollfd.revents & POLLIN) == 0);
520 if ((len = _read(sock, buf, (size_t)len)) > 0) {
521 gettimeofday(&cfp->last_recv_time, NULL);
526 ((struct cf_conn *)(xprt->xp_p1))->strm_stat = XPRT_DIED;
531 * writes data to the tcp connection.
532 * Any error is fatal and the connection is closed.
535 write_vc(xprtp, buf, len)
543 struct timeval tv0, tv1;
545 xprt = (SVCXPRT *)xprtp;
546 assert(xprt != NULL);
548 cd = (struct cf_conn *)xprt->xp_p1;
551 gettimeofday(&tv0, NULL);
553 for (cnt = len; cnt > 0; cnt -= i, buf = (char *)buf + i) {
554 i = _write(xprt->xp_fd, buf, (size_t)cnt);
556 if (errno != EAGAIN || !cd->nonblock) {
557 cd->strm_stat = XPRT_DIED;
562 * For non-blocking connections, do not
563 * take more than 2 seconds writing the
566 * XXX 2 is an arbitrary amount.
568 gettimeofday(&tv1, NULL);
569 if (tv1.tv_sec - tv0.tv_sec >= 2) {
570 cd->strm_stat = XPRT_DIED;
581 static enum xprt_stat
587 assert(xprt != NULL);
589 cd = (struct cf_conn *)(xprt->xp_p1);
591 if (cd->strm_stat == XPRT_DIED)
593 if (! xdrrec_eof(&(cd->xdrs)))
594 return (XPRT_MOREREQS);
599 svc_vc_recv(xprt, msg)
606 assert(xprt != NULL);
609 cd = (struct cf_conn *)(xprt->xp_p1);
613 if (!__xdrrec_getrec(xdrs, &cd->strm_stat, TRUE))
616 (void)xdrrec_skiprecord(xdrs);
619 xdrs->x_op = XDR_DECODE;
620 if (xdr_callmsg(xdrs, msg)) {
621 cd->x_id = msg->rm_xid;
624 cd->strm_stat = XPRT_DIED;
629 svc_vc_getargs(xprt, xdr_args, args_ptr)
636 assert(xprt != NULL);
637 cd = (struct cf_conn *)(xprt->xp_p1);
638 return (SVCAUTH_UNWRAP(&SVC_AUTH(xprt),
639 &cd->xdrs, xdr_args, args_ptr));
643 svc_vc_freeargs(xprt, xdr_args, args_ptr)
650 assert(xprt != NULL);
651 /* args_ptr may be NULL */
653 xdrs = &(((struct cf_conn *)(xprt->xp_p1))->xdrs);
655 xdrs->x_op = XDR_FREE;
656 return ((*xdr_args)(xdrs, args_ptr));
660 svc_vc_reply(xprt, msg)
671 assert(xprt != NULL);
674 cd = (struct cf_conn *)(xprt->xp_p1);
677 xdrs->x_op = XDR_ENCODE;
678 msg->rm_xid = cd->x_id;
680 if (msg->rm_reply.rp_stat == MSG_ACCEPTED &&
681 msg->rm_reply.rp_acpt.ar_stat == SUCCESS) {
682 xdr_proc = msg->acpted_rply.ar_results.proc;
683 xdr_where = msg->acpted_rply.ar_results.where;
684 msg->acpted_rply.ar_results.proc = (xdrproc_t) xdr_void;
685 msg->acpted_rply.ar_results.where = NULL;
687 pos = XDR_GETPOS(xdrs);
688 if (!xdr_replymsg(xdrs, msg) ||
689 !SVCAUTH_WRAP(&SVC_AUTH(xprt), xdrs, xdr_proc, xdr_where)) {
690 XDR_SETPOS(xdrs, pos);
694 rstat = xdr_replymsg(xdrs, msg);
698 (void)xdrrec_endofrecord(xdrs, TRUE);
707 static struct xp_ops ops;
708 static struct xp_ops2 ops2;
710 /* VARIABLES PROTECTED BY ops_lock: ops, ops2 */
712 mutex_lock(&ops_lock);
713 if (ops.xp_recv == NULL) {
714 ops.xp_recv = svc_vc_recv;
715 ops.xp_stat = svc_vc_stat;
716 ops.xp_getargs = svc_vc_getargs;
717 ops.xp_reply = svc_vc_reply;
718 ops.xp_freeargs = svc_vc_freeargs;
719 ops.xp_destroy = svc_vc_destroy;
720 ops2.xp_control = svc_vc_control;
723 xprt->xp_ops2 = &ops2;
724 mutex_unlock(&ops_lock);
728 svc_vc_rendezvous_ops(xprt)
731 static struct xp_ops ops;
732 static struct xp_ops2 ops2;
734 mutex_lock(&ops_lock);
735 if (ops.xp_recv == NULL) {
736 ops.xp_recv = rendezvous_request;
737 ops.xp_stat = rendezvous_stat;
739 (bool_t (*)(SVCXPRT *, xdrproc_t, void *))abort;
741 (bool_t (*)(SVCXPRT *, struct rpc_msg *))abort;
743 (bool_t (*)(SVCXPRT *, xdrproc_t, void *))abort;
744 ops.xp_destroy = svc_vc_destroy;
745 ops2.xp_control = svc_vc_rendezvous_control;
748 xprt->xp_ops2 = &ops2;
749 mutex_unlock(&ops_lock);
753 * Get the effective UID of the sending process. Used by rpcbind, keyserv
754 * and rpc.yppasswdd on AF_LOCAL.
757 __rpc_get_local_uid(SVCXPRT *transp, uid_t *uid) {
763 sock = transp->xp_fd;
764 sa = (struct sockaddr *)transp->xp_rtaddr.buf;
765 if (sa->sa_family == AF_LOCAL) {
766 ret = getpeereid(sock, &euid, &egid);
775 * Destroy xprts that have not have had any activity in 'timeout' seconds.
776 * If 'cleanblock' is true, blocking connections (the default) are also
777 * cleaned. If timeout is 0, the least active connection is picked.
780 __svc_clean_idle(fd_set *fds, int timeout, bool_t cleanblock)
783 SVCXPRT *xprt, *least_active;
784 struct timeval tv, tdiff, tmax;
787 gettimeofday(&tv, NULL);
788 tmax.tv_sec = tmax.tv_usec = 0;
790 rwlock_wrlock(&svc_fd_lock);
791 for (i = ncleaned = 0; i <= svc_maxfd; i++) {
792 if (FD_ISSET(i, fds)) {
793 xprt = __svc_xports[i];
794 if (xprt == NULL || xprt->xp_ops == NULL ||
795 xprt->xp_ops->xp_recv != svc_vc_recv)
797 cd = (struct cf_conn *)xprt->xp_p1;
798 if (!cleanblock && !cd->nonblock)
801 timersub(&tv, &cd->last_recv_time, &tdiff);
802 if (timercmp(&tdiff, &tmax, >)) {
808 if (tv.tv_sec - cd->last_recv_time.tv_sec > timeout) {
809 __xprt_unregister_unlocked(xprt);
810 __svc_vc_dodestroy(xprt);
815 if (timeout == 0 && least_active != NULL) {
816 __xprt_unregister_unlocked(least_active);
817 __svc_vc_dodestroy(least_active);
820 rwlock_unlock(&svc_fd_lock);
821 return ncleaned > 0 ? TRUE : FALSE;