1 /* $NetBSD: svc_vc.c,v 1.7 2000/08/03 00:01:53 fvdl Exp $ */
4 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
5 * unrestricted use provided that this legend is included on all tape
6 * media and as a part of the software program in whole or part. Users
7 * may copy or modify Sun RPC without charge, but are not authorized
8 * to license or distribute it to anyone else except as part of a product or
9 * program developed by the user.
11 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
12 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
13 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
15 * Sun RPC is provided with no support and without any obligation on the
16 * part of Sun Microsystems, Inc. to assist in its use, correction,
17 * modification or enhancement.
19 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
20 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
21 * OR ANY PART THEREOF.
23 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
24 * or profits or other special, indirect and consequential damages, even if
25 * Sun has been advised of the possibility of such damages.
27 * Sun Microsystems, Inc.
29 * Mountain View, California 94043
32 #if defined(LIBC_SCCS) && !defined(lint)
33 static char *sccsid2 = "@(#)svc_tcp.c 1.21 87/08/11 Copyr 1984 Sun Micro";
34 static char *sccsid = "@(#)svc_tcp.c 2.2 88/08/01 4.0 RPCSRC";
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
40 * svc_vc.c, Server side for Connection Oriented based RPC.
42 * Actually implements two flavors of transporter -
43 * a tcp rendezvouser (a listner and connection establisher)
44 * and a record/tcp stream.
47 #include "namespace.h"
48 #include "reentrant.h"
49 #include <sys/types.h>
50 #include <sys/param.h>
52 #include <sys/socket.h>
56 #include <netinet/in.h>
57 #include <netinet/tcp.h>
72 #include "un-namespace.h"
74 static SVCXPRT *makefd_xprt(int, u_int, u_int);
75 static bool_t rendezvous_request(SVCXPRT *, struct rpc_msg *);
76 static enum xprt_stat rendezvous_stat(SVCXPRT *);
77 static void svc_vc_destroy(SVCXPRT *);
78 static void __svc_vc_dodestroy (SVCXPRT *);
79 static int read_vc(void *, void *, int);
80 static int write_vc(void *, void *, int);
81 static enum xprt_stat svc_vc_stat(SVCXPRT *);
82 static bool_t svc_vc_recv(SVCXPRT *, struct rpc_msg *);
83 static bool_t svc_vc_getargs(SVCXPRT *, xdrproc_t, void *);
84 static bool_t svc_vc_freeargs(SVCXPRT *, xdrproc_t, void *);
85 static bool_t svc_vc_reply(SVCXPRT *, struct rpc_msg *);
86 static void svc_vc_rendezvous_ops(SVCXPRT *);
87 static void svc_vc_ops(SVCXPRT *);
88 static bool_t svc_vc_control(SVCXPRT *xprt, const u_int rq, void *in);
89 static bool_t svc_vc_rendezvous_control (SVCXPRT *xprt, const u_int rq,
92 struct cf_rendezvous { /* kept in xprt->xp_p1 for rendezvouser */
98 struct cf_conn { /* kept in xprt->xp_p1 for actual connection */
99 enum xprt_stat strm_stat;
102 char verf_body[MAX_AUTH_BYTES];
107 struct timeval last_recv_time;
112 * xprt = svc_vc_create(sock, send_buf_size, recv_buf_size);
114 * Creates, registers, and returns a (rpc) tcp based transporter.
115 * Once *xprt is initialized, it is registered as a transporter
116 * see (svc.h, xprt_register). This routine returns
117 * a NULL if a problem occurred.
119 * The filedescriptor passed in is expected to refer to a bound, but
120 * not yet connected socket.
122 * Since streams do buffered io similar to stdio, the caller can specify
123 * how big the send and receive buffers are via the second and third parms;
124 * 0 => use the system default.
127 svc_vc_create(fd, sendsize, recvsize)
133 struct cf_rendezvous *r = NULL;
134 struct __rpc_sockinfo si;
135 struct sockaddr_storage sslocal;
138 if (!__rpc_fd2sockinfo(fd, &si))
141 r = mem_alloc(sizeof(*r));
143 warnx("svc_vc_create: out of memory");
144 goto cleanup_svc_vc_create;
146 r->sendsize = __rpc_get_t_size(si.si_af, si.si_proto, (int)sendsize);
147 r->recvsize = __rpc_get_t_size(si.si_af, si.si_proto, (int)recvsize);
148 r->maxrec = __svc_maxrec;
149 xprt = svc_xprt_alloc();
151 warnx("svc_vc_create: out of memory");
152 goto cleanup_svc_vc_create;
155 xprt->xp_verf = _null_auth;
156 svc_vc_rendezvous_ops(xprt);
157 xprt->xp_port = (u_short)-1; /* It is the rendezvouser */
160 slen = sizeof (struct sockaddr_storage);
161 if (_getsockname(fd, (struct sockaddr *)(void *)&sslocal, &slen) < 0) {
162 warnx("svc_vc_create: could not retrieve local addr");
163 goto cleanup_svc_vc_create;
166 xprt->xp_ltaddr.maxlen = xprt->xp_ltaddr.len = sslocal.ss_len;
167 xprt->xp_ltaddr.buf = mem_alloc((size_t)sslocal.ss_len);
168 if (xprt->xp_ltaddr.buf == NULL) {
169 warnx("svc_vc_create: no mem for local addr");
170 goto cleanup_svc_vc_create;
172 memcpy(xprt->xp_ltaddr.buf, &sslocal, (size_t)sslocal.ss_len);
174 xprt->xp_rtaddr.maxlen = sizeof (struct sockaddr_storage);
177 cleanup_svc_vc_create:
179 mem_free(xprt, sizeof(*xprt));
181 mem_free(r, sizeof(*r));
186 * Like svtcp_create(), except the routine takes any *open* UNIX file
187 * descriptor as its first input.
190 svc_fd_create(fd, sendsize, recvsize)
195 struct sockaddr_storage ss;
201 ret = makefd_xprt(fd, sendsize, recvsize);
205 slen = sizeof (struct sockaddr_storage);
206 if (_getsockname(fd, (struct sockaddr *)(void *)&ss, &slen) < 0) {
207 warnx("svc_fd_create: could not retrieve local addr");
210 ret->xp_ltaddr.maxlen = ret->xp_ltaddr.len = ss.ss_len;
211 ret->xp_ltaddr.buf = mem_alloc((size_t)ss.ss_len);
212 if (ret->xp_ltaddr.buf == NULL) {
213 warnx("svc_fd_create: no mem for local addr");
216 memcpy(ret->xp_ltaddr.buf, &ss, (size_t)ss.ss_len);
218 slen = sizeof (struct sockaddr_storage);
219 if (_getpeername(fd, (struct sockaddr *)(void *)&ss, &slen) < 0) {
220 warnx("svc_fd_create: could not retrieve remote addr");
223 ret->xp_rtaddr.maxlen = ret->xp_rtaddr.len = ss.ss_len;
224 ret->xp_rtaddr.buf = mem_alloc((size_t)ss.ss_len);
225 if (ret->xp_rtaddr.buf == NULL) {
226 warnx("svc_fd_create: no mem for local addr");
229 memcpy(ret->xp_rtaddr.buf, &ss, (size_t)ss.ss_len);
231 if (ss.ss_family == AF_INET || ss.ss_family == AF_LOCAL) {
232 ret->xp_raddr = *(struct sockaddr_in *)ret->xp_rtaddr.buf;
233 ret->xp_addrlen = sizeof (struct sockaddr_in);
240 if (ret->xp_ltaddr.buf != NULL)
241 mem_free(ret->xp_ltaddr.buf, rep->xp_ltaddr.maxlen);
247 makefd_xprt(fd, sendsize, recvsize)
255 struct __rpc_sockinfo si;
259 xprt = svc_xprt_alloc();
261 warnx("svc_vc: makefd_xprt: out of memory");
264 cd = mem_alloc(sizeof(struct cf_conn));
266 warnx("svc_tcp: makefd_xprt: out of memory");
271 cd->strm_stat = XPRT_IDLE;
272 xdrrec_create(&(cd->xdrs), sendsize, recvsize,
273 xprt, read_vc, write_vc);
275 xprt->xp_verf.oa_base = cd->verf_body;
276 svc_vc_ops(xprt); /* truely deals with calls */
277 xprt->xp_port = 0; /* this is a connection, not a rendezvouser */
279 if (__rpc_fd2sockinfo(fd, &si) && __rpc_sockinfo2netid(&si, &netid))
280 xprt->xp_netid = strdup(netid);
289 rendezvous_request(xprt, msg)
294 struct cf_rendezvous *r;
296 struct sockaddr_storage addr;
298 struct __rpc_sockinfo si;
302 assert(xprt != NULL);
305 r = (struct cf_rendezvous *)xprt->xp_p1;
308 if ((sock = _accept(xprt->xp_fd, (struct sockaddr *)(void *)&addr,
313 * Clean out the most idle file descriptor when we're
316 if (errno == EMFILE || errno == ENFILE) {
317 cleanfds = svc_fdset;
318 __svc_clean_idle(&cleanfds, 0, FALSE);
324 * make a new transporter (re-uses xprt)
326 newxprt = makefd_xprt(sock, r->sendsize, r->recvsize);
327 newxprt->xp_rtaddr.buf = mem_alloc(len);
328 if (newxprt->xp_rtaddr.buf == NULL)
330 memcpy(newxprt->xp_rtaddr.buf, &addr, len);
331 newxprt->xp_rtaddr.len = len;
333 if (addr.ss_family == AF_INET || addr.ss_family == AF_LOCAL) {
334 newxprt->xp_raddr = *(struct sockaddr_in *)newxprt->xp_rtaddr.buf;
335 newxprt->xp_addrlen = sizeof (struct sockaddr_in);
338 if (__rpc_fd2sockinfo(sock, &si) && si.si_proto == IPPROTO_TCP) {
340 /* XXX fvdl - is this useful? */
341 _setsockopt(sock, IPPROTO_TCP, TCP_NODELAY, &len, sizeof (len));
344 cd = (struct cf_conn *)newxprt->xp_p1;
346 cd->recvsize = r->recvsize;
347 cd->sendsize = r->sendsize;
348 cd->maxrec = r->maxrec;
350 if (cd->maxrec != 0) {
351 flags = _fcntl(sock, F_GETFL, 0);
354 if (_fcntl(sock, F_SETFL, flags | O_NONBLOCK) == -1)
356 if (cd->recvsize > cd->maxrec)
357 cd->recvsize = cd->maxrec;
359 __xdrrec_setnonblock(&cd->xdrs, cd->maxrec);
361 cd->nonblock = FALSE;
363 gettimeofday(&cd->last_recv_time, NULL);
365 return (FALSE); /* there is never an rpc msg to be processed */
369 static enum xprt_stat
370 rendezvous_stat(xprt)
381 assert(xprt != NULL);
383 xprt_unregister(xprt);
384 __svc_vc_dodestroy(xprt);
388 __svc_vc_dodestroy(xprt)
392 struct cf_rendezvous *r;
394 cd = (struct cf_conn *)xprt->xp_p1;
396 if (xprt->xp_fd != RPC_ANYFD)
397 (void)_close(xprt->xp_fd);
398 if (xprt->xp_port != 0) {
399 /* a rendezvouser socket */
400 r = (struct cf_rendezvous *)xprt->xp_p1;
401 mem_free(r, sizeof (struct cf_rendezvous));
404 /* an actual connection socket */
405 XDR_DESTROY(&(cd->xdrs));
406 mem_free(cd, sizeof(struct cf_conn));
408 if (xprt->xp_rtaddr.buf)
409 mem_free(xprt->xp_rtaddr.buf, xprt->xp_rtaddr.maxlen);
410 if (xprt->xp_ltaddr.buf)
411 mem_free(xprt->xp_ltaddr.buf, xprt->xp_ltaddr.maxlen);
415 free(xprt->xp_netid);
421 svc_vc_control(xprt, rq, in)
430 svc_vc_rendezvous_control(xprt, rq, in)
435 struct cf_rendezvous *cfp;
437 cfp = (struct cf_rendezvous *)xprt->xp_p1;
441 case SVCGET_CONNMAXREC:
442 *(int *)in = cfp->maxrec;
444 case SVCSET_CONNMAXREC:
445 cfp->maxrec = *(int *)in;
454 * reads data from the tcp or uip connection.
455 * any error is fatal and the connection is closed.
456 * (And a read of zero bytes is a half closed stream => error.)
457 * All read operations timeout after 35 seconds. A timeout is
458 * fatal for the connection.
461 read_vc(xprtp, buf, len)
468 int milliseconds = 35 * 1000;
469 struct pollfd pollfd;
472 xprt = (SVCXPRT *)xprtp;
473 assert(xprt != NULL);
477 cfp = (struct cf_conn *)xprt->xp_p1;
480 len = _read(sock, buf, (size_t)len);
488 gettimeofday(&cfp->last_recv_time, NULL);
494 pollfd.events = POLLIN;
496 switch (_poll(&pollfd, 1, milliseconds)) {
507 } while ((pollfd.revents & POLLIN) == 0);
509 if ((len = _read(sock, buf, (size_t)len)) > 0) {
510 gettimeofday(&cfp->last_recv_time, NULL);
515 ((struct cf_conn *)(xprt->xp_p1))->strm_stat = XPRT_DIED;
520 * writes data to the tcp connection.
521 * Any error is fatal and the connection is closed.
524 write_vc(xprtp, buf, len)
532 struct timeval tv0, tv1;
534 xprt = (SVCXPRT *)xprtp;
535 assert(xprt != NULL);
537 cd = (struct cf_conn *)xprt->xp_p1;
540 gettimeofday(&tv0, NULL);
542 for (cnt = len; cnt > 0; cnt -= i, buf = (char *)buf + i) {
543 i = _write(xprt->xp_fd, buf, (size_t)cnt);
545 if (errno != EAGAIN || !cd->nonblock) {
546 cd->strm_stat = XPRT_DIED;
549 if (cd->nonblock && i != cnt) {
551 * For non-blocking connections, do not
552 * take more than 2 seconds writing the
555 * XXX 2 is an arbitrary amount.
557 gettimeofday(&tv1, NULL);
558 if (tv1.tv_sec - tv0.tv_sec >= 2) {
559 cd->strm_stat = XPRT_DIED;
569 static enum xprt_stat
575 assert(xprt != NULL);
577 cd = (struct cf_conn *)(xprt->xp_p1);
579 if (cd->strm_stat == XPRT_DIED)
581 if (! xdrrec_eof(&(cd->xdrs)))
582 return (XPRT_MOREREQS);
587 svc_vc_recv(xprt, msg)
594 assert(xprt != NULL);
597 cd = (struct cf_conn *)(xprt->xp_p1);
601 if (!__xdrrec_getrec(xdrs, &cd->strm_stat, TRUE))
604 (void)xdrrec_skiprecord(xdrs);
607 xdrs->x_op = XDR_DECODE;
608 if (xdr_callmsg(xdrs, msg)) {
609 cd->x_id = msg->rm_xid;
612 cd->strm_stat = XPRT_DIED;
617 svc_vc_getargs(xprt, xdr_args, args_ptr)
624 assert(xprt != NULL);
625 cd = (struct cf_conn *)(xprt->xp_p1);
626 return (SVCAUTH_UNWRAP(&SVC_AUTH(xprt),
627 &cd->xdrs, xdr_args, args_ptr));
631 svc_vc_freeargs(xprt, xdr_args, args_ptr)
638 assert(xprt != NULL);
639 /* args_ptr may be NULL */
641 xdrs = &(((struct cf_conn *)(xprt->xp_p1))->xdrs);
643 xdrs->x_op = XDR_FREE;
644 return ((*xdr_args)(xdrs, args_ptr));
648 svc_vc_reply(xprt, msg)
659 assert(xprt != NULL);
662 cd = (struct cf_conn *)(xprt->xp_p1);
665 xdrs->x_op = XDR_ENCODE;
666 msg->rm_xid = cd->x_id;
668 if (msg->rm_reply.rp_stat == MSG_ACCEPTED &&
669 msg->rm_reply.rp_acpt.ar_stat == SUCCESS) {
670 xdr_proc = msg->acpted_rply.ar_results.proc;
671 xdr_where = msg->acpted_rply.ar_results.where;
672 msg->acpted_rply.ar_results.proc = (xdrproc_t) xdr_void;
673 msg->acpted_rply.ar_results.where = NULL;
675 pos = XDR_GETPOS(xdrs);
676 if (!xdr_replymsg(xdrs, msg) ||
677 !SVCAUTH_WRAP(&SVC_AUTH(xprt), xdrs, xdr_proc, xdr_where)) {
678 XDR_SETPOS(xdrs, pos);
682 rstat = xdr_replymsg(xdrs, msg);
686 (void)xdrrec_endofrecord(xdrs, TRUE);
695 static struct xp_ops ops;
696 static struct xp_ops2 ops2;
698 /* VARIABLES PROTECTED BY ops_lock: ops, ops2 */
700 mutex_lock(&ops_lock);
701 if (ops.xp_recv == NULL) {
702 ops.xp_recv = svc_vc_recv;
703 ops.xp_stat = svc_vc_stat;
704 ops.xp_getargs = svc_vc_getargs;
705 ops.xp_reply = svc_vc_reply;
706 ops.xp_freeargs = svc_vc_freeargs;
707 ops.xp_destroy = svc_vc_destroy;
708 ops2.xp_control = svc_vc_control;
711 xprt->xp_ops2 = &ops2;
712 mutex_unlock(&ops_lock);
716 svc_vc_rendezvous_ops(xprt)
719 static struct xp_ops ops;
720 static struct xp_ops2 ops2;
722 mutex_lock(&ops_lock);
723 if (ops.xp_recv == NULL) {
724 ops.xp_recv = rendezvous_request;
725 ops.xp_stat = rendezvous_stat;
727 (bool_t (*)(SVCXPRT *, xdrproc_t, void *))abort;
729 (bool_t (*)(SVCXPRT *, struct rpc_msg *))abort;
731 (bool_t (*)(SVCXPRT *, xdrproc_t, void *))abort,
732 ops.xp_destroy = svc_vc_destroy;
733 ops2.xp_control = svc_vc_rendezvous_control;
736 xprt->xp_ops2 = &ops2;
737 mutex_unlock(&ops_lock);
741 * Get the effective UID of the sending process. Used by rpcbind, keyserv
742 * and rpc.yppasswdd on AF_LOCAL.
745 __rpc_get_local_uid(SVCXPRT *transp, uid_t *uid) {
751 sock = transp->xp_fd;
752 sa = (struct sockaddr *)transp->xp_rtaddr.buf;
753 if (sa->sa_family == AF_LOCAL) {
754 ret = getpeereid(sock, &euid, &egid);
763 * Destroy xprts that have not have had any activity in 'timeout' seconds.
764 * If 'cleanblock' is true, blocking connections (the default) are also
765 * cleaned. If timeout is 0, the least active connection is picked.
768 __svc_clean_idle(fd_set *fds, int timeout, bool_t cleanblock)
771 SVCXPRT *xprt, *least_active;
772 struct timeval tv, tdiff, tmax;
775 gettimeofday(&tv, NULL);
776 tmax.tv_sec = tmax.tv_usec = 0;
778 rwlock_wrlock(&svc_fd_lock);
779 for (i = ncleaned = 0; i <= svc_maxfd; i++) {
780 if (FD_ISSET(i, fds)) {
781 xprt = __svc_xports[i];
782 if (xprt == NULL || xprt->xp_ops == NULL ||
783 xprt->xp_ops->xp_recv != svc_vc_recv)
785 cd = (struct cf_conn *)xprt->xp_p1;
786 if (!cleanblock && !cd->nonblock)
789 timersub(&tv, &cd->last_recv_time, &tdiff);
790 if (timercmp(&tdiff, &tmax, >)) {
796 if (tv.tv_sec - cd->last_recv_time.tv_sec > timeout) {
797 __xprt_unregister_unlocked(xprt);
798 __svc_vc_dodestroy(xprt);
803 if (timeout == 0 && least_active != NULL) {
804 __xprt_unregister_unlocked(least_active);
805 __svc_vc_dodestroy(least_active);
808 rwlock_unlock(&svc_fd_lock);
809 return ncleaned > 0 ? TRUE : FALSE;