sys/nfsclient/krpc_subr.c

   1 /*      $NetBSD: krpc_subr.c,v 1.12.4.1 1996/06/07 00:52:26 cgd Exp $   */
   2
   3 /*-
   4  * Copyright (c) 1995 Gordon Ross, Adam Glass
   5  * Copyright (c) 1992 Regents of the University of California.
   6  * All rights reserved.
   7  *
   8  * This software was developed by the Computer Systems Engineering group
   9  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
  10  * contributed to Berkeley.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. All advertising materials mentioning features or use of this software
  21  *    must display the following acknowledgement:
  22  *      This product includes software developed by the University of
  23  *      California, Lawrence Berkeley Laboratory and its contributors.
  24  * 4. Neither the name of the University nor the names of its contributors
  25  *    may be used to endorse or promote products derived from this software
  26  *    without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  38  * SUCH DAMAGE.
  39  *
  40  * partially based on:
  41  *      libnetboot/rpc.c
  42  *               @(#) Header: rpc.c,v 1.12 93/09/28 08:31:56 leres Exp  (LBL)
  43  */
  44
  45 #include <sys/cdefs.h>
  46 __FBSDID("$FreeBSD$");
  47
  48 #include <sys/param.h>
  49 #include <sys/systm.h>
  50 #include <sys/malloc.h>
  51 #include <sys/mbuf.h>
  52 #include <sys/proc.h>
  53 #include <sys/socket.h>
  54 #include <sys/socketvar.h>
  55 #include <sys/uio.h>
  56
  57 #include <net/if.h>
  58 #include <netinet/in.h>
  59
  60 #include <rpc/rpcclnt.h>
  61
  62 #include <nfs/rpcv2.h>
  63 #include <nfsclient/krpc.h>
  64 #include <nfs/xdr_subs.h>
  65
  66 /*
  67  * Kernel support for Sun RPC
  68  *
  69  * Used currently for bootstrapping in nfs diskless configurations.
  70  */
  71
  72 /*
  73  * Generic RPC headers
  74  */
  75
  76 struct auth_info {
  77         u_int32_t       authtype;       /* auth type */
  78         u_int32_t       authlen;        /* auth length */
  79 };
  80
  81 struct auth_unix {
  82         int32_t   ua_time;
  83         int32_t   ua_hostname;  /* null */
  84         int32_t   ua_uid;
  85         int32_t   ua_gid;
  86         int32_t   ua_gidlist;   /* null */
  87 };
  88
  89 struct krpc_call {
  90         u_int32_t       rp_xid;         /* request transaction id */
  91         int32_t         rp_direction;   /* call direction (0) */
  92         u_int32_t       rp_rpcvers;     /* rpc version (2) */
  93         u_int32_t       rp_prog;        /* program */
  94         u_int32_t       rp_vers;        /* version */
  95         u_int32_t       rp_proc;        /* procedure */
  96         struct  auth_info rpc_auth;
  97         struct  auth_unix rpc_unix;
  98         struct  auth_info rpc_verf;
  99 };
 100
 101 struct krpc_reply {
 102         u_int32_t rp_xid;               /* request transaction id */
 103         int32_t  rp_direction;          /* call direction (1) */
 104         int32_t  rp_astatus;            /* accept status (0: accepted) */
 105         union {
 106                 u_int32_t rpu_errno;
 107                 struct {
 108                         struct auth_info rok_auth;
 109                         u_int32_t       rok_status;
 110                 } rpu_rok;
 111         } rp_u;
 112 };
 113 #define rp_errno  rp_u.rpu_errno
 114 #define rp_auth   rp_u.rpu_rok.rok_auth
 115 #define rp_status rp_u.rpu_rok.rok_status
 116
 117 #define MIN_REPLY_HDR 16        /* xid, dir, astat, errno */
 118
 119 /*
 120  * What is the longest we will wait before re-sending a request?
 121  * Note this is also the frequency of "RPC timeout" messages.
 122  * The re-send loop count sup linearly to this maximum, so the
 123  * first complaint will happen after (1+2+3+4+5)=15 seconds.
 124  */
 125 #define MAX_RESEND_DELAY 5      /* seconds */
 126
 127 /*
 128  * Call portmap to lookup a port number for a particular rpc program
 129  * Returns non-zero error on failure.
 130  */
 131 int
 132 krpc_portmap(struct sockaddr_in *sin, u_int prog, u_int vers, u_int16_t *portp,
 133     struct thread *td)
 134 {
 135         struct sdata {
 136                 u_int32_t prog;         /* call program */
 137                 u_int32_t vers;         /* call version */
 138                 u_int32_t proto;        /* call protocol */
 139                 u_int32_t port;         /* call port (unused) */
 140         } *sdata;
 141         struct rdata {
 142                 u_int16_t pad;
 143                 u_int16_t port;
 144         } *rdata;
 145         struct mbuf *m;
 146         int error;
 147
 148         /* The portmapper port is fixed. */
 149         if (prog == PMAPPROG) {
 150                 *portp = htons(PMAPPORT);
 151                 return 0;
 152         }
 153
 154         m = m_get(M_TRYWAIT, MT_DATA);
 155         if (m == NULL)
 156                 return ENOBUFS;
 157         sdata = mtod(m, struct sdata *);
 158         m->m_len = sizeof(*sdata);
 159
 160         /* Do the RPC to get it. */
 161         sdata->prog = txdr_unsigned(prog);
 162         sdata->vers = txdr_unsigned(vers);
 163         sdata->proto = txdr_unsigned(IPPROTO_UDP);
 164         sdata->port = 0;
 165
 166         sin->sin_port = htons(PMAPPORT);
 167         error = krpc_call(sin, PMAPPROG, PMAPVERS,
 168                                           PMAPPROC_GETPORT, &m, NULL, td);
 169         if (error)
 170                 return error;
 171
 172         if (m->m_len < sizeof(*rdata)) {
 173                 m = m_pullup(m, sizeof(*rdata));
 174                 if (m == NULL)
 175                         return ENOBUFS;
 176         }
 177         rdata = mtod(m, struct rdata *);
 178         *portp = rdata->port;
 179
 180         m_freem(m);
 181         return 0;
 182 }
 183
 184 /*
 185  * Do a remote procedure call (RPC) and wait for its reply.
 186  * If from_p is non-null, then we are doing broadcast, and
 187  * the address from whence the response came is saved there.
 188  */
 189 int
 190 krpc_call(struct sockaddr_in *sa, u_int prog, u_int vers, u_int func,
 191     struct mbuf **data, struct sockaddr **from_p, struct thread *td)
 192 {
 193         struct socket *so;
 194         struct sockaddr_in *sin, ssin;
 195         struct sockaddr *from;
 196         struct mbuf *m, *nam, *mhead;
 197         struct krpc_call *call;
 198         struct krpc_reply *reply;
 199         struct sockopt sopt;
 200         struct timeval tv;
 201         struct uio auio;
 202         int error, rcvflg, timo, secs, len;
 203         static u_int32_t xid = ~0xFF;
 204         u_int16_t tport;
 205         u_int32_t saddr;
 206
 207         /*
 208          * Validate address family.
 209          * Sorry, this is INET specific...
 210          */
 211         if (sa->sin_family != AF_INET)
 212                 return (EAFNOSUPPORT);
 213
 214         /* Free at end if not null. */
 215         nam = mhead = NULL;
 216         from = NULL;
 217
 218         NET_ASSERT_GIANT();
 219
 220         /*
 221          * Create socket and set its recieve timeout.
 222          */
 223         if ((error = socreate(AF_INET, &so, SOCK_DGRAM, 0, td->td_ucred, td)))
 224                 goto out;
 225
 226         tv.tv_sec = 1;
 227         tv.tv_usec = 0;
 228         bzero(&sopt, sizeof sopt);
 229         sopt.sopt_dir = SOPT_SET;
 230         sopt.sopt_level = SOL_SOCKET;
 231         sopt.sopt_name = SO_RCVTIMEO;
 232         sopt.sopt_val = &tv;
 233         sopt.sopt_valsize = sizeof tv;
 234
 235         if ((error = sosetopt(so, &sopt)) != 0)
 236                 goto out;
 237
 238         /*
 239          * Enable broadcast if necessary.
 240          */
 241         if (from_p) {
 242                 int on = 1;
 243                 sopt.sopt_name = SO_BROADCAST;
 244                 sopt.sopt_val = &on;
 245                 sopt.sopt_valsize = sizeof on;
 246                 if ((error = sosetopt(so, &sopt)) != 0)
 247                         goto out;
 248         }
 249
 250         /*
 251          * Bind the local endpoint to a reserved port,
 252          * because some NFS servers refuse requests from
 253          * non-reserved (non-privileged) ports.
 254          */
 255         sin = &ssin;
 256         bzero(sin, sizeof *sin);
 257         sin->sin_len = sizeof(*sin);
 258         sin->sin_family = AF_INET;
 259         sin->sin_addr.s_addr = INADDR_ANY;
 260         tport = IPPORT_RESERVED;
 261         do {
 262                 tport--;
 263                 sin->sin_port = htons(tport);
 264                 error = sobind(so, (struct sockaddr *)sin, td);
 265         } while (error == EADDRINUSE &&
 266                          tport > IPPORT_RESERVED / 2);
 267         if (error) {
 268                 printf("bind failed\n");
 269                 goto out;
 270         }
 271
 272         /*
 273          * Setup socket address for the server.
 274          */
 275
 276         /*
 277          * Prepend RPC message header.
 278          */
 279         mhead = m_gethdr(M_TRYWAIT, MT_DATA);
 280         mhead->m_next = *data;
 281         call = mtod(mhead, struct krpc_call *);
 282         mhead->m_len = sizeof(*call);
 283         bzero((caddr_t)call, sizeof(*call));
 284         /* rpc_call part */
 285         xid++;
 286         call->rp_xid = txdr_unsigned(xid);
 287         /* call->rp_direction = 0; */
 288         call->rp_rpcvers = txdr_unsigned(2);
 289         call->rp_prog = txdr_unsigned(prog);
 290         call->rp_vers = txdr_unsigned(vers);
 291         call->rp_proc = txdr_unsigned(func);
 292         /* rpc_auth part (auth_unix as root) */
 293         call->rpc_auth.authtype = txdr_unsigned(RPCAUTH_UNIX);
 294         call->rpc_auth.authlen  = txdr_unsigned(sizeof(struct auth_unix));
 295         /* rpc_verf part (auth_null) */
 296         call->rpc_verf.authtype = 0;
 297         call->rpc_verf.authlen  = 0;
 298
 299         /*
 300          * Setup packet header
 301          */
 302         m_fixhdr(mhead);
 303         mhead->m_pkthdr.rcvif = NULL;
 304
 305         /*
 306          * Send it, repeatedly, until a reply is received,
 307          * but delay each re-send by an increasing amount.
 308          * If the delay hits the maximum, start complaining.
 309          */
 310         timo = 0;
 311         for (;;) {
 312                 /* Send RPC request (or re-send). */
 313                 m = m_copym(mhead, 0, M_COPYALL, M_TRYWAIT);
 314                 if (m == NULL) {
 315                         error = ENOBUFS;
 316                         goto out;
 317                 }
 318                 error = sosend(so, (struct sockaddr *)sa, NULL, m,
 319                                NULL, 0, td);
 320                 if (error) {
 321                         printf("krpc_call: sosend: %d\n", error);
 322                         goto out;
 323                 }
 324                 m = NULL;
 325
 326                 /* Determine new timeout. */
 327                 if (timo < MAX_RESEND_DELAY)
 328                         timo++;
 329                 else {
 330                         saddr = ntohl(sa->sin_addr.s_addr);
 331                         printf("RPC timeout for server %d.%d.%d.%d\n",
 332                                (saddr >> 24) & 255,
 333                                (saddr >> 16) & 255,
 334                                (saddr >> 8) & 255,
 335                                saddr & 255);
 336                 }
 337
 338                 /*
 339                  * Wait for up to timo seconds for a reply.
 340                  * The socket receive timeout was set to 1 second.
 341                  */
 342                 secs = timo;
 343                 while (secs > 0) {
 344                         if (from) {
 345                                 FREE(from, M_SONAME);
 346                                 from = NULL;
 347                         }
 348                         if (m) {
 349                                 m_freem(m);
 350                                 m = NULL;
 351                         }
 352                         bzero(&auio, sizeof(auio));
 353                         auio.uio_resid = len = 1<<16;
 354                         rcvflg = 0;
 355                         error = soreceive(so, &from, &auio, &m, NULL, &rcvflg);
 356                         if (error == EWOULDBLOCK) {
 357                                 secs--;
 358                                 continue;
 359                         }
 360                         if (error)
 361                                 goto out;
 362                         len -= auio.uio_resid;
 363
 364                         /* Does the reply contain at least a header? */
 365                         if (len < MIN_REPLY_HDR)
 366                                 continue;
 367                         if (m->m_len < MIN_REPLY_HDR)
 368                                 continue;
 369                         reply = mtod(m, struct krpc_reply *);
 370
 371                         /* Is it the right reply? */
 372                         if (reply->rp_direction != txdr_unsigned(RPC_REPLY))
 373                                 continue;
 374
 375                         if (reply->rp_xid != txdr_unsigned(xid))
 376                                 continue;
 377
 378                         /* Was RPC accepted? (authorization OK) */
 379                         if (reply->rp_astatus != 0) {
 380                                 error = fxdr_unsigned(u_int32_t, reply->rp_errno);
 381                                 printf("rpc denied, error=%d\n", error);
 382                                 continue;
 383                         }
 384
 385                         /* Did the call succeed? */
 386                         if (reply->rp_status != 0) {
 387                                 error = fxdr_unsigned(u_int32_t, reply->rp_status);
 388                                 if (error == RPC_PROGMISMATCH) {
 389                                   error = EBADRPC;
 390                                   goto out;
 391                                 }
 392                                 printf("rpc denied, status=%d\n", error);
 393                                 continue;
 394                         }
 395
 396                         goto gotreply;  /* break two levels */
 397
 398                 } /* while secs */
 399         } /* forever send/receive */
 400
 401         error = ETIMEDOUT;
 402         goto out;
 403
 404  gotreply:
 405
 406         /*
 407          * Get RPC reply header into first mbuf,
 408          * get its length, then strip it off.
 409          */
 410         len = sizeof(*reply);
 411         if (m->m_len < len) {
 412                 m = m_pullup(m, len);
 413                 if (m == NULL) {
 414                         error = ENOBUFS;
 415                         goto out;
 416                 }
 417         }
 418         reply = mtod(m, struct krpc_reply *);
 419         if (reply->rp_auth.authtype != 0) {
 420                 len += fxdr_unsigned(u_int32_t, reply->rp_auth.authlen);
 421                 len = (len + 3) & ~3; /* XXX? */
 422         }
 423         m_adj(m, len);
 424
 425         /* result */
 426         *data = m;
 427         if (from_p) {
 428                 *from_p = from;
 429                 from = NULL;
 430         }
 431
 432  out:
 433         if (mhead) m_freem(mhead);
 434         if (from) free(from, M_SONAME);
 435         soclose(so);
 436         return error;
 437 }
 438
 439 /*
 440  * eXternal Data Representation routines.
 441  * (but with non-standard args...)
 442  */
 443
 444 /*
 445  * String representation for RPC.
 446  */
 447 struct xdr_string {
 448         u_int32_t len;          /* length without null or padding */
 449         char data[4];   /* data (longer, of course) */
 450     /* data is padded to a long-word boundary */
 451 };
 452
 453 struct mbuf *
 454 xdr_string_encode(char *str, int len)
 455 {
 456         struct mbuf *m;
 457         struct xdr_string *xs;
 458         int dlen;       /* padded string length */
 459         int mlen;       /* message length */
 460
 461         dlen = (len + 3) & ~3;
 462         mlen = dlen + 4;
 463
 464         if (mlen > MCLBYTES)            /* If too big, we just can't do it. */
 465                 return (NULL);
 466
 467         m = m_get(M_TRYWAIT, MT_DATA);
 468         if (mlen > MLEN) {
 469                 MCLGET(m, M_TRYWAIT);
 470                 if ((m->m_flags & M_EXT) == 0) {
 471                         (void) m_free(m);       /* There can be only one. */
 472                         return (NULL);
 473                 }
 474         }
 475         xs = mtod(m, struct xdr_string *);
 476         m->m_len = mlen;
 477         xs->len = txdr_unsigned(len);
 478         bcopy(str, xs->data, len);
 479         return (m);
 480 }