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/param.h>
50 #include <sys/socket.h>
54 #include <netinet/in.h>
55 #include <netinet/tcp.h>
70 #include "un-namespace.h"
72 static SVCXPRT *makefd_xprt(int, u_int, u_int);
73 static bool_t rendezvous_request(SVCXPRT *, struct rpc_msg *);
74 static enum xprt_stat rendezvous_stat(SVCXPRT *);
75 static void svc_vc_destroy(SVCXPRT *);
76 static void __svc_vc_dodestroy (SVCXPRT *);
77 static int read_vc(void *, void *, int);
78 static int write_vc(void *, void *, int);
79 static enum xprt_stat svc_vc_stat(SVCXPRT *);
80 static bool_t svc_vc_recv(SVCXPRT *, struct rpc_msg *);
81 static bool_t svc_vc_getargs(SVCXPRT *, xdrproc_t, void *);
82 static bool_t svc_vc_freeargs(SVCXPRT *, xdrproc_t, void *);
83 static bool_t svc_vc_reply(SVCXPRT *, struct rpc_msg *);
84 static void svc_vc_rendezvous_ops(SVCXPRT *);
85 static void svc_vc_ops(SVCXPRT *);
86 static bool_t svc_vc_control(SVCXPRT *xprt, const u_int rq, void *in);
87 static bool_t svc_vc_rendezvous_control (SVCXPRT *xprt, const u_int rq,
90 struct cf_rendezvous { /* kept in xprt->xp_p1 for rendezvouser */
96 struct cf_conn { /* kept in xprt->xp_p1 for actual connection */
97 enum xprt_stat strm_stat;
100 char verf_body[MAX_AUTH_BYTES];
105 struct timeval last_recv_time;
110 * xprt = svc_vc_create(sock, send_buf_size, recv_buf_size);
112 * Creates, registers, and returns a (rpc) tcp based transporter.
113 * Once *xprt is initialized, it is registered as a transporter
114 * see (svc.h, xprt_register). This routine returns
115 * a NULL if a problem occurred.
117 * The filedescriptor passed in is expected to refer to a bound, but
118 * not yet connected socket.
120 * Since streams do buffered io similar to stdio, the caller can specify
121 * how big the send and receive buffers are via the second and third parms;
122 * 0 => use the system default.
125 svc_vc_create(int fd, u_int sendsize, u_int recvsize)
127 SVCXPRT *xprt = NULL;
128 struct cf_rendezvous *r = NULL;
129 struct __rpc_sockinfo si;
130 struct sockaddr_storage sslocal;
133 if (!__rpc_fd2sockinfo(fd, &si))
136 r = mem_alloc(sizeof(*r));
138 warnx("svc_vc_create: out of memory");
139 goto cleanup_svc_vc_create;
141 r->sendsize = __rpc_get_t_size(si.si_af, si.si_proto, (int)sendsize);
142 r->recvsize = __rpc_get_t_size(si.si_af, si.si_proto, (int)recvsize);
143 r->maxrec = __svc_maxrec;
144 xprt = svc_xprt_alloc();
146 warnx("svc_vc_create: out of memory");
147 goto cleanup_svc_vc_create;
150 xprt->xp_verf = _null_auth;
151 svc_vc_rendezvous_ops(xprt);
152 xprt->xp_port = (u_short)-1; /* It is the rendezvouser */
155 slen = sizeof (struct sockaddr_storage);
156 if (_getsockname(fd, (struct sockaddr *)(void *)&sslocal, &slen) < 0) {
157 warnx("svc_vc_create: could not retrieve local addr");
158 goto cleanup_svc_vc_create;
161 xprt->xp_ltaddr.maxlen = xprt->xp_ltaddr.len = sslocal.ss_len;
162 xprt->xp_ltaddr.buf = mem_alloc((size_t)sslocal.ss_len);
163 if (xprt->xp_ltaddr.buf == NULL) {
164 warnx("svc_vc_create: no mem for local addr");
165 goto cleanup_svc_vc_create;
167 memcpy(xprt->xp_ltaddr.buf, &sslocal, (size_t)sslocal.ss_len);
169 xprt->xp_rtaddr.maxlen = sizeof (struct sockaddr_storage);
172 cleanup_svc_vc_create:
174 mem_free(xprt, sizeof(*xprt));
176 mem_free(r, sizeof(*r));
181 * Like svtcp_create(), except the routine takes any *open* UNIX file
182 * descriptor as its first input.
185 svc_fd_create(int fd, u_int sendsize, u_int recvsize)
187 struct sockaddr_storage ss;
193 ret = makefd_xprt(fd, sendsize, recvsize);
197 slen = sizeof (struct sockaddr_storage);
198 if (_getsockname(fd, (struct sockaddr *)(void *)&ss, &slen) < 0) {
199 warnx("svc_fd_create: could not retrieve local addr");
202 ret->xp_ltaddr.maxlen = ret->xp_ltaddr.len = ss.ss_len;
203 ret->xp_ltaddr.buf = mem_alloc((size_t)ss.ss_len);
204 if (ret->xp_ltaddr.buf == NULL) {
205 warnx("svc_fd_create: no mem for local addr");
208 memcpy(ret->xp_ltaddr.buf, &ss, (size_t)ss.ss_len);
210 slen = sizeof (struct sockaddr_storage);
211 if (_getpeername(fd, (struct sockaddr *)(void *)&ss, &slen) < 0) {
212 warnx("svc_fd_create: could not retrieve remote addr");
215 ret->xp_rtaddr.maxlen = ret->xp_rtaddr.len = ss.ss_len;
216 ret->xp_rtaddr.buf = mem_alloc((size_t)ss.ss_len);
217 if (ret->xp_rtaddr.buf == NULL) {
218 warnx("svc_fd_create: no mem for local addr");
221 memcpy(ret->xp_rtaddr.buf, &ss, (size_t)ss.ss_len);
223 if (ss.ss_family == AF_INET || ss.ss_family == AF_LOCAL) {
224 ret->xp_raddr = *(struct sockaddr_in *)ret->xp_rtaddr.buf;
225 ret->xp_addrlen = sizeof (struct sockaddr_in);
232 if (ret->xp_ltaddr.buf != NULL)
233 mem_free(ret->xp_ltaddr.buf, rep->xp_ltaddr.maxlen);
239 makefd_xprt(int fd, u_int sendsize, u_int recvsize)
244 struct __rpc_sockinfo si;
248 xprt = svc_xprt_alloc();
250 warnx("svc_vc: makefd_xprt: out of memory");
253 cd = mem_alloc(sizeof(struct cf_conn));
255 warnx("svc_tcp: makefd_xprt: out of memory");
260 cd->strm_stat = XPRT_IDLE;
261 xdrrec_create(&(cd->xdrs), sendsize, recvsize,
262 xprt, read_vc, write_vc);
264 xprt->xp_verf.oa_base = cd->verf_body;
265 svc_vc_ops(xprt); /* truly deals with calls */
266 xprt->xp_port = 0; /* this is a connection, not a rendezvouser */
268 if (__rpc_fd2sockinfo(fd, &si) && __rpc_sockinfo2netid(&si, &netid))
269 xprt->xp_netid = strdup(netid);
278 rendezvous_request(SVCXPRT *xprt, struct rpc_msg *msg)
281 struct cf_rendezvous *r;
283 struct sockaddr_storage addr, sslocal;
285 struct __rpc_sockinfo si;
289 assert(xprt != NULL);
292 r = (struct cf_rendezvous *)xprt->xp_p1;
295 if ((sock = _accept(xprt->xp_fd, (struct sockaddr *)(void *)&addr,
300 * Clean out the most idle file descriptor when we're
303 if (errno == EMFILE || errno == ENFILE) {
304 cleanfds = svc_fdset;
305 __svc_clean_idle(&cleanfds, 0, FALSE);
311 * make a new transporter (re-uses xprt)
313 newxprt = makefd_xprt(sock, r->sendsize, r->recvsize);
314 newxprt->xp_rtaddr.buf = mem_alloc(len);
315 if (newxprt->xp_rtaddr.buf == NULL)
317 memcpy(newxprt->xp_rtaddr.buf, &addr, len);
318 newxprt->xp_rtaddr.len = len;
320 if (addr.ss_family == AF_INET || addr.ss_family == AF_LOCAL) {
321 newxprt->xp_raddr = *(struct sockaddr_in *)newxprt->xp_rtaddr.buf;
322 newxprt->xp_addrlen = sizeof (struct sockaddr_in);
325 if (__rpc_fd2sockinfo(sock, &si) && si.si_proto == IPPROTO_TCP) {
327 /* XXX fvdl - is this useful? */
328 _setsockopt(sock, IPPROTO_TCP, TCP_NODELAY, &len, sizeof (len));
331 cd = (struct cf_conn *)newxprt->xp_p1;
333 cd->recvsize = r->recvsize;
334 cd->sendsize = r->sendsize;
335 cd->maxrec = r->maxrec;
337 if (cd->maxrec != 0) {
338 flags = _fcntl(sock, F_GETFL, 0);
341 if (_fcntl(sock, F_SETFL, flags | O_NONBLOCK) == -1)
343 if (cd->recvsize > cd->maxrec)
344 cd->recvsize = cd->maxrec;
346 __xdrrec_setnonblock(&cd->xdrs, cd->maxrec);
348 cd->nonblock = FALSE;
349 slen = sizeof(struct sockaddr_storage);
350 if(_getsockname(sock, (struct sockaddr *)(void *)&sslocal, &slen) < 0) {
351 warnx("svc_vc_create: could not retrieve local addr");
352 newxprt->xp_ltaddr.maxlen = newxprt->xp_ltaddr.len = 0;
354 newxprt->xp_ltaddr.maxlen = newxprt->xp_ltaddr.len = sslocal.ss_len;
355 newxprt->xp_ltaddr.buf = mem_alloc((size_t)sslocal.ss_len);
356 if (newxprt->xp_ltaddr.buf == NULL) {
357 warnx("svc_vc_create: no mem for local addr");
358 newxprt->xp_ltaddr.maxlen = newxprt->xp_ltaddr.len = 0;
360 memcpy(newxprt->xp_ltaddr.buf, &sslocal, (size_t)sslocal.ss_len);
364 gettimeofday(&cd->last_recv_time, NULL);
366 return (FALSE); /* there is never an rpc msg to be processed */
370 static enum xprt_stat
371 rendezvous_stat(SVCXPRT *xprt)
378 svc_vc_destroy(SVCXPRT *xprt)
380 assert(xprt != NULL);
382 xprt_unregister(xprt);
383 __svc_vc_dodestroy(xprt);
387 __svc_vc_dodestroy(SVCXPRT *xprt)
390 struct cf_rendezvous *r;
392 cd = (struct cf_conn *)xprt->xp_p1;
394 if (xprt->xp_fd != RPC_ANYFD)
395 (void)_close(xprt->xp_fd);
396 if (xprt->xp_port != 0) {
397 /* a rendezvouser socket */
398 r = (struct cf_rendezvous *)xprt->xp_p1;
399 mem_free(r, sizeof (struct cf_rendezvous));
402 /* an actual connection socket */
403 XDR_DESTROY(&(cd->xdrs));
404 mem_free(cd, sizeof(struct cf_conn));
406 if (xprt->xp_rtaddr.buf)
407 mem_free(xprt->xp_rtaddr.buf, xprt->xp_rtaddr.maxlen);
408 if (xprt->xp_ltaddr.buf)
409 mem_free(xprt->xp_ltaddr.buf, xprt->xp_ltaddr.maxlen);
411 free(xprt->xp_netid);
417 svc_vc_control(SVCXPRT *xprt, const u_int rq, void *in)
423 svc_vc_rendezvous_control(SVCXPRT *xprt, const u_int rq, void *in)
425 struct cf_rendezvous *cfp;
427 cfp = (struct cf_rendezvous *)xprt->xp_p1;
431 case SVCGET_CONNMAXREC:
432 *(int *)in = cfp->maxrec;
434 case SVCSET_CONNMAXREC:
435 cfp->maxrec = *(int *)in;
444 * reads data from the tcp or uip connection.
445 * any error is fatal and the connection is closed.
446 * (And a read of zero bytes is a half closed stream => error.)
447 * All read operations timeout after 35 seconds. A timeout is
448 * fatal for the connection.
451 read_vc(void *xprtp, void *buf, int len)
455 int milliseconds = 35 * 1000;
456 struct pollfd pollfd;
459 xprt = (SVCXPRT *)xprtp;
460 assert(xprt != NULL);
464 cfp = (struct cf_conn *)xprt->xp_p1;
467 len = _read(sock, buf, (size_t)len);
475 gettimeofday(&cfp->last_recv_time, NULL);
481 pollfd.events = POLLIN;
483 switch (_poll(&pollfd, 1, milliseconds)) {
494 } while ((pollfd.revents & POLLIN) == 0);
496 if ((len = _read(sock, buf, (size_t)len)) > 0) {
497 gettimeofday(&cfp->last_recv_time, NULL);
502 ((struct cf_conn *)(xprt->xp_p1))->strm_stat = XPRT_DIED;
507 * writes data to the tcp connection.
508 * Any error is fatal and the connection is closed.
511 write_vc(void *xprtp, void *buf, int len)
516 struct timeval tv0, tv1;
518 xprt = (SVCXPRT *)xprtp;
519 assert(xprt != NULL);
521 cd = (struct cf_conn *)xprt->xp_p1;
524 gettimeofday(&tv0, NULL);
526 for (cnt = len; cnt > 0; cnt -= i, buf = (char *)buf + i) {
527 i = _write(xprt->xp_fd, buf, (size_t)cnt);
529 if (errno != EAGAIN || !cd->nonblock) {
530 cd->strm_stat = XPRT_DIED;
535 * For non-blocking connections, do not
536 * take more than 2 seconds writing the
539 * XXX 2 is an arbitrary amount.
541 gettimeofday(&tv1, NULL);
542 if (tv1.tv_sec - tv0.tv_sec >= 2) {
543 cd->strm_stat = XPRT_DIED;
554 static enum xprt_stat
555 svc_vc_stat(SVCXPRT *xprt)
559 assert(xprt != NULL);
561 cd = (struct cf_conn *)(xprt->xp_p1);
563 if (cd->strm_stat == XPRT_DIED)
565 if (! xdrrec_eof(&(cd->xdrs)))
566 return (XPRT_MOREREQS);
571 svc_vc_recv(SVCXPRT *xprt, struct rpc_msg *msg)
576 assert(xprt != NULL);
579 cd = (struct cf_conn *)(xprt->xp_p1);
583 if (!__xdrrec_getrec(xdrs, &cd->strm_stat, TRUE))
586 (void)xdrrec_skiprecord(xdrs);
589 xdrs->x_op = XDR_DECODE;
590 if (xdr_callmsg(xdrs, msg)) {
591 cd->x_id = msg->rm_xid;
594 cd->strm_stat = XPRT_DIED;
599 svc_vc_getargs(SVCXPRT *xprt, xdrproc_t xdr_args, void *args_ptr)
603 assert(xprt != NULL);
604 cd = (struct cf_conn *)(xprt->xp_p1);
605 return (SVCAUTH_UNWRAP(&SVC_AUTH(xprt),
606 &cd->xdrs, xdr_args, args_ptr));
610 svc_vc_freeargs(SVCXPRT *xprt, xdrproc_t xdr_args, void *args_ptr)
614 assert(xprt != NULL);
615 /* args_ptr may be NULL */
617 xdrs = &(((struct cf_conn *)(xprt->xp_p1))->xdrs);
619 xdrs->x_op = XDR_FREE;
620 return ((*xdr_args)(xdrs, args_ptr));
624 svc_vc_reply(SVCXPRT *xprt, struct rpc_msg *msg)
633 assert(xprt != NULL);
636 cd = (struct cf_conn *)(xprt->xp_p1);
639 xdrs->x_op = XDR_ENCODE;
640 msg->rm_xid = cd->x_id;
642 if (msg->rm_reply.rp_stat == MSG_ACCEPTED &&
643 msg->rm_reply.rp_acpt.ar_stat == SUCCESS) {
644 xdr_proc = msg->acpted_rply.ar_results.proc;
645 xdr_where = msg->acpted_rply.ar_results.where;
646 msg->acpted_rply.ar_results.proc = (xdrproc_t) xdr_void;
647 msg->acpted_rply.ar_results.where = NULL;
649 pos = XDR_GETPOS(xdrs);
650 if (!xdr_replymsg(xdrs, msg) ||
651 !SVCAUTH_WRAP(&SVC_AUTH(xprt), xdrs, xdr_proc, xdr_where)) {
652 XDR_SETPOS(xdrs, pos);
656 rstat = xdr_replymsg(xdrs, msg);
660 (void)xdrrec_endofrecord(xdrs, TRUE);
666 svc_vc_ops(SVCXPRT *xprt)
668 static struct xp_ops ops;
669 static struct xp_ops2 ops2;
671 /* VARIABLES PROTECTED BY ops_lock: ops, ops2 */
673 mutex_lock(&ops_lock);
674 if (ops.xp_recv == NULL) {
675 ops.xp_recv = svc_vc_recv;
676 ops.xp_stat = svc_vc_stat;
677 ops.xp_getargs = svc_vc_getargs;
678 ops.xp_reply = svc_vc_reply;
679 ops.xp_freeargs = svc_vc_freeargs;
680 ops.xp_destroy = svc_vc_destroy;
681 ops2.xp_control = svc_vc_control;
684 xprt->xp_ops2 = &ops2;
685 mutex_unlock(&ops_lock);
689 svc_vc_rendezvous_ops(SVCXPRT *xprt)
691 static struct xp_ops ops;
692 static struct xp_ops2 ops2;
694 mutex_lock(&ops_lock);
695 if (ops.xp_recv == NULL) {
696 ops.xp_recv = rendezvous_request;
697 ops.xp_stat = rendezvous_stat;
699 (bool_t (*)(SVCXPRT *, xdrproc_t, void *))abort;
701 (bool_t (*)(SVCXPRT *, struct rpc_msg *))abort;
703 (bool_t (*)(SVCXPRT *, xdrproc_t, void *))abort;
704 ops.xp_destroy = svc_vc_destroy;
705 ops2.xp_control = svc_vc_rendezvous_control;
708 xprt->xp_ops2 = &ops2;
709 mutex_unlock(&ops_lock);
713 * Get the effective UID of the sending process. Used by rpcbind, keyserv
714 * and rpc.yppasswdd on AF_LOCAL.
717 __rpc_get_local_uid(SVCXPRT *transp, uid_t *uid) {
723 sock = transp->xp_fd;
724 sa = (struct sockaddr *)transp->xp_rtaddr.buf;
725 if (sa->sa_family == AF_LOCAL) {
726 ret = getpeereid(sock, &euid, &egid);
735 * Destroy xprts that have not have had any activity in 'timeout' seconds.
736 * If 'cleanblock' is true, blocking connections (the default) are also
737 * cleaned. If timeout is 0, the least active connection is picked.
740 __svc_clean_idle(fd_set *fds, int timeout, bool_t cleanblock)
743 SVCXPRT *xprt, *least_active;
744 struct timeval tv, tdiff, tmax;
747 gettimeofday(&tv, NULL);
748 tmax.tv_sec = tmax.tv_usec = 0;
750 rwlock_wrlock(&svc_fd_lock);
751 for (i = ncleaned = 0; i <= svc_maxfd; i++) {
752 if (FD_ISSET(i, fds)) {
753 xprt = __svc_xports[i];
754 if (xprt == NULL || xprt->xp_ops == NULL ||
755 xprt->xp_ops->xp_recv != svc_vc_recv)
757 cd = (struct cf_conn *)xprt->xp_p1;
758 if (!cleanblock && !cd->nonblock)
761 timersub(&tv, &cd->last_recv_time, &tdiff);
762 if (timercmp(&tdiff, &tmax, >)) {
768 if (tv.tv_sec - cd->last_recv_time.tv_sec > timeout) {
769 __xprt_unregister_unlocked(xprt);
770 __svc_vc_dodestroy(xprt);
775 if (timeout == 0 && least_active != NULL) {
776 __xprt_unregister_unlocked(least_active);
777 __svc_vc_dodestroy(least_active);
780 rwlock_unlock(&svc_fd_lock);
781 return ncleaned > 0 ? TRUE : FALSE;