1 /* $NetBSD: svc_vc.c,v 1.7 2000/08/03 00:01:53 fvdl Exp $ */
4 * SPDX-License-Identifier: BSD-3-Clause
6 * Copyright (c) 2009, Sun Microsystems, Inc.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 * - Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
13 * - Redistributions in binary form must reproduce the above copyright notice,
14 * this list of conditions and the following disclaimer in the documentation
15 * and/or other materials provided with the distribution.
16 * - Neither the name of Sun Microsystems, Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
33 #if defined(LIBC_SCCS) && !defined(lint)
34 static char *sccsid2 = "@(#)svc_tcp.c 1.21 87/08/11 Copyr 1984 Sun Micro";
35 static char *sccsid = "@(#)svc_tcp.c 2.2 88/08/01 4.0 RPCSRC";
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
41 * svc_vc.c, Server side for Connection Oriented based RPC.
43 * Actually implements two flavors of transporter -
44 * a tcp rendezvouser (a listner and connection establisher)
45 * and a record/tcp stream.
48 #include "namespace.h"
49 #include "reentrant.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(int fd, u_int sendsize, u_int recvsize)
129 SVCXPRT *xprt = NULL;
130 struct cf_rendezvous *r = NULL;
131 struct __rpc_sockinfo si;
132 struct sockaddr_storage sslocal;
135 if (!__rpc_fd2sockinfo(fd, &si))
138 r = mem_alloc(sizeof(*r));
140 warnx("svc_vc_create: out of memory");
141 goto cleanup_svc_vc_create;
143 r->sendsize = __rpc_get_t_size(si.si_af, si.si_proto, (int)sendsize);
144 r->recvsize = __rpc_get_t_size(si.si_af, si.si_proto, (int)recvsize);
145 r->maxrec = __svc_maxrec;
146 xprt = svc_xprt_alloc();
148 warnx("svc_vc_create: out of memory");
149 goto cleanup_svc_vc_create;
152 xprt->xp_verf = _null_auth;
153 svc_vc_rendezvous_ops(xprt);
154 xprt->xp_port = (u_short)-1; /* It is the rendezvouser */
157 slen = sizeof (struct sockaddr_storage);
158 if (_getsockname(fd, (struct sockaddr *)(void *)&sslocal, &slen) < 0) {
159 warnx("svc_vc_create: could not retrieve local addr");
160 goto cleanup_svc_vc_create;
163 xprt->xp_ltaddr.maxlen = xprt->xp_ltaddr.len = sslocal.ss_len;
164 xprt->xp_ltaddr.buf = mem_alloc((size_t)sslocal.ss_len);
165 if (xprt->xp_ltaddr.buf == NULL) {
166 warnx("svc_vc_create: no mem for local addr");
167 goto cleanup_svc_vc_create;
169 memcpy(xprt->xp_ltaddr.buf, &sslocal, (size_t)sslocal.ss_len);
171 xprt->xp_rtaddr.maxlen = sizeof (struct sockaddr_storage);
174 cleanup_svc_vc_create:
176 mem_free(xprt, sizeof(*xprt));
178 mem_free(r, sizeof(*r));
183 * Like svtcp_create(), except the routine takes any *open* UNIX file
184 * descriptor as its first input.
187 svc_fd_create(int fd, u_int sendsize, u_int recvsize)
189 struct sockaddr_storage ss;
195 ret = makefd_xprt(fd, sendsize, recvsize);
199 slen = sizeof (struct sockaddr_storage);
200 if (_getsockname(fd, (struct sockaddr *)(void *)&ss, &slen) < 0) {
201 warnx("svc_fd_create: could not retrieve local addr");
204 ret->xp_ltaddr.maxlen = ret->xp_ltaddr.len = ss.ss_len;
205 ret->xp_ltaddr.buf = mem_alloc((size_t)ss.ss_len);
206 if (ret->xp_ltaddr.buf == NULL) {
207 warnx("svc_fd_create: no mem for local addr");
210 memcpy(ret->xp_ltaddr.buf, &ss, (size_t)ss.ss_len);
212 slen = sizeof (struct sockaddr_storage);
213 if (_getpeername(fd, (struct sockaddr *)(void *)&ss, &slen) < 0) {
214 warnx("svc_fd_create: could not retrieve remote addr");
217 ret->xp_rtaddr.maxlen = ret->xp_rtaddr.len = ss.ss_len;
218 ret->xp_rtaddr.buf = mem_alloc((size_t)ss.ss_len);
219 if (ret->xp_rtaddr.buf == NULL) {
220 warnx("svc_fd_create: no mem for local addr");
223 memcpy(ret->xp_rtaddr.buf, &ss, (size_t)ss.ss_len);
225 if (ss.ss_family == AF_INET || ss.ss_family == AF_LOCAL) {
226 ret->xp_raddr = *(struct sockaddr_in *)ret->xp_rtaddr.buf;
227 ret->xp_addrlen = sizeof (struct sockaddr_in);
234 if (ret->xp_ltaddr.buf != NULL)
235 mem_free(ret->xp_ltaddr.buf, rep->xp_ltaddr.maxlen);
241 makefd_xprt(int fd, u_int sendsize, u_int recvsize)
246 struct __rpc_sockinfo si;
250 xprt = svc_xprt_alloc();
252 warnx("svc_vc: makefd_xprt: out of memory");
255 cd = mem_alloc(sizeof(struct cf_conn));
257 warnx("svc_tcp: makefd_xprt: out of memory");
262 cd->strm_stat = XPRT_IDLE;
263 xdrrec_create(&(cd->xdrs), sendsize, recvsize,
264 xprt, read_vc, write_vc);
266 xprt->xp_verf.oa_base = cd->verf_body;
267 svc_vc_ops(xprt); /* truly deals with calls */
268 xprt->xp_port = 0; /* this is a connection, not a rendezvouser */
270 if (__rpc_fd2sockinfo(fd, &si) && __rpc_sockinfo2netid(&si, &netid))
271 xprt->xp_netid = strdup(netid);
280 rendezvous_request(SVCXPRT *xprt, struct rpc_msg *msg)
283 struct cf_rendezvous *r;
285 struct sockaddr_storage addr, sslocal;
287 struct __rpc_sockinfo si;
291 assert(xprt != NULL);
294 r = (struct cf_rendezvous *)xprt->xp_p1;
297 if ((sock = _accept(xprt->xp_fd, (struct sockaddr *)(void *)&addr,
302 * Clean out the most idle file descriptor when we're
305 if (errno == EMFILE || errno == ENFILE) {
306 cleanfds = svc_fdset;
307 __svc_clean_idle(&cleanfds, 0, FALSE);
313 * make a new transporter (re-uses xprt)
315 newxprt = makefd_xprt(sock, r->sendsize, r->recvsize);
316 newxprt->xp_rtaddr.buf = mem_alloc(len);
317 if (newxprt->xp_rtaddr.buf == NULL)
319 memcpy(newxprt->xp_rtaddr.buf, &addr, len);
320 newxprt->xp_rtaddr.len = len;
322 if (addr.ss_family == AF_INET || addr.ss_family == AF_LOCAL) {
323 newxprt->xp_raddr = *(struct sockaddr_in *)newxprt->xp_rtaddr.buf;
324 newxprt->xp_addrlen = sizeof (struct sockaddr_in);
327 if (__rpc_fd2sockinfo(sock, &si) && si.si_proto == IPPROTO_TCP) {
329 /* XXX fvdl - is this useful? */
330 _setsockopt(sock, IPPROTO_TCP, TCP_NODELAY, &len, sizeof (len));
333 cd = (struct cf_conn *)newxprt->xp_p1;
335 cd->recvsize = r->recvsize;
336 cd->sendsize = r->sendsize;
337 cd->maxrec = r->maxrec;
339 if (cd->maxrec != 0) {
340 flags = _fcntl(sock, F_GETFL, 0);
343 if (_fcntl(sock, F_SETFL, flags | O_NONBLOCK) == -1)
345 if (cd->recvsize > cd->maxrec)
346 cd->recvsize = cd->maxrec;
348 __xdrrec_setnonblock(&cd->xdrs, cd->maxrec);
350 cd->nonblock = FALSE;
351 slen = sizeof(struct sockaddr_storage);
352 if(_getsockname(sock, (struct sockaddr *)(void *)&sslocal, &slen) < 0) {
353 warnx("svc_vc_create: could not retrieve local addr");
354 newxprt->xp_ltaddr.maxlen = newxprt->xp_ltaddr.len = 0;
356 newxprt->xp_ltaddr.maxlen = newxprt->xp_ltaddr.len = sslocal.ss_len;
357 newxprt->xp_ltaddr.buf = mem_alloc((size_t)sslocal.ss_len);
358 if (newxprt->xp_ltaddr.buf == NULL) {
359 warnx("svc_vc_create: no mem for local addr");
360 newxprt->xp_ltaddr.maxlen = newxprt->xp_ltaddr.len = 0;
362 memcpy(newxprt->xp_ltaddr.buf, &sslocal, (size_t)sslocal.ss_len);
366 gettimeofday(&cd->last_recv_time, NULL);
368 return (FALSE); /* there is never an rpc msg to be processed */
372 static enum xprt_stat
373 rendezvous_stat(SVCXPRT *xprt)
380 svc_vc_destroy(SVCXPRT *xprt)
382 assert(xprt != NULL);
384 xprt_unregister(xprt);
385 __svc_vc_dodestroy(xprt);
389 __svc_vc_dodestroy(SVCXPRT *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);
413 free(xprt->xp_netid);
419 svc_vc_control(SVCXPRT *xprt, const u_int rq, void *in)
425 svc_vc_rendezvous_control(SVCXPRT *xprt, const u_int rq, void *in)
427 struct cf_rendezvous *cfp;
429 cfp = (struct cf_rendezvous *)xprt->xp_p1;
433 case SVCGET_CONNMAXREC:
434 *(int *)in = cfp->maxrec;
436 case SVCSET_CONNMAXREC:
437 cfp->maxrec = *(int *)in;
446 * reads data from the tcp or uip connection.
447 * any error is fatal and the connection is closed.
448 * (And a read of zero bytes is a half closed stream => error.)
449 * All read operations timeout after 35 seconds. A timeout is
450 * fatal for the connection.
453 read_vc(void *xprtp, void *buf, int len)
457 int milliseconds = 35 * 1000;
458 struct pollfd pollfd;
461 xprt = (SVCXPRT *)xprtp;
462 assert(xprt != NULL);
466 cfp = (struct cf_conn *)xprt->xp_p1;
469 len = _read(sock, buf, (size_t)len);
477 gettimeofday(&cfp->last_recv_time, NULL);
483 pollfd.events = POLLIN;
485 switch (_poll(&pollfd, 1, milliseconds)) {
496 } while ((pollfd.revents & POLLIN) == 0);
498 if ((len = _read(sock, buf, (size_t)len)) > 0) {
499 gettimeofday(&cfp->last_recv_time, NULL);
504 ((struct cf_conn *)(xprt->xp_p1))->strm_stat = XPRT_DIED;
509 * writes data to the tcp connection.
510 * Any error is fatal and the connection is closed.
513 write_vc(void *xprtp, void *buf, int len)
518 struct timeval tv0, tv1;
520 xprt = (SVCXPRT *)xprtp;
521 assert(xprt != NULL);
523 cd = (struct cf_conn *)xprt->xp_p1;
526 gettimeofday(&tv0, NULL);
528 for (cnt = len; cnt > 0; cnt -= i, buf = (char *)buf + i) {
529 i = _write(xprt->xp_fd, buf, (size_t)cnt);
531 if (errno != EAGAIN || !cd->nonblock) {
532 cd->strm_stat = XPRT_DIED;
537 * For non-blocking connections, do not
538 * take more than 2 seconds writing the
541 * XXX 2 is an arbitrary amount.
543 gettimeofday(&tv1, NULL);
544 if (tv1.tv_sec - tv0.tv_sec >= 2) {
545 cd->strm_stat = XPRT_DIED;
556 static enum xprt_stat
557 svc_vc_stat(SVCXPRT *xprt)
561 assert(xprt != NULL);
563 cd = (struct cf_conn *)(xprt->xp_p1);
565 if (cd->strm_stat == XPRT_DIED)
567 if (! xdrrec_eof(&(cd->xdrs)))
568 return (XPRT_MOREREQS);
573 svc_vc_recv(SVCXPRT *xprt, struct rpc_msg *msg)
578 assert(xprt != NULL);
581 cd = (struct cf_conn *)(xprt->xp_p1);
585 if (!__xdrrec_getrec(xdrs, &cd->strm_stat, TRUE))
588 (void)xdrrec_skiprecord(xdrs);
591 xdrs->x_op = XDR_DECODE;
592 if (xdr_callmsg(xdrs, msg)) {
593 cd->x_id = msg->rm_xid;
596 cd->strm_stat = XPRT_DIED;
601 svc_vc_getargs(SVCXPRT *xprt, xdrproc_t xdr_args, void *args_ptr)
605 assert(xprt != NULL);
606 cd = (struct cf_conn *)(xprt->xp_p1);
607 return (SVCAUTH_UNWRAP(&SVC_AUTH(xprt),
608 &cd->xdrs, xdr_args, args_ptr));
612 svc_vc_freeargs(SVCXPRT *xprt, xdrproc_t xdr_args, void *args_ptr)
616 assert(xprt != NULL);
617 /* args_ptr may be NULL */
619 xdrs = &(((struct cf_conn *)(xprt->xp_p1))->xdrs);
621 xdrs->x_op = XDR_FREE;
622 return ((*xdr_args)(xdrs, args_ptr));
626 svc_vc_reply(SVCXPRT *xprt, struct rpc_msg *msg)
635 assert(xprt != NULL);
638 cd = (struct cf_conn *)(xprt->xp_p1);
641 xdrs->x_op = XDR_ENCODE;
642 msg->rm_xid = cd->x_id;
644 if (msg->rm_reply.rp_stat == MSG_ACCEPTED &&
645 msg->rm_reply.rp_acpt.ar_stat == SUCCESS) {
646 xdr_proc = msg->acpted_rply.ar_results.proc;
647 xdr_where = msg->acpted_rply.ar_results.where;
648 msg->acpted_rply.ar_results.proc = (xdrproc_t) xdr_void;
649 msg->acpted_rply.ar_results.where = NULL;
651 pos = XDR_GETPOS(xdrs);
652 if (!xdr_replymsg(xdrs, msg) ||
653 !SVCAUTH_WRAP(&SVC_AUTH(xprt), xdrs, xdr_proc, xdr_where)) {
654 XDR_SETPOS(xdrs, pos);
658 rstat = xdr_replymsg(xdrs, msg);
662 (void)xdrrec_endofrecord(xdrs, TRUE);
668 svc_vc_ops(SVCXPRT *xprt)
670 static struct xp_ops ops;
671 static struct xp_ops2 ops2;
673 /* VARIABLES PROTECTED BY ops_lock: ops, ops2 */
675 mutex_lock(&ops_lock);
676 if (ops.xp_recv == NULL) {
677 ops.xp_recv = svc_vc_recv;
678 ops.xp_stat = svc_vc_stat;
679 ops.xp_getargs = svc_vc_getargs;
680 ops.xp_reply = svc_vc_reply;
681 ops.xp_freeargs = svc_vc_freeargs;
682 ops.xp_destroy = svc_vc_destroy;
683 ops2.xp_control = svc_vc_control;
686 xprt->xp_ops2 = &ops2;
687 mutex_unlock(&ops_lock);
691 svc_vc_rendezvous_ops(SVCXPRT *xprt)
693 static struct xp_ops ops;
694 static struct xp_ops2 ops2;
696 mutex_lock(&ops_lock);
697 if (ops.xp_recv == NULL) {
698 ops.xp_recv = rendezvous_request;
699 ops.xp_stat = rendezvous_stat;
701 (bool_t (*)(SVCXPRT *, xdrproc_t, void *))abort;
703 (bool_t (*)(SVCXPRT *, struct rpc_msg *))abort;
705 (bool_t (*)(SVCXPRT *, xdrproc_t, void *))abort;
706 ops.xp_destroy = svc_vc_destroy;
707 ops2.xp_control = svc_vc_rendezvous_control;
710 xprt->xp_ops2 = &ops2;
711 mutex_unlock(&ops_lock);
715 * Get the effective UID of the sending process. Used by rpcbind, keyserv
716 * and rpc.yppasswdd on AF_LOCAL.
719 __rpc_get_local_uid(SVCXPRT *transp, uid_t *uid) {
725 sock = transp->xp_fd;
726 sa = (struct sockaddr *)transp->xp_rtaddr.buf;
727 if (sa->sa_family == AF_LOCAL) {
728 ret = getpeereid(sock, &euid, &egid);
737 * Destroy xprts that have not have had any activity in 'timeout' seconds.
738 * If 'cleanblock' is true, blocking connections (the default) are also
739 * cleaned. If timeout is 0, the least active connection is picked.
742 __svc_clean_idle(fd_set *fds, int timeout, bool_t cleanblock)
745 SVCXPRT *xprt, *least_active;
746 struct timeval tv, tdiff, tmax;
749 gettimeofday(&tv, NULL);
750 tmax.tv_sec = tmax.tv_usec = 0;
752 rwlock_wrlock(&svc_fd_lock);
753 for (i = ncleaned = 0; i <= svc_maxfd; i++) {
754 if (FD_ISSET(i, fds)) {
755 xprt = __svc_xports[i];
756 if (xprt == NULL || xprt->xp_ops == NULL ||
757 xprt->xp_ops->xp_recv != svc_vc_recv)
759 cd = (struct cf_conn *)xprt->xp_p1;
760 if (!cleanblock && !cd->nonblock)
763 timersub(&tv, &cd->last_recv_time, &tdiff);
764 if (timercmp(&tdiff, &tmax, >)) {
770 if (tv.tv_sec - cd->last_recv_time.tv_sec > timeout) {
771 __xprt_unregister_unlocked(xprt);
772 __svc_vc_dodestroy(xprt);
777 if (timeout == 0 && least_active != NULL) {
778 __xprt_unregister_unlocked(least_active);
779 __svc_vc_dodestroy(least_active);
782 rwlock_unlock(&svc_fd_lock);
783 return ncleaned > 0 ? TRUE : FALSE;