bsd/nfs/krpc_subr.c

   1 /*
   2  * Copyright (c) 2000-2016 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
  80 #include <net/if.h>
  81 #include <netinet/in.h>
  82
  83 #include <nfs/rpcv2.h>
  84 #include <nfs/krpc.h>
  85
  86 /*
  87  * Kernel support for Sun RPC
  88  *
  89  * Used currently for bootstrapping in nfs diskless configurations.
  90  *
  91  * Note: will not work on variable-sized rpc args/results.
  92  *       implicit size-limit of an mbuf.
  93  */
  94
  95 /*
  96  * Generic RPC headers
  97  */
  98
  99 struct auth_info {
 100         u_int32_t       rp_atype;       /* auth type */
 101         u_int32_t       rp_alen;        /* auth length */
 102 };
 103
 104 struct rpc_call {
 105         u_int32_t       rp_xid;         /* request transaction id */
 106         int32_t         rp_direction;   /* call direction (0) */
 107         u_int32_t       rp_rpcvers;     /* rpc version (2) */
 108         u_int32_t       rp_prog;        /* program */
 109         u_int32_t       rp_vers;        /* version */
 110         u_int32_t       rp_proc;        /* procedure */
 111         struct  auth_info rp_auth;
 112         struct  auth_info rp_verf;
 113 };
 114
 115 struct rpc_reply {
 116         u_int32_t rp_xid;               /* request transaction id */
 117         int32_t  rp_direction;          /* call direction (1) */
 118         int32_t  rp_astatus;            /* accept status (0: accepted) */
 119         union {
 120                 u_int32_t rpu_errno;
 121                 struct {
 122                         struct auth_info rp_auth;
 123                         u_int32_t       rp_rstatus;
 124                 } rpu_ok;
 125         } rp_u;
 126 };
 127
 128 #define MIN_REPLY_HDR 16        /* xid, dir, astat, errno */
 129
 130 /*
 131  * What is the longest we will wait before re-sending a request?
 132  * Note this is also the frequency of "RPC timeout" messages.
 133  * The re-send loop count sup linearly to this maximum, so the
 134  * first complaint will happen after (1+2+3+4+5)=15 seconds.
 135  */
 136 #define MAX_RESEND_DELAY 5      /* seconds */
 137
 138 /* copied over from nfs_boot.c for printf format. could put in .h file... */
 139 #define IP_FORMAT       "%d.%d.%d.%d"
 140 #define IP_CH(ip)       ((u_char *)ip)
 141 #define IP_LIST(ip)     IP_CH(ip)[0],IP_CH(ip)[1],IP_CH(ip)[2],IP_CH(ip)[3]
 142
 143
 144 /*
 145  * Call portmap to lookup a port number for a particular rpc program
 146  * Returns non-zero error on failure.
 147  */
 148 int
 149 krpc_portmap(
 150         struct sockaddr_in *sin,        /* server address */
 151         u_int prog, u_int vers, u_int proto,    /* host order */
 152         u_int16_t *portp)               /* network order */
 153 {
 154         struct sdata {
 155                 u_int32_t prog;         /* call program */
 156                 u_int32_t vers;         /* call version */
 157                 u_int32_t proto;        /* call protocol */
 158                 u_int32_t port;         /* call port (unused) */
 159         } *sdata;
 160         struct rdata {
 161                 u_int16_t pad;
 162                 u_int16_t port;
 163         } *rdata;
 164         mbuf_t m;
 165         int error;
 166
 167         /* The portmapper port is fixed. */
 168         if (prog == PMAPPROG) {
 169                 *portp = htons(PMAPPORT);
 170                 return 0;
 171         }
 172
 173         error = mbuf_gethdr(MBUF_WAITOK, MBUF_TYPE_DATA, &m);
 174         if (error)
 175                 return error;
 176         mbuf_setlen(m, sizeof(*sdata));
 177         mbuf_pkthdr_setlen(m, sizeof(*sdata));
 178         sdata = mbuf_data(m);
 179
 180         /* Do the RPC to get it. */
 181         sdata->prog = htonl(prog);
 182         sdata->vers = htonl(vers);
 183         sdata->proto = htonl(proto);
 184         sdata->port = 0;
 185
 186         sin->sin_port = htons(PMAPPORT);
 187         error = krpc_call(sin, SOCK_DGRAM, PMAPPROG, PMAPVERS, PMAPPROC_GETPORT, &m, NULL);
 188         if (error)
 189                 return error;
 190
 191         rdata = mbuf_data(m);
 192         *portp = rdata->port;
 193
 194         if (!rdata->port)
 195                 error = EPROGUNAVAIL;
 196
 197         mbuf_freem(m);
 198         return (error);
 199 }
 200
 201 /*
 202  * Do a remote procedure call (RPC) and wait for its reply.
 203  * If from_p is non-null, then we are doing broadcast, and
 204  * the address from whence the response came is saved there.
 205  */
 206 int
 207 krpc_call(
 208         struct sockaddr_in *sa,
 209         u_int sotype, u_int prog, u_int vers, u_int func,
 210         mbuf_t *data,                   /* input/output */
 211         struct sockaddr_in *from_p)     /* output */
 212 {
 213         socket_t so;
 214         struct sockaddr_in *sin;
 215         mbuf_t m, nam, mhead;
 216         struct rpc_call *call;
 217         struct rpc_reply *reply;
 218         int error, timo, secs;
 219         size_t len;
 220         static u_int32_t xid = ~0xFF;
 221         u_int16_t tport;
 222         size_t maxpacket = 1<<16;
 223
 224         /*
 225          * Validate address family.
 226          * Sorry, this is INET specific...
 227          */
 228         if (sa->sin_family != AF_INET)
 229                 return (EAFNOSUPPORT);
 230
 231         /* Free at end if not null. */
 232         nam = mhead = NULL;
 233
 234         /*
 235          * Create socket and set its recieve timeout.
 236          */
 237         if ((error = sock_socket(AF_INET, sotype, 0, 0, 0, &so)))
 238                 goto out1;
 239
 240         {
 241                 struct timeval tv;
 242
 243                 tv.tv_sec = 1;
 244                 tv.tv_usec = 0;
 245
 246                 if ((error = sock_setsockopt(so, SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv))))
 247                     goto out;
 248
 249         }
 250
 251         /*
 252          * Enable broadcast if necessary.
 253          */
 254
 255         if (from_p && (sotype == SOCK_DGRAM)) {
 256                 int on = 1;
 257                 if ((error = sock_setsockopt(so, SOL_SOCKET, SO_BROADCAST, &on, sizeof(on))))
 258                         goto out;
 259         }
 260
 261         /*
 262          * Bind the local endpoint to a reserved port,
 263          * because some NFS servers refuse requests from
 264          * non-reserved (non-privileged) ports.
 265          */
 266         if ((error = mbuf_get(MBUF_WAITOK, MBUF_TYPE_SONAME, &m)))
 267                 goto out;
 268         sin = mbuf_data(m);
 269         bzero(sin, sizeof(*sin));
 270         mbuf_setlen(m, sizeof(*sin));
 271         sin->sin_len = sizeof(*sin);
 272         sin->sin_family = AF_INET;
 273         sin->sin_addr.s_addr = INADDR_ANY;
 274         tport = IPPORT_RESERVED;
 275         do {
 276                 tport--;
 277                 sin->sin_port = htons(tport);
 278                 error = sock_bind(so, (struct sockaddr*)sin);
 279         } while (error == EADDRINUSE &&
 280                          tport > IPPORT_RESERVED / 2);
 281         mbuf_freem(m);
 282         m = NULL;
 283         if (error) {
 284                 printf("bind failed\n");
 285                 goto out;
 286         }
 287
 288         /*
 289          * Setup socket address for the server.
 290          */
 291         if ((error = mbuf_get(MBUF_WAITOK, MBUF_TYPE_SONAME, &nam)))
 292                 goto out;
 293         sin = mbuf_data(nam);
 294         mbuf_setlen(nam, sa->sin_len);
 295         bcopy((caddr_t)sa, (caddr_t)sin, sa->sin_len);
 296
 297         if (sotype == SOCK_STREAM) {
 298                 struct timeval tv;
 299                 tv.tv_sec = 60;
 300                 tv.tv_usec = 0;
 301                 error = sock_connect(so, mbuf_data(nam), MSG_DONTWAIT);
 302                 if (error && (error != EINPROGRESS))
 303                         goto out;
 304                 error = sock_connectwait(so, &tv);
 305                 if (error) {
 306                         if (error == EINPROGRESS)
 307                                 error = ETIMEDOUT;
 308                         printf("krpc_call: error waiting for TCP socket connect: %d\n", error);
 309                         goto out;
 310                 }
 311         }
 312
 313         /*
 314          * Prepend RPC message header.
 315          */
 316         m = *data;
 317         *data = NULL;
 318 #if     DIAGNOSTIC
 319         if ((mbuf_flags(m) & MBUF_PKTHDR) == 0)
 320                 panic("krpc_call: send data w/o pkthdr");
 321         if (mbuf_pkthdr_len(m) < mbuf_len(m))
 322                 panic("krpc_call: pkthdr.len not set");
 323 #endif
 324         len = sizeof(*call);
 325         if (sotype == SOCK_STREAM)
 326                 len += 4;  /* account for RPC record marker */
 327         mhead = m;
 328         if ((error = mbuf_prepend(&mhead, len, MBUF_WAITOK)))
 329                 goto out;
 330         if ((error = mbuf_pkthdr_setrcvif(mhead, NULL)))
 331                 goto out;
 332
 333         /*
 334          * Fill in the RPC header
 335          */
 336         if (sotype == SOCK_STREAM) {
 337                 /* first, fill in RPC record marker */
 338                 u_int32_t *recmark = mbuf_data(mhead);
 339                 *recmark = htonl(0x80000000 | (mbuf_pkthdr_len(mhead) - 4));
 340                 call = (struct rpc_call *)(recmark + 1);
 341         } else {
 342                 call = mbuf_data(mhead);
 343         }
 344         bzero((caddr_t)call, sizeof(*call));
 345         xid++;
 346         call->rp_xid = htonl(xid);
 347         /* call->rp_direction = 0; */
 348         call->rp_rpcvers = htonl(2);
 349         call->rp_prog = htonl(prog);
 350         call->rp_vers = htonl(vers);
 351         call->rp_proc = htonl(func);
 352         /* call->rp_auth = 0; */
 353         /* call->rp_verf = 0; */
 354
 355         /*
 356          * Send it, repeatedly, until a reply is received,
 357          * but delay each re-send by an increasing amount.
 358          * If the delay hits the maximum, start complaining.
 359          */
 360         timo = 0;
 361         for (;;) {
 362                 struct msghdr msg;
 363
 364                 /* Send RPC request (or re-send). */
 365                 if ((error = mbuf_copym(mhead, 0, MBUF_COPYALL, MBUF_WAITOK, &m)))
 366                         goto out;
 367                 bzero(&msg, sizeof(msg));
 368                 if (sotype == SOCK_STREAM) {
 369                         msg.msg_name = NULL;
 370                         msg.msg_namelen = 0;
 371                 } else {
 372                         msg.msg_name = mbuf_data(nam);
 373                         msg.msg_namelen = mbuf_len(nam);
 374                 }
 375                 error = sock_sendmbuf(so, &msg, m, 0, 0);
 376                 if (error) {
 377                         printf("krpc_call: sosend: %d\n", error);
 378                         goto out;
 379                 }
 380                 m = NULL;
 381
 382                 /* Determine new timeout. */
 383                 if (timo < MAX_RESEND_DELAY)
 384                         timo++;
 385                 else
 386                         printf("RPC timeout for server " IP_FORMAT "\n",
 387                                 IP_LIST(&(sin->sin_addr.s_addr)));
 388
 389                 /*
 390                  * Wait for up to timo seconds for a reply.
 391                  * The socket receive timeout was set to 1 second.
 392                  */
 393                 secs = timo;
 394                 while (secs > 0) {
 395                         size_t readlen;
 396
 397                         if (m) {
 398                                 mbuf_freem(m);
 399                                 m = NULL;
 400                         }
 401                         if (sotype == SOCK_STREAM) {
 402                                 int maxretries = 60;
 403                                 struct iovec aio;
 404                                 aio.iov_base = &len;
 405                                 aio.iov_len = sizeof(u_int32_t);
 406                                 bzero(&msg, sizeof(msg));
 407                                 msg.msg_iov = &aio;
 408                                 msg.msg_iovlen = 1;
 409                                 do {
 410                                    error = sock_receive(so, &msg, MSG_WAITALL, &readlen);
 411                                    if ((error == EWOULDBLOCK) && (--maxretries <= 0))
 412                                         error = ETIMEDOUT;
 413                                 } while (error == EWOULDBLOCK);
 414                                 if (!error && readlen < aio.iov_len) {
 415                                     /* only log a message if we got a partial word */
 416                                     if (readlen != 0)
 417                                             printf("short receive (%ld/%ld) from server " IP_FORMAT "\n",
 418                                                  readlen, sizeof(u_int32_t), IP_LIST(&(sin->sin_addr.s_addr)));
 419                                     error = EPIPE;
 420                                 }
 421                                 if (error)
 422                                         goto out;
 423                                 len = ntohl(len) & ~0x80000000;
 424                                 /*
 425                                  * This is SERIOUS! We are out of sync with the sender
 426                                  * and forcing a disconnect/reconnect is all I can do.
 427                                  */
 428                                 if (len > maxpacket) {
 429                                     printf("impossible packet length (%ld) from server " IP_FORMAT "\n",
 430                                         len, IP_LIST(&(sin->sin_addr.s_addr)));
 431                                     error = EFBIG;
 432                                     goto out;
 433                                 }
 434
 435                                 do {
 436                                     readlen = len;
 437                                     error = sock_receivembuf(so, NULL, &m, MSG_WAITALL, &readlen);
 438                                 } while (error == EWOULDBLOCK);
 439
 440                                 if (!error && (len > readlen)) {
 441                                     printf("short receive (%ld/%ld) from server " IP_FORMAT "\n",
 442                                         readlen, len, IP_LIST(&(sin->sin_addr.s_addr)));
 443                                     error = EPIPE;
 444                                 }
 445                         } else {
 446                                 len = maxpacket;
 447                                 readlen = len;
 448                                 bzero(&msg, sizeof(msg));
 449                                 msg.msg_name = from_p;
 450                                 msg.msg_namelen = (from_p == NULL) ? 0 : sizeof(*from_p);
 451                                 error = sock_receivembuf(so, &msg, &m, 0, &readlen);
 452                         }
 453
 454                         if (error == EWOULDBLOCK) {
 455                                 secs--;
 456                                 continue;
 457                         }
 458                         if (error)
 459                                 goto out;
 460                         len = readlen;
 461
 462                         /* Does the reply contain at least a header? */
 463                         if (len < MIN_REPLY_HDR)
 464                                 continue;
 465                         if (mbuf_len(m) < MIN_REPLY_HDR)
 466                                 continue;
 467                         reply = mbuf_data(m);
 468
 469                         /* Is it the right reply? */
 470                         if (reply->rp_direction != htonl(RPC_REPLY))
 471                                 continue;
 472
 473                         if (reply->rp_xid != htonl(xid))
 474                                 continue;
 475
 476                         /* Was RPC accepted? (authorization OK) */
 477                         if (reply->rp_astatus != 0) {
 478                                 error = ntohl(reply->rp_u.rpu_errno);
 479                                 printf("rpc denied, error=%d\n", error);
 480                                 /* convert rpc error to errno */
 481                                 switch (error) {
 482                                 case RPC_MISMATCH:
 483                                         error = ERPCMISMATCH;
 484                                         break;
 485                                 case RPC_AUTHERR:
 486                                         error = EAUTH;
 487                                         break;
 488                                 }
 489                                 goto out;
 490                         }
 491
 492                         /* Did the call succeed? */
 493                         if ((error = ntohl(reply->rp_u.rpu_ok.rp_rstatus)) != 0) {
 494                                 printf("rpc status=%d\n", error);
 495                                 /* convert rpc error to errno */
 496                                 switch (error) {
 497                                 case RPC_PROGUNAVAIL:
 498                                         error = EPROGUNAVAIL;
 499                                         break;
 500                                 case RPC_PROGMISMATCH:
 501                                         error = EPROGMISMATCH;
 502                                         break;
 503                                 case RPC_PROCUNAVAIL:
 504                                         error = EPROCUNAVAIL;
 505                                         break;
 506                                 case RPC_GARBAGE:
 507                                         error = EINVAL;
 508                                         break;
 509                                 case RPC_SYSTEM_ERR:
 510                                         error = EIO;
 511                                         break;
 512                                 }
 513                                 goto out;
 514                         }
 515
 516                         goto gotreply;  /* break two levels */
 517
 518                 } /* while secs */
 519         } /* forever send/receive */
 520
 521         error = ETIMEDOUT;
 522         goto out;
 523
 524  gotreply:
 525
 526         /*
 527          * Pull as much as we can into first mbuf, to make
 528          * result buffer contiguous.  Note that if the entire
 529          * result won't fit into one mbuf, you're out of luck.
 530          * XXX - Should not rely on making the entire reply
 531          * contiguous (fix callers instead). -gwr
 532          */
 533 #if     DIAGNOSTIC
 534         if ((mbuf_flags(m) & MBUF_PKTHDR) == 0)
 535                 panic("krpc_call: received pkt w/o header?");
 536 #endif
 537         len = mbuf_pkthdr_len(m);
 538         if (sotype == SOCK_STREAM)
 539                 len -= 4;  /* the RPC record marker was read separately */
 540         if (mbuf_len(m) < len) {
 541                 if ((error = mbuf_pullup(&m, len)))
 542                         goto out;
 543                 reply = mbuf_data(m);
 544         }
 545
 546         /*
 547          * Strip RPC header
 548          */
 549         len = sizeof(*reply);
 550         if (reply->rp_u.rpu_ok.rp_auth.rp_atype != 0) {
 551                 len += ntohl(reply->rp_u.rpu_ok.rp_auth.rp_alen);
 552                 len = (len + 3) & ~3; /* XXX? */
 553         }
 554         mbuf_adj(m, len);
 555
 556         /* result */
 557         *data = m;
 558  out:
 559         sock_close(so);
 560 out1:
 561         if (nam) mbuf_freem(nam);
 562         if (mhead) mbuf_freem(mhead);
 563         return error;
 564 }