bsd/nfs/krpc_subr.c

   1 /*
   2  * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  29 /*
  30  * Copyright (c) 1994 Gordon Ross, Adam Glass
  31  * Copyright (c) 1992 Regents of the University of California.
  32  * All rights reserved.
  33  *
  34  * This software was developed by the Computer Systems Engineering group
  35  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
  36  * contributed to Berkeley.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  * 1. Redistributions of source code must retain the above copyright
  42  *    notice, this list of conditions and the following disclaimer.
  43  * 2. Redistributions in binary form must reproduce the above copyright
  44  *    notice, this list of conditions and the following disclaimer in the
  45  *    documentation and/or other materials provided with the distribution.
  46  * 3. All advertising materials mentioning features or use of this software
  47  *    must display the following acknowledgement:
  48  *      This product includes software developed by the University of
  49  *      California, Lawrence Berkeley Laboratory and its contributors.
  50  * 4. Neither the name of the University nor the names of its contributors
  51  *    may be used to endorse or promote products derived from this software
  52  *    without specific prior written permission.
  53  *
  54  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  55  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  56  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  57  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  58  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  59  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  60  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  61  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  62  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  63  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  64  * SUCH DAMAGE.
  65  *
  66  */
  67
  68 #include <sys/param.h>
  69 #include <sys/conf.h>
  70 #include <sys/ioctl.h>
  71 #include <sys/proc.h>
  72 #include <sys/mount.h>
  73 #include <sys/kpi_mbuf.h>
  74 #include <sys/malloc.h>
  75 #include <sys/socket.h>
  76 #include <sys/socketvar.h>
  77 #include <sys/systm.h>
  78 #include <sys/reboot.h>
  79 #include <sys/uio_internal.h>
  80
  81 #include <net/if.h>
  82 #include <netinet/in.h>
  83
  84 #include <nfs/rpcv2.h>
  85 #include <nfs/krpc.h>
  86
  87 /*
  88  * Kernel support for Sun RPC
  89  *
  90  * Used currently for bootstrapping in nfs diskless configurations.
  91  *
  92  * Note: will not work on variable-sized rpc args/results.
  93  *       implicit size-limit of an mbuf.
  94  */
  95
  96 /*
  97  * Generic RPC headers
  98  */
  99
 100 struct auth_info {
 101         u_int32_t       rp_atype;       /* auth type */
 102         u_int32_t       rp_alen;        /* auth length */
 103 };
 104
 105 struct rpc_call {
 106         u_int32_t       rp_xid;         /* request transaction id */
 107         int32_t         rp_direction;   /* call direction (0) */
 108         u_int32_t       rp_rpcvers;     /* rpc version (2) */
 109         u_int32_t       rp_prog;        /* program */
 110         u_int32_t       rp_vers;        /* version */
 111         u_int32_t       rp_proc;        /* procedure */
 112         struct  auth_info rp_auth;
 113         struct  auth_info rp_verf;
 114 };
 115
 116 struct rpc_reply {
 117         u_int32_t rp_xid;               /* request transaction id */
 118         int32_t  rp_direction;          /* call direction (1) */
 119         int32_t  rp_astatus;            /* accept status (0: accepted) */
 120         union {
 121                 u_int32_t rpu_errno;
 122                 struct {
 123                         struct auth_info rp_auth;
 124                         u_int32_t       rp_rstatus;
 125                 } rpu_ok;
 126         } rp_u;
 127 };
 128
 129 #define MIN_REPLY_HDR 16        /* xid, dir, astat, errno */
 130
 131 /*
 132  * What is the longest we will wait before re-sending a request?
 133  * Note this is also the frequency of "RPC timeout" messages.
 134  * The re-send loop count sup linearly to this maximum, so the
 135  * first complaint will happen after (1+2+3+4+5)=15 seconds.
 136  */
 137 #define MAX_RESEND_DELAY 5      /* seconds */
 138
 139 /* copied over from nfs_boot.c for printf format. could put in .h file... */
 140 #define IP_FORMAT       "%d.%d.%d.%d"
 141 #define IP_CH(ip)       ((u_char *)ip)
 142 #define IP_LIST(ip)     IP_CH(ip)[0],IP_CH(ip)[1],IP_CH(ip)[2],IP_CH(ip)[3]
 143
 144
 145 /*
 146  * Call portmap to lookup a port number for a particular rpc program
 147  * Returns non-zero error on failure.
 148  */
 149 int
 150 krpc_portmap(sin, prog, vers, proto, portp)
 151         struct sockaddr_in *sin;        /* server address */
 152         u_int prog, vers, proto;        /* host order */
 153         u_int16_t *portp;               /* network order */
 154 {
 155         struct sdata {
 156                 u_int32_t prog;         /* call program */
 157                 u_int32_t vers;         /* call version */
 158                 u_int32_t proto;        /* call protocol */
 159                 u_int32_t port;         /* call port (unused) */
 160         } *sdata;
 161         struct rdata {
 162                 u_int16_t pad;
 163                 u_int16_t port;
 164         } *rdata;
 165         mbuf_t m;
 166         int error;
 167
 168         /* The portmapper port is fixed. */
 169         if (prog == PMAPPROG) {
 170                 *portp = htons(PMAPPORT);
 171                 return 0;
 172         }
 173
 174         error = mbuf_gethdr(MBUF_WAITOK, MBUF_TYPE_DATA, &m);
 175         if (error)
 176                 return error;
 177         mbuf_setlen(m, sizeof(*sdata));
 178         mbuf_pkthdr_setlen(m, sizeof(*sdata));
 179         sdata = mbuf_data(m);
 180
 181         /* Do the RPC to get it. */
 182         sdata->prog = htonl(prog);
 183         sdata->vers = htonl(vers);
 184         sdata->proto = htonl(proto);
 185         sdata->port = 0;
 186
 187         sin->sin_port = htons(PMAPPORT);
 188         error = krpc_call(sin, SOCK_DGRAM, PMAPPROG, PMAPVERS, PMAPPROC_GETPORT, &m, NULL);
 189         if (error)
 190                 return error;
 191
 192         rdata = mbuf_data(m);
 193         *portp = rdata->port;
 194
 195         if (!rdata->port)
 196                 error = EPROGUNAVAIL;
 197
 198         mbuf_freem(m);
 199         return (error);
 200 }
 201
 202 /*
 203  * Do a remote procedure call (RPC) and wait for its reply.
 204  * If from_p is non-null, then we are doing broadcast, and
 205  * the address from whence the response came is saved there.
 206  */
 207 int
 208 krpc_call(sa, sotype, prog, vers, func, data, from_p)
 209         struct sockaddr_in *sa;
 210         u_int sotype, prog, vers, func;
 211         mbuf_t *data;                   /* input/output */
 212         struct sockaddr_in *from_p;     /* output */
 213 {
 214         socket_t so;
 215         struct sockaddr_in *sin;
 216         mbuf_t m, nam, mhead;
 217         struct rpc_call *call;
 218         struct rpc_reply *reply;
 219         int error, timo, secs;
 220         size_t len;
 221         static u_int32_t xid = ~0xFF;
 222         u_int16_t tport;
 223         size_t maxpacket = 1<<16;
 224
 225         /*
 226          * Validate address family.
 227          * Sorry, this is INET specific...
 228          */
 229         if (sa->sin_family != AF_INET)
 230                 return (EAFNOSUPPORT);
 231
 232         /* Free at end if not null. */
 233         nam = mhead = NULL;
 234
 235         /*
 236          * Create socket and set its recieve timeout.
 237          */
 238         if ((error = sock_socket(AF_INET, sotype, 0, 0, 0, &so)))
 239                 goto out1;
 240
 241         {
 242                 struct timeval tv;
 243
 244                 tv.tv_sec = 1;
 245                 tv.tv_usec = 0;
 246
 247                 if ((error = sock_setsockopt(so, SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv))))
 248                     goto out;
 249
 250         }
 251
 252         /*
 253          * Enable broadcast if necessary.
 254          */
 255
 256         if (from_p && (sotype == SOCK_DGRAM)) {
 257                 int on = 1;
 258                 if ((error = sock_setsockopt(so, SOL_SOCKET, SO_BROADCAST, &on, sizeof(on))))
 259                         goto out;
 260         }
 261
 262         /*
 263          * Bind the local endpoint to a reserved port,
 264          * because some NFS servers refuse requests from
 265          * non-reserved (non-privileged) ports.
 266          */
 267         if ((error = mbuf_get(MBUF_WAITOK, MBUF_TYPE_SONAME, &m)))
 268                 goto out;
 269         sin = mbuf_data(m);
 270         bzero(sin, sizeof(*sin));
 271         mbuf_setlen(m, sizeof(*sin));
 272         sin->sin_len = sizeof(*sin);
 273         sin->sin_family = AF_INET;
 274         sin->sin_addr.s_addr = INADDR_ANY;
 275         tport = IPPORT_RESERVED;
 276         do {
 277                 tport--;
 278                 sin->sin_port = htons(tport);
 279                 error = sock_bind(so, (struct sockaddr*)sin);
 280         } while (error == EADDRINUSE &&
 281                          tport > IPPORT_RESERVED / 2);
 282         mbuf_freem(m);
 283         m = NULL;
 284         if (error) {
 285                 printf("bind failed\n");
 286                 goto out;
 287         }
 288
 289         /*
 290          * Setup socket address for the server.
 291          */
 292         if ((error = mbuf_get(MBUF_WAITOK, MBUF_TYPE_SONAME, &nam)))
 293                 goto out;
 294         sin = mbuf_data(nam);
 295         mbuf_setlen(nam, sa->sin_len);
 296         bcopy((caddr_t)sa, (caddr_t)sin, sa->sin_len);
 297
 298         if (sotype == SOCK_STREAM) {
 299                 struct timeval tv;
 300                 tv.tv_sec = 60;
 301                 tv.tv_usec = 0;
 302                 error = sock_connect(so, mbuf_data(nam), MSG_DONTWAIT);
 303                 if (error && (error != EINPROGRESS))
 304                         goto out;
 305                 error = sock_connectwait(so, &tv);
 306                 if (error) {
 307                         if (error == EINPROGRESS)
 308                                 error = ETIMEDOUT;
 309                         printf("krpc_call: error waiting for TCP socket connect: %d\n", error);
 310                         goto out;
 311                 }
 312         }
 313
 314         /*
 315          * Prepend RPC message header.
 316          */
 317         m = *data;
 318         *data = NULL;
 319 #if     DIAGNOSTIC
 320         if ((mbuf_flags(m) & MBUF_PKTHDR) == 0)
 321                 panic("krpc_call: send data w/o pkthdr");
 322         if (mbuf_pkthdr_len(m) < mbuf_len(m))
 323                 panic("krpc_call: pkthdr.len not set");
 324 #endif
 325         len = sizeof(*call);
 326         if (sotype == SOCK_STREAM)
 327                 len += 4;  /* account for RPC record marker */
 328         mhead = m;
 329         if ((error = mbuf_prepend(&mhead, len, MBUF_WAITOK)))
 330                 goto out;
 331         if ((error = mbuf_pkthdr_setrcvif(mhead, NULL)))
 332                 goto out;
 333
 334         /*
 335          * Fill in the RPC header
 336          */
 337         if (sotype == SOCK_STREAM) {
 338                 /* first, fill in RPC record marker */
 339                 u_long *recmark = mbuf_data(mhead);
 340                 *recmark = htonl(0x80000000 | (mbuf_pkthdr_len(mhead) - 4));
 341                 call = (struct rpc_call *)(recmark + 1);
 342         } else {
 343                 call = mbuf_data(mhead);
 344         }
 345         bzero((caddr_t)call, sizeof(*call));
 346         xid++;
 347         call->rp_xid = htonl(xid);
 348         /* call->rp_direction = 0; */
 349         call->rp_rpcvers = htonl(2);
 350         call->rp_prog = htonl(prog);
 351         call->rp_vers = htonl(vers);
 352         call->rp_proc = htonl(func);
 353         /* call->rp_auth = 0; */
 354         /* call->rp_verf = 0; */
 355
 356         /*
 357          * Send it, repeatedly, until a reply is received,
 358          * but delay each re-send by an increasing amount.
 359          * If the delay hits the maximum, start complaining.
 360          */
 361         timo = 0;
 362         for (;;) {
 363                 struct msghdr msg;
 364
 365                 /* Send RPC request (or re-send). */
 366                 if ((error = mbuf_copym(mhead, 0, MBUF_COPYALL, MBUF_WAITOK, &m)))
 367                         goto out;
 368                 bzero(&msg, sizeof(msg));
 369                 if (sotype == SOCK_STREAM) {
 370                         msg.msg_name = NULL;
 371                         msg.msg_namelen = 0;
 372                 } else {
 373                         msg.msg_name = mbuf_data(nam);
 374                         msg.msg_namelen = mbuf_len(nam);
 375                 }
 376                 error = sock_sendmbuf(so, &msg, m, 0, 0);
 377                 if (error) {
 378                         printf("krpc_call: sosend: %d\n", error);
 379                         goto out;
 380                 }
 381                 m = NULL;
 382
 383                 /* Determine new timeout. */
 384                 if (timo < MAX_RESEND_DELAY)
 385                         timo++;
 386                 else
 387                         printf("RPC timeout for server " IP_FORMAT "\n",
 388                                 IP_LIST(&(sin->sin_addr.s_addr)));
 389
 390                 /*
 391                  * Wait for up to timo seconds for a reply.
 392                  * The socket receive timeout was set to 1 second.
 393                  */
 394                 secs = timo;
 395                 while (secs > 0) {
 396                         size_t readlen;
 397
 398                         if (m) {
 399                                 mbuf_freem(m);
 400                                 m = NULL;
 401                         }
 402                         if (sotype == SOCK_STREAM) {
 403                                 int maxretries = 60;
 404                                 struct iovec_32 aio;
 405                                 aio.iov_base = (uintptr_t) &len;
 406                                 aio.iov_len = sizeof(u_long);
 407                                 bzero(&msg, sizeof(msg));
 408                                 msg.msg_iov = (struct iovec *) &aio;
 409                                 msg.msg_iovlen = 1;
 410                                 do {
 411                                    error = sock_receive(so, &msg, MSG_WAITALL, &readlen);
 412                                    if ((error == EWOULDBLOCK) && (--maxretries <= 0))
 413                                         error = ETIMEDOUT;
 414                                 } while (error == EWOULDBLOCK);
 415                                 if (!error && readlen < aio.iov_len) {
 416                                     /* only log a message if we got a partial word */
 417                                     if (readlen != 0)
 418                                             printf("short receive (%ld/%ld) from server " IP_FORMAT "\n",
 419                                                  readlen, sizeof(u_long), IP_LIST(&(sin->sin_addr.s_addr)));
 420                                     error = EPIPE;
 421                                 }
 422                                 if (error)
 423                                         goto out;
 424                                 len = ntohl(len) & ~0x80000000;
 425                                 /*
 426                                  * This is SERIOUS! We are out of sync with the sender
 427                                  * and forcing a disconnect/reconnect is all I can do.
 428                                  */
 429                                 if (len > maxpacket) {
 430                                     printf("impossible packet length (%ld) from server " IP_FORMAT "\n",
 431                                         len, IP_LIST(&(sin->sin_addr.s_addr)));
 432                                     error = EFBIG;
 433                                     goto out;
 434                                 }
 435
 436                                 do {
 437                                     readlen = len;
 438                                     error = sock_receivembuf(so, NULL, &m, MSG_WAITALL, &readlen);
 439                                 } while (error == EWOULDBLOCK);
 440
 441                                 if (!error && (len > readlen)) {
 442                                     printf("short receive (%ld/%ld) from server " IP_FORMAT "\n",
 443                                         readlen, len, IP_LIST(&(sin->sin_addr.s_addr)));
 444                                     error = EPIPE;
 445                                 }
 446                         } else {
 447                                 len = maxpacket;
 448                                 readlen = len;
 449                                 bzero(&msg, sizeof(msg));
 450                                 msg.msg_name = from_p;
 451                                 msg.msg_namelen = (from_p == NULL) ? 0 : sizeof(*from_p);
 452                                 error = sock_receivembuf(so, &msg, &m, 0, &readlen);
 453                         }
 454
 455                         if (error == EWOULDBLOCK) {
 456                                 secs--;
 457                                 continue;
 458                         }
 459                         if (error)
 460                                 goto out;
 461                         len = readlen;
 462
 463                         /* Does the reply contain at least a header? */
 464                         if (len < MIN_REPLY_HDR)
 465                                 continue;
 466                         if (mbuf_len(m) < MIN_REPLY_HDR)
 467                                 continue;
 468                         reply = mbuf_data(m);
 469
 470                         /* Is it the right reply? */
 471                         if (reply->rp_direction != htonl(RPC_REPLY))
 472                                 continue;
 473
 474                         if (reply->rp_xid != htonl(xid))
 475                                 continue;
 476
 477                         /* Was RPC accepted? (authorization OK) */
 478                         if (reply->rp_astatus != 0) {
 479                                 error = ntohl(reply->rp_u.rpu_errno);
 480                                 printf("rpc denied, error=%d\n", error);
 481                                 /* convert rpc error to errno */
 482                                 switch (error) {
 483                                 case RPC_MISMATCH:
 484                                         error = ERPCMISMATCH;
 485                                         break;
 486                                 case RPC_AUTHERR:
 487                                         error = EAUTH;
 488                                         break;
 489                                 }
 490                                 goto out;
 491                         }
 492
 493                         /* Did the call succeed? */
 494                         if ((error = ntohl(reply->rp_u.rpu_ok.rp_rstatus)) != 0) {
 495                                 printf("rpc status=%d\n", error);
 496                                 /* convert rpc error to errno */
 497                                 switch (error) {
 498                                 case RPC_PROGUNAVAIL:
 499                                         error = EPROGUNAVAIL;
 500                                         break;
 501                                 case RPC_PROGMISMATCH:
 502                                         error = EPROGMISMATCH;
 503                                         break;
 504                                 case RPC_PROCUNAVAIL:
 505                                         error = EPROCUNAVAIL;
 506                                         break;
 507                                 case RPC_GARBAGE:
 508                                         error = EINVAL;
 509                                         break;
 510                                 case RPC_SYSTEM_ERR:
 511                                         error = EIO;
 512                                         break;
 513                                 }
 514                                 goto out;
 515                         }
 516
 517                         goto gotreply;  /* break two levels */
 518
 519                 } /* while secs */
 520         } /* forever send/receive */
 521
 522         error = ETIMEDOUT;
 523         goto out;
 524
 525  gotreply:
 526
 527         /*
 528          * Pull as much as we can into first mbuf, to make
 529          * result buffer contiguous.  Note that if the entire
 530          * result won't fit into one mbuf, you're out of luck.
 531          * XXX - Should not rely on making the entire reply
 532          * contiguous (fix callers instead). -gwr
 533          */
 534 #if     DIAGNOSTIC
 535         if ((mbuf_flags(m) & MBUF_PKTHDR) == 0)
 536                 panic("krpc_call: received pkt w/o header?");
 537 #endif
 538         len = mbuf_pkthdr_len(m);
 539         if (sotype == SOCK_STREAM)
 540                 len -= 4;  /* the RPC record marker was read separately */
 541         if (mbuf_len(m) < len) {
 542                 if ((error = mbuf_pullup(&m, len)))
 543                         goto out;
 544                 reply = mbuf_data(m);
 545         }
 546
 547         /*
 548          * Strip RPC header
 549          */
 550         len = sizeof(*reply);
 551         if (reply->rp_u.rpu_ok.rp_auth.rp_atype != 0) {
 552                 len += ntohl(reply->rp_u.rpu_ok.rp_auth.rp_alen);
 553                 len = (len + 3) & ~3; /* XXX? */
 554         }
 555         mbuf_adj(m, len);
 556
 557         /* result */
 558         *data = m;
 559  out:
 560         sock_close(so);
 561 out1:
 562         if (nam) mbuf_freem(nam);
 563         if (mhead) mbuf_freem(mhead);
 564         return error;
 565 }