lib/libcr/rpc/svc_unix.c

   1 /*
   2  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
   3  * unrestricted use provided that this legend is included on all tape
   4  * media and as a part of the software program in whole or part.  Users
   5  * may copy or modify Sun RPC without charge, but are not authorized
   6  * to license or distribute it to anyone else except as part of a product or
   7  * program developed by the user.
   8  *
   9  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  10  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  11  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  12  *
  13  * Sun RPC is provided with no support and without any obligation on the
  14  * part of Sun Microsystems, Inc. to assist in its use, correction,
  15  * modification or enhancement.
  16  *
  17  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  18  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  19  * OR ANY PART THEREOF.
  20  *
  21  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  22  * or profits or other special, indirect and consequential damages, even if
  23  * Sun has been advised of the possibility of such damages.
  24  *
  25  * Sun Microsystems, Inc.
  26  * 2550 Garcia Avenue
  27  * Mountain View, California  94043
  28  *
  29  * @(#)svc_unix.c 1.21 87/08/11 Copyr 1984 Sun Micro
  30  * @(#)svc_unix.c       2.2 88/08/01 4.0 RPCSRC
  31  * $FreeBSD: src/lib/libc/rpc/svc_unix.c,v 1.7.2.2 2001/09/05 22:29:23 dec Exp $
  32  * $DragonFly: src/lib/libcr/rpc/Attic/svc_unix.c,v 1.2 2003/06/17 04:26:45 dillon Exp $
  33  */
  34
  35 /*
  36  * svc_unix.c, Server side for TCP/IP based RPC.
  37  *
  38  * Copyright (C) 1984, Sun Microsystems, Inc.
  39  *
  40  * Actually implements two flavors of transporter -
  41  * a unix rendezvouser (a listner and connection establisher)
  42  * and a record/unix stream.
  43  */
  44
  45 #include <stdio.h>
  46 #include <stdlib.h>
  47 #include <unistd.h>
  48 #include <string.h>
  49 #include <rpc/rpc.h>
  50 #include <sys/socket.h>
  51 #include <sys/un.h>
  52 #include <sys/uio.h>
  53 #include <errno.h>
  54
  55 /*
  56  * Ops vector for AF_UNIX based rpc service handle
  57  */
  58 static bool_t           svcunix_recv();
  59 static enum xprt_stat   svcunix_stat();
  60 static bool_t           svcunix_getargs();
  61 static bool_t           svcunix_reply();
  62 static bool_t           svcunix_freeargs();
  63 static void             svcunix_destroy();
  64
  65 static struct xp_ops svcunix_op = {
  66         svcunix_recv,
  67         svcunix_stat,
  68         svcunix_getargs,
  69         svcunix_reply,
  70         svcunix_freeargs,
  71         svcunix_destroy
  72 };
  73
  74 /*
  75  * Ops vector for TCP/IP rendezvous handler
  76  */
  77 static bool_t           rendezvous_request();
  78 static enum xprt_stat   rendezvous_stat();
  79
  80 static struct xp_ops svcunix_rendezvous_op = {
  81         rendezvous_request,
  82         rendezvous_stat,
  83         (bool_t (*)())abort,
  84         (bool_t (*)())abort,
  85         (bool_t (*)())abort,
  86         svcunix_destroy
  87 };
  88
  89 static int readunix(), writeunix();
  90 static SVCXPRT *makefd_xprt();
  91
  92 struct unix_rendezvous { /* kept in xprt->xp_p1 */
  93         u_int sendsize;
  94         u_int recvsize;
  95 };
  96
  97 struct unix_conn {  /* kept in xprt->xp_p1 */
  98         enum xprt_stat strm_stat;
  99         u_long x_id;
 100         XDR xdrs;
 101         char verf_body[MAX_AUTH_BYTES];
 102 };
 103
 104
 105 struct cmessage {
 106         struct cmsghdr cmsg;
 107         struct cmsgcred cmcred;
 108 };
 109
 110 static struct cmessage cm;
 111
 112 static int __msgread(sock, buf, cnt)
 113         int sock;
 114         void *buf;
 115         size_t cnt;
 116 {
 117         struct iovec iov[1];
 118         struct msghdr msg;
 119
 120         bzero((char *)&cm, sizeof(cm));
 121         iov[0].iov_base = buf;
 122         iov[0].iov_len = cnt;
 123
 124         msg.msg_iov = iov;
 125         msg.msg_iovlen = 1;
 126         msg.msg_name = NULL;
 127         msg.msg_namelen = 0;
 128         msg.msg_control = (caddr_t)&cm;
 129         msg.msg_controllen = sizeof(struct cmessage);
 130         msg.msg_flags = 0;
 131
 132         return(recvmsg(sock, &msg, 0));
 133 }
 134
 135 static int __msgwrite(sock, buf, cnt)
 136         int sock;
 137         void *buf;
 138         size_t cnt;
 139 {
 140         struct iovec iov[1];
 141         struct msghdr msg;
 142
 143         bzero((char *)&cm, sizeof(cm));
 144         iov[0].iov_base = buf;
 145         iov[0].iov_len = cnt;
 146
 147         cm.cmsg.cmsg_type = SCM_CREDS;
 148         cm.cmsg.cmsg_level = SOL_SOCKET;
 149         cm.cmsg.cmsg_len = sizeof(struct cmessage);
 150
 151         msg.msg_iov = iov;
 152         msg.msg_iovlen = 1;
 153         msg.msg_name = NULL;
 154         msg.msg_namelen = 0;
 155         msg.msg_control = (caddr_t)&cm;
 156         msg.msg_controllen = sizeof(struct cmessage);
 157         msg.msg_flags = 0;
 158
 159         return(sendmsg(sock, &msg, 0));
 160 }
 161
 162 /*
 163  * Usage:
 164  *      xprt = svcunix_create(sock, send_buf_size, recv_buf_size);
 165  *
 166  * Creates, registers, and returns a (rpc) unix based transporter.
 167  * Once *xprt is initialized, it is registered as a transporter
 168  * see (svc.h, xprt_register).  This routine returns
 169  * a NULL if a problem occurred.
 170  *
 171  * If sock<0 then a socket is created, else sock is used.
 172  * If the socket, sock is not bound to a port then svcunix_create
 173  * binds it to an arbitrary port.  The routine then starts a unix
 174  * listener on the socket's associated port.  In any (successful) case,
 175  * xprt->xp_sock is the registered socket number and xprt->xp_port is the
 176  * associated port number.
 177  *
 178  * Since unix streams do buffered io similar to stdio, the caller can specify
 179  * how big the send and receive buffers are via the second and third parms;
 180  * 0 => use the system default.
 181  */
 182 SVCXPRT *
 183 svcunix_create(sock, sendsize, recvsize, path)
 184         register int sock;
 185         u_int sendsize;
 186         u_int recvsize;
 187         char *path;
 188 {
 189         bool_t madesock = FALSE;
 190         register SVCXPRT *xprt;
 191         register struct unix_rendezvous *r;
 192         struct sockaddr_un addr;
 193         int len = sizeof(struct sockaddr_un);
 194
 195         if (sock == RPC_ANYSOCK) {
 196                 if ((sock = socket(AF_UNIX, SOCK_STREAM, 0)) < 0) {
 197                         perror("svc_unix.c - AF_UNIX socket creation problem");
 198                         return ((SVCXPRT *)NULL);
 199                 }
 200                 madesock = TRUE;
 201         }
 202         memset(&addr, 0, sizeof (addr));
 203         addr.sun_family = AF_UNIX;
 204         strcpy(addr.sun_path, path);
 205         len = strlen(addr.sun_path) + sizeof(addr.sun_family) +
 206                 sizeof(addr.sun_len) + 1;
 207         addr.sun_len = len;
 208
 209         bind(sock, (struct sockaddr *)&addr, len);
 210
 211         if ((getsockname(sock, (struct sockaddr *)&addr, &len) != 0)  ||
 212             (listen(sock, 2) != 0)) {
 213                 perror("svc_unix.c - cannot getsockname or listen");
 214                 if (madesock)
 215                        (void)_close(sock);
 216                 return ((SVCXPRT *)NULL);
 217         }
 218         r = (struct unix_rendezvous *)mem_alloc(sizeof(*r));
 219         if (r == NULL) {
 220                 (void) fprintf(stderr, "svcunix_create: out of memory\n");
 221                 return (NULL);
 222         }
 223         r->sendsize = sendsize;
 224         r->recvsize = recvsize;
 225         xprt = (SVCXPRT *)mem_alloc(sizeof(SVCXPRT));
 226         if (xprt == NULL) {
 227                 (void) fprintf(stderr, "svcunix_create: out of memory\n");
 228                 return (NULL);
 229         }
 230         xprt->xp_p2 = NULL;
 231         xprt->xp_p1 = (caddr_t)r;
 232         xprt->xp_verf = _null_auth;
 233         xprt->xp_ops = &svcunix_rendezvous_op;
 234         xprt->xp_port = -1 /*ntohs(addr.sin_port)*/;
 235         xprt->xp_sock = sock;
 236         xprt_register(xprt);
 237         return (xprt);
 238 }
 239
 240 /*
 241  * Like svunix_create(), except the routine takes any *open* UNIX file
 242  * descriptor as its first input.
 243  */
 244 SVCXPRT *
 245 svcunixfd_create(fd, sendsize, recvsize)
 246         int fd;
 247         u_int sendsize;
 248         u_int recvsize;
 249 {
 250
 251         return (makefd_xprt(fd, sendsize, recvsize));
 252 }
 253
 254 static SVCXPRT *
 255 makefd_xprt(fd, sendsize, recvsize)
 256         int fd;
 257         u_int sendsize;
 258         u_int recvsize;
 259 {
 260         register SVCXPRT *xprt;
 261         register struct unix_conn *cd;
 262
 263         xprt = (SVCXPRT *)mem_alloc(sizeof(SVCXPRT));
 264         if (xprt == (SVCXPRT *)NULL) {
 265                 (void) fprintf(stderr, "svc_unix: makefd_xprt: out of memory\n");
 266                 goto done;
 267         }
 268         cd = (struct unix_conn *)mem_alloc(sizeof(struct unix_conn));
 269         if (cd == (struct unix_conn *)NULL) {
 270                 (void) fprintf(stderr, "svc_unix: makefd_xprt: out of memory\n");
 271                 mem_free((char *) xprt, sizeof(SVCXPRT));
 272                 xprt = (SVCXPRT *)NULL;
 273                 goto done;
 274         }
 275         cd->strm_stat = XPRT_IDLE;
 276         xdrrec_create(&(cd->xdrs), sendsize, recvsize,
 277             (caddr_t)xprt, readunix, writeunix);
 278         xprt->xp_p2 = NULL;
 279         xprt->xp_p1 = (caddr_t)cd;
 280         xprt->xp_verf.oa_base = cd->verf_body;
 281         xprt->xp_addrlen = 0;
 282         xprt->xp_ops = &svcunix_op;  /* truely deals with calls */
 283         xprt->xp_port = 0;  /* this is a connection, not a rendezvouser */
 284         xprt->xp_sock = fd;
 285         xprt_register(xprt);
 286     done:
 287         return (xprt);
 288 }
 289
 290 static bool_t
 291 rendezvous_request(xprt)
 292         register SVCXPRT *xprt;
 293 {
 294         int sock;
 295         struct unix_rendezvous *r;
 296         struct sockaddr_un addr;
 297         struct sockaddr_in in_addr;
 298         int len;
 299
 300         r = (struct unix_rendezvous *)xprt->xp_p1;
 301     again:
 302         len = sizeof(struct sockaddr_in);
 303         if ((sock = accept(xprt->xp_sock, (struct sockaddr *)&addr,
 304             &len)) < 0) {
 305                 if (errno == EINTR)
 306                         goto again;
 307                return (FALSE);
 308         }
 309
 310         /*
 311          * make a new transporter (re-uses xprt)
 312          */
 313         bzero((char *)&in_addr, sizeof(in_addr));
 314         in_addr.sin_family = AF_UNIX;
 315         xprt = makefd_xprt(sock, r->sendsize, r->recvsize);
 316         xprt->xp_raddr = in_addr;
 317         xprt->xp_addrlen = len;
 318         return (FALSE); /* there is never an rpc msg to be processed */
 319 }
 320
 321 static enum xprt_stat
 322 rendezvous_stat()
 323 {
 324
 325         return (XPRT_IDLE);
 326 }
 327
 328 static void
 329 svcunix_destroy(xprt)
 330         register SVCXPRT *xprt;
 331 {
 332         register struct unix_conn *cd = (struct unix_conn *)xprt->xp_p1;
 333
 334         xprt_unregister(xprt);
 335         (void)_close(xprt->xp_sock);
 336         if (xprt->xp_port != 0) {
 337                 /* a rendezvouser socket */
 338                 xprt->xp_port = 0;
 339         } else {
 340                 /* an actual connection socket */
 341                 XDR_DESTROY(&(cd->xdrs));
 342         }
 343         mem_free((caddr_t)cd, sizeof(struct unix_conn));
 344         mem_free((caddr_t)xprt, sizeof(SVCXPRT));
 345 }
 346
 347 /*
 348  * All read operations timeout after 35 seconds.
 349  * A timeout is fatal for the connection.
 350  */
 351 static struct timeval wait_per_try = { 35, 0 };
 352
 353 /*
 354  * reads data from the unix conection.
 355  * any error is fatal and the connection is closed.
 356  * (And a read of zero bytes is a half closed stream => error.)
 357  *
 358  * Note: we have to be careful here not to allow ourselves to become
 359  * blocked too long in this routine. While we're waiting for data from one
 360  * client, another client may be trying to connect. To avoid this situation,
 361  * some code from svc_run() is transplanted here: the select() loop checks
 362  * all RPC descriptors including the one we want and calls svc_getreqset2()
 363  * to handle new requests if any are detected.
 364  */
 365 static int
 366 readunix(xprt, buf, len)
 367         register SVCXPRT *xprt;
 368         caddr_t buf;
 369         register int len;
 370 {
 371         register int sock = xprt->xp_sock;
 372         struct timeval start, delta, tv;
 373         struct timeval tmp1, tmp2;
 374         fd_set *fds;
 375         extern fd_set           *__svc_fdset;
 376         extern int              __svc_fdsetsize;
 377
 378         delta = wait_per_try;
 379         fds = NULL;
 380         gettimeofday(&start, NULL);
 381         do {
 382                 int bytes = howmany(__svc_fdsetsize, NFDBITS) *
 383                                 sizeof(fd_mask);
 384                 if (fds != NULL)
 385                         free(fds);
 386                 fds = (fd_set *)malloc(bytes);
 387                 if (fds == NULL)
 388                         goto fatal_err;
 389                 memcpy(fds, __svc_fdset, bytes);
 390
 391                 /* XXX we know the other bits are still clear */
 392                 FD_SET(sock, fds);
 393                 tv = delta;     /* in case select() implements writeback */
 394                 switch (select(svc_maxfd + 1, fds, NULL, NULL, &tv)) {
 395                 case -1:
 396                         memset(fds, 0, bytes);
 397                         if (errno != EINTR)
 398                                 goto fatal_err;
 399                         gettimeofday(&tmp1, NULL);
 400                         timersub(&tmp1, &start, &tmp2);
 401                         timersub(&wait_per_try, &tmp2, &tmp1);
 402                         if (tmp1.tv_sec < 0 || !timerisset(&tmp1))
 403                                 goto fatal_err;
 404                         delta = tmp1;
 405                         continue;
 406                 case 0:
 407                         goto fatal_err;
 408                 default:
 409                         if (!FD_ISSET(sock, fds)) {
 410                                 svc_getreqset2(fds, svc_maxfd + 1);
 411                                 gettimeofday(&tmp1, NULL);
 412                                 timersub(&tmp1, &start, &tmp2);
 413                                 timersub(&wait_per_try, &tmp2, &tmp1);
 414                                 if (tmp1.tv_sec < 0 || !timerisset(&tmp1))
 415                                         goto fatal_err;
 416                                 delta = tmp1;
 417                                 continue;
 418                         }
 419                 }
 420         } while (!FD_ISSET(sock, fds));
 421         if ((len = __msgread(sock, buf, len)) > 0) {
 422                 if (fds != NULL)
 423                         free(fds);
 424                 return (len);
 425         }
 426 fatal_err:
 427         ((struct unix_conn *)(xprt->xp_p1))->strm_stat = XPRT_DIED;
 428         if (fds != NULL)
 429                 free(fds);
 430         return (-1);
 431 }
 432
 433 /*
 434  * writes data to the unix connection.
 435  * Any error is fatal and the connection is closed.
 436  */
 437 static int
 438 writeunix(xprt, buf, len)
 439         register SVCXPRT *xprt;
 440         caddr_t buf;
 441         int len;
 442 {
 443         register int i, cnt;
 444
 445         for (cnt = len; cnt > 0; cnt -= i, buf += i) {
 446                 if ((i = __msgwrite(xprt->xp_sock, buf, cnt)) < 0) {
 447                         ((struct unix_conn *)(xprt->xp_p1))->strm_stat =
 448                             XPRT_DIED;
 449                         return (-1);
 450                 }
 451         }
 452         return (len);
 453 }
 454
 455 static enum xprt_stat
 456 svcunix_stat(xprt)
 457         SVCXPRT *xprt;
 458 {
 459         register struct unix_conn *cd =
 460             (struct unix_conn *)(xprt->xp_p1);
 461
 462         if (cd->strm_stat == XPRT_DIED)
 463                 return (XPRT_DIED);
 464         if (! xdrrec_eof(&(cd->xdrs)))
 465                 return (XPRT_MOREREQS);
 466         return (XPRT_IDLE);
 467 }
 468
 469 static bool_t
 470 svcunix_recv(xprt, msg)
 471         SVCXPRT *xprt;
 472         register struct rpc_msg *msg;
 473 {
 474         register struct unix_conn *cd =
 475             (struct unix_conn *)(xprt->xp_p1);
 476         register XDR *xdrs = &(cd->xdrs);
 477
 478         xdrs->x_op = XDR_DECODE;
 479         (void)xdrrec_skiprecord(xdrs);
 480         if (xdr_callmsg(xdrs, msg)) {
 481                 cd->x_id = msg->rm_xid;
 482                 /* set up verifiers */
 483                 msg->rm_call.cb_verf.oa_flavor = AUTH_UNIX;
 484                 msg->rm_call.cb_verf.oa_base = (caddr_t)&cm;
 485                 msg->rm_call.cb_verf.oa_length = sizeof(cm);
 486                 return (TRUE);
 487         }
 488         cd->strm_stat = XPRT_DIED;      /* XXXX */
 489         return (FALSE);
 490 }
 491
 492 static bool_t
 493 svcunix_getargs(xprt, xdr_args, args_ptr)
 494         SVCXPRT *xprt;
 495         xdrproc_t xdr_args;
 496         caddr_t args_ptr;
 497 {
 498
 499         return ((*xdr_args)(&(((struct unix_conn *)(xprt->xp_p1))->xdrs), args_ptr));
 500 }
 501
 502 static bool_t
 503 svcunix_freeargs(xprt, xdr_args, args_ptr)
 504         SVCXPRT *xprt;
 505         xdrproc_t xdr_args;
 506         caddr_t args_ptr;
 507 {
 508         register XDR *xdrs =
 509             &(((struct unix_conn *)(xprt->xp_p1))->xdrs);
 510
 511         xdrs->x_op = XDR_FREE;
 512         return ((*xdr_args)(xdrs, args_ptr));
 513 }
 514
 515 static bool_t
 516 svcunix_reply(xprt, msg)
 517         SVCXPRT *xprt;
 518         register struct rpc_msg *msg;
 519 {
 520         register struct unix_conn *cd =
 521             (struct unix_conn *)(xprt->xp_p1);
 522         register XDR *xdrs = &(cd->xdrs);
 523         register bool_t stat;
 524
 525         xdrs->x_op = XDR_ENCODE;
 526         msg->rm_xid = cd->x_id;
 527         stat = xdr_replymsg(xdrs, msg);
 528         (void)xdrrec_endofrecord(xdrs, TRUE);
 529         return (stat);
 530 }