sys/nfs/nfs_diskless.c

   1 /*-
   2  * Copyright (c) 1990 The Regents of the University of California.
   3  * All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * William Jolitz.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 4. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * 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 REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  *      from: @(#)autoconf.c    7.1 (Berkeley) 5/9/91
  33  */
  34
  35 #include <sys/cdefs.h>
  36 __FBSDID("$FreeBSD$");
  37
  38 #include "opt_bootp.h"
  39
  40 #include <sys/param.h>
  41 #include <sys/systm.h>
  42 #include <sys/jail.h>
  43 #include <sys/kernel.h>
  44 #include <sys/malloc.h>
  45 #include <sys/mount.h>
  46 #include <sys/socket.h>
  47
  48 #include <net/if.h>
  49 #include <net/if_dl.h>
  50 #include <net/if_types.h>
  51 #include <net/if_var.h>
  52 #include <net/ethernet.h>
  53 #include <net/vnet.h>
  54
  55 #include <netinet/in.h>
  56 #include <nfs/nfsproto.h>
  57 #include <nfsclient/nfs.h>
  58 #include <nfs/nfsdiskless.h>
  59
  60 #define NFS_IFACE_TIMEOUT_SECS  10 /* Timeout for interface to appear. */
  61
  62 static int inaddr_to_sockaddr(char *ev, struct sockaddr_in *sa);
  63 static int hwaddr_to_sockaddr(char *ev, struct sockaddr_dl *sa);
  64 static int decode_nfshandle(char *ev, u_char *fh, int maxfh);
  65
  66 /*
  67  * This structure must be filled in by a primary bootstrap or bootstrap
  68  * server for a diskless/dataless machine. It is initialized below just
  69  * to ensure that it is allocated to initialized data (.data not .bss).
  70  */
  71 struct nfs_diskless     nfs_diskless = { { { 0 } } };
  72 struct nfsv3_diskless   nfsv3_diskless = { { { 0 } } };
  73 int                     nfs_diskless_valid = 0;
  74
  75 /*
  76  * Validate/sanity check a rsize/wsize parameter.
  77  */
  78 static int
  79 checkrwsize(unsigned long v, const char *name)
  80 {
  81         /*
  82          * 32K is used as an upper bound because most servers
  83          * limit block size to satisfy IPv4's limit of
  84          * 64K/reassembled packet.  The lower bound is pretty
  85          * much arbitrary.
  86          */
  87         if (!(4 <= v && v <= 32*1024)) {
  88                 printf("nfs_parse_options: invalid %s %lu ignored\n", name, v);
  89                 return 0;
  90         } else
  91                 return 1;
  92 }
  93
  94 /*
  95  * Parse mount options and apply them to the supplied
  96  * nfs_diskless state.  Used also by bootp/dhcp support.
  97  */
  98 void
  99 nfs_parse_options(const char *envopts, struct nfs_args *nd)
 100 {
 101         char *opts, *o, *otmp;
 102         unsigned long v;
 103
 104         opts = strdup(envopts, M_TEMP);
 105         otmp = opts;
 106         while ((o = strsep(&otmp, ":;, ")) != NULL) {
 107                 if (*o == '\0')
 108                         ; /* Skip empty options. */
 109                 else if (strcmp(o, "soft") == 0)
 110                         nd->flags |= NFSMNT_SOFT;
 111                 else if (strcmp(o, "intr") == 0)
 112                         nd->flags |= NFSMNT_INT;
 113                 else if (strcmp(o, "conn") == 0)
 114                         nd->flags |= NFSMNT_NOCONN;
 115                 else if (strcmp(o, "nolockd") == 0)
 116                         nd->flags |= NFSMNT_NOLOCKD;
 117                 else if (strcmp(o, "nocto") == 0)
 118                         nd->flags |= NFSMNT_NOCTO;
 119                 else if (strcmp(o, "nfsv2") == 0)
 120                         nd->flags &= ~(NFSMNT_NFSV3 | NFSMNT_NFSV4);
 121                 else if (strcmp(o, "nfsv3") == 0) {
 122                         nd->flags &= ~NFSMNT_NFSV4;
 123                         nd->flags |= NFSMNT_NFSV3;
 124                 } else if (strcmp(o, "tcp") == 0)
 125                         nd->sotype = SOCK_STREAM;
 126                 else if (strcmp(o, "udp") == 0)
 127                         nd->sotype = SOCK_DGRAM;
 128                 else if (strncmp(o, "rsize=", 6) == 0) {
 129                         v = strtoul(o+6, NULL, 10);
 130                         if (checkrwsize(v, "rsize")) {
 131                                 nd->rsize = (int) v;
 132                                 nd->flags |= NFSMNT_RSIZE;
 133                         }
 134                 } else if (strncmp(o, "wsize=", 6) == 0) {
 135                         v = strtoul(o+6, NULL, 10);
 136                         if (checkrwsize(v, "wsize")) {
 137                                 nd->wsize = (int) v;
 138                                 nd->flags |= NFSMNT_WSIZE;
 139                         }
 140                 } else
 141                         printf("%s: skipping unknown option \"%s\"\n",
 142                             __func__, o);
 143         }
 144         free(opts, M_TEMP);
 145 }
 146
 147 /*
 148  * Populate the essential fields in the nfsv3_diskless structure.
 149  *
 150  * The loader is expected to export the following environment variables:
 151  *
 152  * boot.netif.name              name of boot interface
 153  * boot.netif.ip                IP address on boot interface
 154  * boot.netif.netmask           netmask on boot interface
 155  * boot.netif.gateway           default gateway (optional)
 156  * boot.netif.hwaddr            hardware address of boot interface
 157  * boot.nfsroot.server          IP address of root filesystem server
 158  * boot.nfsroot.path            path of the root filesystem on server
 159  * boot.nfsroot.nfshandle       NFS handle for root filesystem on server
 160  * boot.nfsroot.nfshandlelen    and length of this handle (for NFSv3 only)
 161  * boot.nfsroot.options         NFS options for the root filesystem
 162  */
 163 void
 164 nfs_setup_diskless(void)
 165 {
 166         struct nfs_diskless *nd = &nfs_diskless;
 167         struct nfsv3_diskless *nd3 = &nfsv3_diskless;
 168         struct ifnet *ifp;
 169         struct ifaddr *ifa;
 170         struct sockaddr_dl *sdl, ourdl;
 171         struct sockaddr_in myaddr, netmask;
 172         char *cp;
 173         int cnt, fhlen, is_nfsv3;
 174         uint32_t len;
 175         time_t timeout_at;
 176
 177         if (nfs_diskless_valid != 0)
 178                 return;
 179
 180         /* get handle size. If this succeeds, it's an NFSv3 setup. */
 181         if ((cp = kern_getenv("boot.nfsroot.nfshandlelen")) != NULL) {
 182                 cnt = sscanf(cp, "%d", &len);
 183                 freeenv(cp);
 184                 if (cnt != 1 || len == 0 || len > NFSX_V3FHMAX) {
 185                         printf("nfs_diskless: bad NFS handle len\n");
 186                         return;
 187                 }
 188                 nd3->root_fhsize = len;
 189                 is_nfsv3 = 1;
 190         } else
 191                 is_nfsv3 = 0;
 192         /* set up interface */
 193         if (inaddr_to_sockaddr("boot.netif.ip", &myaddr))
 194                 return;
 195         if (inaddr_to_sockaddr("boot.netif.netmask", &netmask)) {
 196                 printf("nfs_diskless: no netmask\n");
 197                 return;
 198         }
 199         if (is_nfsv3 != 0) {
 200                 bcopy(&myaddr, &nd3->myif.ifra_addr, sizeof(myaddr));
 201                 bcopy(&myaddr, &nd3->myif.ifra_broadaddr, sizeof(myaddr));
 202                 ((struct sockaddr_in *)
 203                    &nd3->myif.ifra_broadaddr)->sin_addr.s_addr =
 204                     myaddr.sin_addr.s_addr | ~ netmask.sin_addr.s_addr;
 205                 bcopy(&netmask, &nd3->myif.ifra_mask, sizeof(netmask));
 206         } else {
 207                 bcopy(&myaddr, &nd->myif.ifra_addr, sizeof(myaddr));
 208                 bcopy(&myaddr, &nd->myif.ifra_broadaddr, sizeof(myaddr));
 209                 ((struct sockaddr_in *)
 210                    &nd->myif.ifra_broadaddr)->sin_addr.s_addr =
 211                     myaddr.sin_addr.s_addr | ~ netmask.sin_addr.s_addr;
 212                 bcopy(&netmask, &nd->myif.ifra_mask, sizeof(netmask));
 213         }
 214
 215         if (hwaddr_to_sockaddr("boot.netif.hwaddr", &ourdl)) {
 216                 printf("nfs_diskless: no hardware address\n");
 217                 return;
 218         }
 219         ifa = NULL;
 220         timeout_at = time_uptime + NFS_IFACE_TIMEOUT_SECS;
 221 retry:
 222         CURVNET_SET(TD_TO_VNET(curthread));
 223         IFNET_RLOCK();
 224         TAILQ_FOREACH(ifp, &V_ifnet, if_link) {
 225                 TAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link) {
 226                         if (ifa->ifa_addr->sa_family == AF_LINK) {
 227                                 sdl = (struct sockaddr_dl *)ifa->ifa_addr;
 228                                 if ((sdl->sdl_type == ourdl.sdl_type) &&
 229                                     (sdl->sdl_alen == ourdl.sdl_alen) &&
 230                                     !bcmp(LLADDR(sdl),
 231                                           LLADDR(&ourdl),
 232                                           sdl->sdl_alen)) {
 233                                     IFNET_RUNLOCK();
 234                                     CURVNET_RESTORE();
 235                                     goto match_done;
 236                                 }
 237                         }
 238                 }
 239         }
 240         IFNET_RUNLOCK();
 241         CURVNET_RESTORE();
 242         if (time_uptime < timeout_at) {
 243                 pause("nfssdl", hz / 5);
 244                 goto retry;
 245         }
 246         printf("nfs_diskless: no interface\n");
 247         return; /* no matching interface */
 248 match_done:
 249         kern_setenv("boot.netif.name", ifp->if_xname);
 250         if (is_nfsv3 != 0) {
 251                 strlcpy(nd3->myif.ifra_name, ifp->if_xname,
 252                     sizeof(nd3->myif.ifra_name));
 253
 254                 /* set up gateway */
 255                 inaddr_to_sockaddr("boot.netif.gateway", &nd3->mygateway);
 256
 257                 /* set up root mount */
 258                 nd3->root_args.rsize = 32768;           /* XXX tunable? */
 259                 nd3->root_args.wsize = 32768;
 260                 nd3->root_args.sotype = SOCK_STREAM;
 261                 nd3->root_args.flags = (NFSMNT_NFSV3 | NFSMNT_WSIZE |
 262                     NFSMNT_RSIZE | NFSMNT_RESVPORT);
 263                 if (inaddr_to_sockaddr("boot.nfsroot.server",
 264                     &nd3->root_saddr)) {
 265                         printf("nfs_diskless: no server\n");
 266                         return;
 267                 }
 268                 nd3->root_saddr.sin_port = htons(NFS_PORT);
 269                 fhlen = decode_nfshandle("boot.nfsroot.nfshandle",
 270                     &nd3->root_fh[0], NFSX_V3FHMAX);
 271                 if (fhlen == 0) {
 272                         printf("nfs_diskless: no NFS handle\n");
 273                         return;
 274                 }
 275                 if (fhlen != nd3->root_fhsize) {
 276                         printf("nfs_diskless: bad NFS handle len=%d\n", fhlen);
 277                         return;
 278                 }
 279                 if ((cp = kern_getenv("boot.nfsroot.path")) != NULL) {
 280                         strncpy(nd3->root_hostnam, cp, MNAMELEN - 1);
 281                         freeenv(cp);
 282                 }
 283                 if ((cp = kern_getenv("boot.nfsroot.options")) != NULL) {
 284                         nfs_parse_options(cp, &nd3->root_args);
 285                         freeenv(cp);
 286                 }
 287
 288                 nfs_diskless_valid = 3;
 289         } else {
 290                 strlcpy(nd->myif.ifra_name, ifp->if_xname,
 291                     sizeof(nd->myif.ifra_name));
 292
 293                 /* set up gateway */
 294                 inaddr_to_sockaddr("boot.netif.gateway", &nd->mygateway);
 295
 296                 /* set up root mount */
 297                 nd->root_args.rsize = 8192;             /* XXX tunable? */
 298                 nd->root_args.wsize = 8192;
 299                 nd->root_args.sotype = SOCK_STREAM;
 300                 nd->root_args.flags = (NFSMNT_WSIZE |
 301                     NFSMNT_RSIZE | NFSMNT_RESVPORT);
 302                 if (inaddr_to_sockaddr("boot.nfsroot.server",
 303                     &nd->root_saddr)) {
 304                         printf("nfs_diskless: no server\n");
 305                         return;
 306                 }
 307                 nd->root_saddr.sin_port = htons(NFS_PORT);
 308                 if (decode_nfshandle("boot.nfsroot.nfshandle",
 309                     &nd->root_fh[0], NFSX_V2FH) == 0) {
 310                         printf("nfs_diskless: no NFS handle\n");
 311                         return;
 312                 }
 313                 if ((cp = kern_getenv("boot.nfsroot.path")) != NULL) {
 314                         strncpy(nd->root_hostnam, cp, MNAMELEN - 1);
 315                         freeenv(cp);
 316                 }
 317                 if ((cp = kern_getenv("boot.nfsroot.options")) != NULL) {
 318                         struct nfs_args args;
 319
 320                         /*
 321                          * XXX yech, convert between old and current
 322                          * arg format
 323                          */
 324                         args.flags = nd->root_args.flags;
 325                         args.sotype = nd->root_args.sotype;
 326                         args.rsize = nd->root_args.rsize;
 327                         args.wsize = nd->root_args.wsize;
 328                         nfs_parse_options(cp, &args);
 329                         nd->root_args.flags = args.flags;
 330                         nd->root_args.sotype = args.sotype;
 331                         nd->root_args.rsize = args.rsize;
 332                         nd->root_args.wsize = args.wsize;
 333                         freeenv(cp);
 334                 }
 335
 336                 nfs_diskless_valid = 1;
 337         }
 338 }
 339
 340 static int
 341 inaddr_to_sockaddr(char *ev, struct sockaddr_in *sa)
 342 {
 343         u_int32_t a[4];
 344         char *cp;
 345         int count;
 346
 347         bzero(sa, sizeof(*sa));
 348         sa->sin_len = sizeof(*sa);
 349         sa->sin_family = AF_INET;
 350
 351         if ((cp = kern_getenv(ev)) == NULL)
 352                 return (1);
 353         count = sscanf(cp, "%d.%d.%d.%d", &a[0], &a[1], &a[2], &a[3]);
 354         freeenv(cp);
 355         if (count != 4)
 356                 return (1);
 357         sa->sin_addr.s_addr =
 358             htonl((a[0] << 24) | (a[1] << 16) | (a[2] << 8) | a[3]);
 359         return (0);
 360 }
 361
 362 static int
 363 hwaddr_to_sockaddr(char *ev, struct sockaddr_dl *sa)
 364 {
 365         char *cp;
 366         u_int32_t a[6];
 367         int count;
 368
 369         bzero(sa, sizeof(*sa));
 370         sa->sdl_len = sizeof(*sa);
 371         sa->sdl_family = AF_LINK;
 372         sa->sdl_type = IFT_ETHER;
 373         sa->sdl_alen = ETHER_ADDR_LEN;
 374         if ((cp = kern_getenv(ev)) == NULL)
 375                 return (1);
 376         count = sscanf(cp, "%x:%x:%x:%x:%x:%x",
 377             &a[0], &a[1], &a[2], &a[3], &a[4], &a[5]);
 378         freeenv(cp);
 379         if (count != 6)
 380                 return (1);
 381         sa->sdl_data[0] = a[0];
 382         sa->sdl_data[1] = a[1];
 383         sa->sdl_data[2] = a[2];
 384         sa->sdl_data[3] = a[3];
 385         sa->sdl_data[4] = a[4];
 386         sa->sdl_data[5] = a[5];
 387         return (0);
 388 }
 389
 390 static int
 391 decode_nfshandle(char *ev, u_char *fh, int maxfh)
 392 {
 393         u_char *cp, *ep;
 394         int len, val;
 395
 396         ep = cp = kern_getenv(ev);
 397         if (cp == NULL)
 398                 return (0);
 399         if ((strlen(cp) < 2) || (*cp != 'X')) {
 400                 freeenv(ep);
 401                 return (0);
 402         }
 403         len = 0;
 404         cp++;
 405         for (;;) {
 406                 if (*cp == 'X') {
 407                         freeenv(ep);
 408                         return (len);
 409                 }
 410                 if ((sscanf(cp, "%2x", &val) != 1) || (val > 0xff)) {
 411                         freeenv(ep);
 412                         return (0);
 413                 }
 414                 *(fh++) = val;
 415                 len++;
 416                 cp += 2;
 417                 if (len > maxfh) {
 418                     freeenv(ep);
 419                     return (0);
 420                 }
 421         }
 422 }
 423
 424 #if !defined(BOOTP_NFSROOT)
 425 static void
 426 nfs_rootconf(void)
 427 {
 428
 429         nfs_setup_diskless();
 430         if (nfs_diskless_valid)
 431                 rootdevnames[0] = "nfs:";
 432 }
 433
 434 SYSINIT(cpu_rootconf, SI_SUB_ROOT_CONF, SI_ORDER_FIRST, nfs_rootconf, NULL);
 435 #endif
 436