sys/nfs/nfs_diskless.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1990 The Regents of the University of California.
   5  * All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * William Jolitz.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      from: @(#)autoconf.c    7.1 (Berkeley) 5/9/91
  35  */
  36
  37 #include <sys/cdefs.h>
  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 static u_int
 148 nfs_setup_diskless_ifa_cb(void *arg, struct sockaddr_dl *sdl, u_int count)
 149 {
 150         struct sockaddr_dl *ourdl = arg;
 151
 152         if ((sdl->sdl_type == ourdl->sdl_type) &&
 153             (sdl->sdl_alen == ourdl->sdl_alen) &&
 154             !bcmp(LLADDR(sdl), LLADDR(ourdl), sdl->sdl_alen))
 155                 return (1);
 156
 157         return (0);
 158 }
 159
 160 /*
 161  * Populate the essential fields in the nfsv3_diskless structure.
 162  *
 163  * The loader is expected to export the following environment variables:
 164  *
 165  * boot.netif.name              name of boot interface
 166  * boot.netif.ip                IP address on boot interface
 167  * boot.netif.netmask           netmask on boot interface
 168  * boot.netif.gateway           default gateway (optional)
 169  * boot.netif.hwaddr            hardware address of boot interface
 170  * boot.netif.mtu               interface mtu from bootp/dhcp (optional)
 171  * boot.nfsroot.server          IP address of root filesystem server
 172  * boot.nfsroot.path            path of the root filesystem on server
 173  * boot.nfsroot.nfshandle       NFS handle for root filesystem on server
 174  * boot.nfsroot.nfshandlelen    and length of this handle (for NFSv3 only)
 175  * boot.nfsroot.options         NFS options for the root filesystem
 176  */
 177 void
 178 nfs_setup_diskless(void)
 179 {
 180         struct epoch_tracker et;
 181         struct if_iter iter;
 182         struct nfs_diskless *nd = &nfs_diskless;
 183         struct nfsv3_diskless *nd3 = &nfsv3_diskless;
 184         if_t ifp;
 185         struct sockaddr_dl ourdl;
 186         struct sockaddr_in myaddr, netmask;
 187         char *cp;
 188         int cnt, fhlen, is_nfsv3;
 189         uint32_t len;
 190         time_t timeout_at;
 191
 192         if (nfs_diskless_valid != 0)
 193                 return;
 194
 195         /* get handle size. If this succeeds, it's an NFSv3 setup. */
 196         if ((cp = kern_getenv("boot.nfsroot.nfshandlelen")) != NULL) {
 197                 cnt = sscanf(cp, "%d", &len);
 198                 freeenv(cp);
 199                 if (cnt != 1 || len == 0 || len > NFSX_V3FHMAX) {
 200                         printf("nfs_diskless: bad NFS handle len\n");
 201                         return;
 202                 }
 203                 nd3->root_fhsize = len;
 204                 is_nfsv3 = 1;
 205         } else
 206                 is_nfsv3 = 0;
 207         /* set up interface */
 208         if (inaddr_to_sockaddr("boot.netif.ip", &myaddr))
 209                 return;
 210         if (inaddr_to_sockaddr("boot.netif.netmask", &netmask)) {
 211                 printf("nfs_diskless: no netmask\n");
 212                 return;
 213         }
 214         if (is_nfsv3 != 0) {
 215                 bcopy(&myaddr, &nd3->myif.ifra_addr, sizeof(myaddr));
 216                 bcopy(&myaddr, &nd3->myif.ifra_broadaddr, sizeof(myaddr));
 217                 ((struct sockaddr_in *)
 218                    &nd3->myif.ifra_broadaddr)->sin_addr.s_addr =
 219                     myaddr.sin_addr.s_addr | ~ netmask.sin_addr.s_addr;
 220                 bcopy(&netmask, &nd3->myif.ifra_mask, sizeof(netmask));
 221         } else {
 222                 bcopy(&myaddr, &nd->myif.ifra_addr, sizeof(myaddr));
 223                 bcopy(&myaddr, &nd->myif.ifra_broadaddr, sizeof(myaddr));
 224                 ((struct sockaddr_in *)
 225                    &nd->myif.ifra_broadaddr)->sin_addr.s_addr =
 226                     myaddr.sin_addr.s_addr | ~ netmask.sin_addr.s_addr;
 227                 bcopy(&netmask, &nd->myif.ifra_mask, sizeof(netmask));
 228         }
 229
 230         if (hwaddr_to_sockaddr("boot.netif.hwaddr", &ourdl)) {
 231                 printf("nfs_diskless: no hardware address\n");
 232                 return;
 233         }
 234         timeout_at = time_uptime + NFS_IFACE_TIMEOUT_SECS;
 235 retry:
 236         CURVNET_SET(TD_TO_VNET(curthread));
 237         NET_EPOCH_ENTER(et);
 238         for (ifp = if_iter_start(&iter); ifp != NULL; ifp = if_iter_next(&iter)) {
 239                 cnt = if_foreach_lladdr(ifp, nfs_setup_diskless_ifa_cb, &ourdl);
 240                 if (cnt > 0)
 241                         break;
 242         }
 243         if_iter_finish(&iter);
 244         NET_EPOCH_EXIT(et);
 245         CURVNET_RESTORE();
 246         if (ifp != NULL)
 247                 goto match_done;
 248
 249         if (time_uptime < timeout_at) {
 250                 pause("nfssdl", hz / 5);
 251                 goto retry;
 252         }
 253         printf("nfs_diskless: no interface\n");
 254         return; /* no matching interface */
 255 match_done:
 256         kern_setenv("boot.netif.name", if_name(ifp));
 257         if (is_nfsv3 != 0) {
 258                 strlcpy(nd3->myif.ifra_name, if_name(ifp),
 259                     sizeof(nd3->myif.ifra_name));
 260
 261                 /* set up gateway */
 262                 inaddr_to_sockaddr("boot.netif.gateway", &nd3->mygateway);
 263
 264                 /* set up root mount */
 265                 nd3->root_args.rsize = 32768;           /* XXX tunable? */
 266                 nd3->root_args.wsize = 32768;
 267                 nd3->root_args.sotype = SOCK_STREAM;
 268                 nd3->root_args.flags = (NFSMNT_NFSV3 | NFSMNT_WSIZE |
 269                     NFSMNT_RSIZE | NFSMNT_RESVPORT);
 270                 if (inaddr_to_sockaddr("boot.nfsroot.server",
 271                     &nd3->root_saddr)) {
 272                         printf("nfs_diskless: no server\n");
 273                         return;
 274                 }
 275                 nd3->root_saddr.sin_port = htons(NFS_PORT);
 276                 fhlen = decode_nfshandle("boot.nfsroot.nfshandle",
 277                     &nd3->root_fh[0], NFSX_V3FHMAX);
 278                 if (fhlen == 0) {
 279                         printf("nfs_diskless: no NFS handle\n");
 280                         return;
 281                 }
 282                 if (fhlen != nd3->root_fhsize) {
 283                         printf("nfs_diskless: bad NFS handle len=%d\n", fhlen);
 284                         return;
 285                 }
 286                 if ((cp = kern_getenv("boot.nfsroot.path")) != NULL) {
 287                         strncpy(nd3->root_hostnam, cp, MNAMELEN - 1);
 288                         freeenv(cp);
 289                 }
 290                 if ((cp = kern_getenv("boot.nfsroot.options")) != NULL) {
 291                         nfs_parse_options(cp, &nd3->root_args);
 292                         freeenv(cp);
 293                 }
 294
 295                 nfs_diskless_valid = 3;
 296         } else {
 297                 strlcpy(nd->myif.ifra_name, if_name(ifp),
 298                     sizeof(nd->myif.ifra_name));
 299
 300                 /* set up gateway */
 301                 inaddr_to_sockaddr("boot.netif.gateway", &nd->mygateway);
 302
 303                 /* set up root mount */
 304                 nd->root_args.rsize = 8192;             /* XXX tunable? */
 305                 nd->root_args.wsize = 8192;
 306                 nd->root_args.sotype = SOCK_STREAM;
 307                 nd->root_args.flags = (NFSMNT_WSIZE |
 308                     NFSMNT_RSIZE | NFSMNT_RESVPORT);
 309                 if (inaddr_to_sockaddr("boot.nfsroot.server",
 310                     &nd->root_saddr)) {
 311                         printf("nfs_diskless: no server\n");
 312                         return;
 313                 }
 314                 nd->root_saddr.sin_port = htons(NFS_PORT);
 315                 if (decode_nfshandle("boot.nfsroot.nfshandle",
 316                     &nd->root_fh[0], NFSX_V2FH) == 0) {
 317                         printf("nfs_diskless: no NFS handle\n");
 318                         return;
 319                 }
 320                 if ((cp = kern_getenv("boot.nfsroot.path")) != NULL) {
 321                         strncpy(nd->root_hostnam, cp, MNAMELEN - 1);
 322                         freeenv(cp);
 323                 }
 324                 if ((cp = kern_getenv("boot.nfsroot.options")) != NULL) {
 325                         struct nfs_args args;
 326
 327                         /*
 328                          * XXX yech, convert between old and current
 329                          * arg format
 330                          */
 331                         args.flags = nd->root_args.flags;
 332                         args.sotype = nd->root_args.sotype;
 333                         args.rsize = nd->root_args.rsize;
 334                         args.wsize = nd->root_args.wsize;
 335                         nfs_parse_options(cp, &args);
 336                         nd->root_args.flags = args.flags;
 337                         nd->root_args.sotype = args.sotype;
 338                         nd->root_args.rsize = args.rsize;
 339                         nd->root_args.wsize = args.wsize;
 340                         freeenv(cp);
 341                 }
 342
 343                 nfs_diskless_valid = 1;
 344         }
 345 }
 346
 347 static int
 348 inaddr_to_sockaddr(char *ev, struct sockaddr_in *sa)
 349 {
 350         u_int32_t a[4];
 351         char *cp;
 352         int count;
 353
 354         bzero(sa, sizeof(*sa));
 355         sa->sin_len = sizeof(*sa);
 356         sa->sin_family = AF_INET;
 357
 358         if ((cp = kern_getenv(ev)) == NULL)
 359                 return (1);
 360         count = sscanf(cp, "%d.%d.%d.%d", &a[0], &a[1], &a[2], &a[3]);
 361         freeenv(cp);
 362         if (count != 4)
 363                 return (1);
 364         sa->sin_addr.s_addr =
 365             htonl((a[0] << 24) | (a[1] << 16) | (a[2] << 8) | a[3]);
 366         return (0);
 367 }
 368
 369 static int
 370 hwaddr_to_sockaddr(char *ev, struct sockaddr_dl *sa)
 371 {
 372         char *cp;
 373         u_int32_t a[6];
 374         int count;
 375
 376         bzero(sa, sizeof(*sa));
 377         sa->sdl_len = sizeof(*sa);
 378         sa->sdl_family = AF_LINK;
 379         sa->sdl_type = IFT_ETHER;
 380         sa->sdl_alen = ETHER_ADDR_LEN;
 381         if ((cp = kern_getenv(ev)) == NULL)
 382                 return (1);
 383         count = sscanf(cp, "%x:%x:%x:%x:%x:%x",
 384             &a[0], &a[1], &a[2], &a[3], &a[4], &a[5]);
 385         freeenv(cp);
 386         if (count != 6)
 387                 return (1);
 388         sa->sdl_data[0] = a[0];
 389         sa->sdl_data[1] = a[1];
 390         sa->sdl_data[2] = a[2];
 391         sa->sdl_data[3] = a[3];
 392         sa->sdl_data[4] = a[4];
 393         sa->sdl_data[5] = a[5];
 394         return (0);
 395 }
 396
 397 static int
 398 decode_nfshandle(char *ev, u_char *fh, int maxfh)
 399 {
 400         u_char *cp, *ep;
 401         int len, val;
 402
 403         ep = cp = kern_getenv(ev);
 404         if (cp == NULL)
 405                 return (0);
 406         if ((strlen(cp) < 2) || (*cp != 'X')) {
 407                 freeenv(ep);
 408                 return (0);
 409         }
 410         len = 0;
 411         cp++;
 412         for (;;) {
 413                 if (*cp == 'X') {
 414                         freeenv(ep);
 415                         return (len);
 416                 }
 417                 if ((sscanf(cp, "%2x", &val) != 1) || (val > 0xff)) {
 418                         freeenv(ep);
 419                         return (0);
 420                 }
 421                 *(fh++) = val;
 422                 len++;
 423                 cp += 2;
 424                 if (len > maxfh) {
 425                     freeenv(ep);
 426                     return (0);
 427                 }
 428         }
 429 }
 430
 431 #if !defined(BOOTP_NFSROOT)
 432 static void
 433 nfs_rootconf(void)
 434 {
 435
 436         nfs_setup_diskless();
 437         if (nfs_diskless_valid)
 438                 rootdevnames[0] = "nfs:";
 439 }
 440
 441 SYSINIT(cpu_rootconf, SI_SUB_ROOT_CONF, SI_ORDER_FIRST, nfs_rootconf, NULL);
 442 #endif