2 * Copyright (c) 2009, Sun Microsystems, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * - Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
9 * - Redistributions in binary form must reproduce the above copyright notice,
10 * this list of conditions and the following disclaimer in the documentation
11 * and/or other materials provided with the distribution.
12 * - Neither the name of Sun Microsystems, Inc. nor the names of its
13 * contributors may be used to endorse or promote products derived
14 * from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
28 * @(#)svc_tcp.c 1.21 87/08/11 Copyr 1984 Sun Micro
29 * @(#)svc_tcp.c 2.2 88/08/01 4.0 RPCSRC
30 * $NetBSD: svc_vc.c,v 1.7 2000/08/03 00:01:53 fvdl Exp $
31 * $FreeBSD: src/lib/libc/rpc/svc_vc.c,v 1.27 2008/03/30 09:36:17 dfr Exp $
35 * svc_vc.c, Server side for Connection Oriented based RPC.
37 * Actually implements two flavors of transporter -
38 * a tcp rendezvouser (a listner and connection establisher)
39 * and a record/tcp stream.
42 #include "namespace.h"
43 #include "reentrant.h"
44 #include <sys/types.h>
45 #include <sys/param.h>
47 #include <sys/socket.h>
51 #include <netinet/in.h>
52 #include <netinet/tcp.h>
67 #include "un-namespace.h"
69 static SVCXPRT *makefd_xprt(int, u_int, u_int);
70 static bool_t rendezvous_request(SVCXPRT *, struct rpc_msg *);
71 static enum xprt_stat rendezvous_stat(SVCXPRT *);
72 static void svc_vc_destroy(SVCXPRT *);
73 static void __svc_vc_dodestroy (SVCXPRT *);
74 static int read_vc(void *, void *, int);
75 static int write_vc(void *, void *, int);
76 static enum xprt_stat svc_vc_stat(SVCXPRT *);
77 static bool_t svc_vc_recv(SVCXPRT *, struct rpc_msg *);
78 static bool_t svc_vc_getargs(SVCXPRT *, xdrproc_t, void *);
79 static bool_t svc_vc_freeargs(SVCXPRT *, xdrproc_t, void *);
80 static bool_t svc_vc_reply(SVCXPRT *, struct rpc_msg *);
81 static void svc_vc_rendezvous_ops(SVCXPRT *);
82 static void svc_vc_ops(SVCXPRT *);
83 static bool_t svc_vc_control(SVCXPRT *xprt, const u_int rq, void *in);
84 static bool_t svc_vc_rendezvous_control(SVCXPRT *xprt, const u_int rq,
87 struct cf_rendezvous { /* kept in xprt->xp_p1 for rendezvouser */
93 struct cf_conn { /* kept in xprt->xp_p1 for actual connection */
94 enum xprt_stat strm_stat;
97 char verf_body[MAX_AUTH_BYTES];
102 struct timeval last_recv_time;
107 * xprt = svc_vc_create(sock, send_buf_size, recv_buf_size);
109 * Creates, registers, and returns a (rpc) tcp based transporter.
110 * Once *xprt is initialized, it is registered as a transporter
111 * see (svc.h, xprt_register). This routine returns
112 * a NULL if a problem occurred.
114 * The filedescriptor passed in is expected to refer to a bound, but
115 * not yet connected socket.
117 * Since streams do buffered io similar to stdio, the caller can specify
118 * how big the send and receive buffers are via the second and third parms;
119 * 0 => use the system default.
122 svc_vc_create(int fd, u_int sendsize, u_int recvsize)
124 SVCXPRT *xprt = NULL;
125 struct cf_rendezvous *r = NULL;
126 struct __rpc_sockinfo si;
127 struct sockaddr_storage sslocal;
130 if (!__rpc_fd2sockinfo(fd, &si))
133 r = mem_alloc(sizeof(*r));
135 warnx("svc_vc_create: out of memory");
136 goto cleanup_svc_vc_create;
138 r->sendsize = __rpc_get_t_size(si.si_af, si.si_proto, (int)sendsize);
139 r->recvsize = __rpc_get_t_size(si.si_af, si.si_proto, (int)recvsize);
140 r->maxrec = __svc_maxrec;
141 xprt = mem_alloc(sizeof(SVCXPRT));
143 warnx("svc_vc_create: out of memory");
144 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 = mem_alloc(sizeof(SVCXPRT));
250 warnx("svc_vc: makefd_xprt: out of memory");
253 memset(xprt, 0, sizeof *xprt);
254 cd = mem_alloc(sizeof(struct cf_conn));
256 warnx("svc_tcp: makefd_xprt: out of memory");
257 mem_free(xprt, sizeof(SVCXPRT));
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;
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;
351 gettimeofday(&cd->last_recv_time, NULL);
353 return (FALSE); /* there is never an rpc msg to be processed */
357 static enum xprt_stat
358 rendezvous_stat(SVCXPRT *xprt __unused)
365 svc_vc_destroy(SVCXPRT *xprt)
367 assert(xprt != NULL);
369 xprt_unregister(xprt);
370 __svc_vc_dodestroy(xprt);
374 __svc_vc_dodestroy(SVCXPRT *xprt)
377 struct cf_rendezvous *r;
379 cd = (struct cf_conn *)xprt->xp_p1;
381 if (xprt->xp_fd != RPC_ANYFD)
383 if (xprt->xp_port != 0) {
384 /* a rendezvouser socket */
385 r = (struct cf_rendezvous *)xprt->xp_p1;
386 mem_free(r, sizeof (struct cf_rendezvous));
389 /* an actual connection socket */
390 XDR_DESTROY(&(cd->xdrs));
391 mem_free(cd, sizeof(struct cf_conn));
393 if (xprt->xp_rtaddr.buf)
394 mem_free(xprt->xp_rtaddr.buf, xprt->xp_rtaddr.maxlen);
395 if (xprt->xp_ltaddr.buf)
396 mem_free(xprt->xp_ltaddr.buf, xprt->xp_ltaddr.maxlen);
400 free(xprt->xp_netid);
401 mem_free(xprt, sizeof(SVCXPRT));
406 svc_vc_control(SVCXPRT *xprt __unused, const u_int rq __unused,
413 svc_vc_rendezvous_control(SVCXPRT *xprt, const u_int rq, void *in)
415 struct cf_rendezvous *cfp;
417 cfp = (struct cf_rendezvous *)xprt->xp_p1;
421 case SVCGET_CONNMAXREC:
422 *(int *)in = cfp->maxrec;
424 case SVCSET_CONNMAXREC:
425 cfp->maxrec = *(int *)in;
434 * reads data from the tcp or uip connection.
435 * any error is fatal and the connection is closed.
436 * (And a read of zero bytes is a half closed stream => error.)
437 * All read operations timeout after 35 seconds. A timeout is
438 * fatal for the connection.
441 read_vc(void *xprtp, void *buf, int len)
445 int milliseconds = 35 * 1000;
446 struct pollfd pollfd;
449 xprt = (SVCXPRT *)xprtp;
450 assert(xprt != NULL);
454 cfp = (struct cf_conn *)xprt->xp_p1;
457 len = _read(sock, buf, (size_t)len);
465 gettimeofday(&cfp->last_recv_time, NULL);
471 pollfd.events = POLLIN;
473 switch (_poll(&pollfd, 1, milliseconds)) {
484 } while ((pollfd.revents & POLLIN) == 0);
486 if ((len = _read(sock, buf, (size_t)len)) > 0) {
487 gettimeofday(&cfp->last_recv_time, NULL);
492 ((struct cf_conn *)(xprt->xp_p1))->strm_stat = XPRT_DIED;
497 * writes data to the tcp connection.
498 * Any error is fatal and the connection is closed.
501 write_vc(void *xprtp, void *buf, int len)
506 struct timeval tv0, tv1;
508 xprt = (SVCXPRT *)xprtp;
509 assert(xprt != NULL);
511 cd = (struct cf_conn *)xprt->xp_p1;
514 gettimeofday(&tv0, NULL);
516 for (cnt = len; cnt > 0; cnt -= i, buf = (char *)buf + i) {
517 i = _write(xprt->xp_fd, buf, (size_t)cnt);
519 if (errno != EAGAIN || !cd->nonblock) {
520 cd->strm_stat = XPRT_DIED;
523 if (cd->nonblock && i != cnt) {
525 * For non-blocking connections, do not
526 * take more than 2 seconds writing the
529 * XXX 2 is an arbitrary amount.
531 gettimeofday(&tv1, NULL);
532 if (tv1.tv_sec - tv0.tv_sec >= 2) {
533 cd->strm_stat = XPRT_DIED;
543 static enum xprt_stat
544 svc_vc_stat(SVCXPRT *xprt)
548 assert(xprt != NULL);
550 cd = (struct cf_conn *)(xprt->xp_p1);
552 if (cd->strm_stat == XPRT_DIED)
554 if (! xdrrec_eof(&(cd->xdrs)))
555 return (XPRT_MOREREQS);
560 svc_vc_recv(SVCXPRT *xprt, struct rpc_msg *msg)
565 assert(xprt != NULL);
568 cd = (struct cf_conn *)(xprt->xp_p1);
572 if (!__xdrrec_getrec(xdrs, &cd->strm_stat, TRUE))
575 xdrrec_skiprecord(xdrs);
578 xdrs->x_op = XDR_DECODE;
579 if (xdr_callmsg(xdrs, msg)) {
580 cd->x_id = msg->rm_xid;
583 cd->strm_stat = XPRT_DIED;
588 svc_vc_getargs(SVCXPRT *xprt, xdrproc_t xdr_args, void *args_ptr)
591 assert(xprt != NULL);
592 /* args_ptr may be NULL */
593 return ((*xdr_args)(&(((struct cf_conn *)(xprt->xp_p1))->xdrs),
598 svc_vc_freeargs(SVCXPRT *xprt, xdrproc_t xdr_args, void *args_ptr)
602 assert(xprt != NULL);
603 /* args_ptr may be NULL */
605 xdrs = &(((struct cf_conn *)(xprt->xp_p1))->xdrs);
607 xdrs->x_op = XDR_FREE;
608 return ((*xdr_args)(xdrs, args_ptr));
612 svc_vc_reply(SVCXPRT *xprt, struct rpc_msg *msg)
618 assert(xprt != NULL);
621 cd = (struct cf_conn *)(xprt->xp_p1);
624 xdrs->x_op = XDR_ENCODE;
625 msg->rm_xid = cd->x_id;
626 rstat = xdr_replymsg(xdrs, msg);
627 xdrrec_endofrecord(xdrs, TRUE);
632 svc_vc_ops(SVCXPRT *xprt)
634 static struct xp_ops ops;
635 static struct xp_ops2 ops2;
637 /* VARIABLES PROTECTED BY ops_lock: ops, ops2 */
639 mutex_lock(&ops_lock);
640 if (ops.xp_recv == NULL) {
641 ops.xp_recv = svc_vc_recv;
642 ops.xp_stat = svc_vc_stat;
643 ops.xp_getargs = svc_vc_getargs;
644 ops.xp_reply = svc_vc_reply;
645 ops.xp_freeargs = svc_vc_freeargs;
646 ops.xp_destroy = svc_vc_destroy;
647 ops2.xp_control = svc_vc_control;
650 xprt->xp_ops2 = &ops2;
651 mutex_unlock(&ops_lock);
655 svc_vc_rendezvous_ops(SVCXPRT *xprt)
657 static struct xp_ops ops;
658 static struct xp_ops2 ops2;
660 mutex_lock(&ops_lock);
661 if (ops.xp_recv == NULL) {
662 ops.xp_recv = rendezvous_request;
663 ops.xp_stat = rendezvous_stat;
665 (bool_t (*)(SVCXPRT *, xdrproc_t, void *))abort;
667 (bool_t (*)(SVCXPRT *, struct rpc_msg *))abort;
669 (bool_t (*)(SVCXPRT *, xdrproc_t, void *))abort;
670 ops.xp_destroy = svc_vc_destroy;
671 ops2.xp_control = svc_vc_rendezvous_control;
674 xprt->xp_ops2 = &ops2;
675 mutex_unlock(&ops_lock);
679 * Get the effective UID of the sending process. Used by rpcbind, keyserv
680 * and rpc.yppasswdd on AF_LOCAL.
683 __rpc_get_local_uid(SVCXPRT *transp, uid_t *uid)
690 sock = transp->xp_fd;
691 sa = (struct sockaddr *)transp->xp_rtaddr.buf;
692 if (sa->sa_family == AF_LOCAL) {
693 ret = getpeereid(sock, &euid, &egid);
702 * Destroy xprts that have not have had any activity in 'timeout' seconds.
703 * If 'cleanblock' is true, blocking connections (the default) are also
704 * cleaned. If timeout is 0, the least active connection is picked.
707 __svc_clean_idle(fd_set *fds, int timeout, bool_t cleanblock)
710 SVCXPRT *xprt, *least_active;
711 struct timeval tv, tdiff, tmax;
714 gettimeofday(&tv, NULL);
715 tmax.tv_sec = tmax.tv_usec = 0;
717 rwlock_wrlock(&svc_fd_lock);
718 for (i = ncleaned = 0; i <= svc_maxfd; i++) {
719 if (FD_ISSET(i, fds)) {
720 xprt = __svc_xports[i];
721 if (xprt == NULL || xprt->xp_ops == NULL ||
722 xprt->xp_ops->xp_recv != svc_vc_recv)
724 cd = (struct cf_conn *)xprt->xp_p1;
725 if (!cleanblock && !cd->nonblock)
728 timersub(&tv, &cd->last_recv_time, &tdiff);
729 if (timercmp(&tdiff, &tmax, >)) {
735 if (tv.tv_sec - cd->last_recv_time.tv_sec > timeout) {
736 __xprt_unregister_unlocked(xprt);
737 __svc_vc_dodestroy(xprt);
742 if (timeout == 0 && least_active != NULL) {
743 __xprt_unregister_unlocked(least_active);
744 __svc_vc_dodestroy(least_active);
747 rwlock_unlock(&svc_fd_lock);
748 return ncleaned > 0 ? TRUE : FALSE;