stand/common/dev_net.c

   1 /*      $NetBSD: dev_net.c,v 1.23 2008/04/28 20:24:06 martin Exp $      */
   2
   3 /*-
   4  * Copyright (c) 1997 The NetBSD Foundation, Inc.
   5  * All rights reserved.
   6  *
   7  * This code is derived from software contributed to The NetBSD Foundation
   8  * by Gordon W. Ross.
   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  *
  19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #include <sys/cdefs.h>
  33 __FBSDID("$FreeBSD$");
  34
  35 /*-
  36  * This module implements a "raw device" interface suitable for
  37  * use by the stand-alone I/O library NFS code.  This interface
  38  * does not support any "block" access, and exists only for the
  39  * purpose of initializing the network interface, getting boot
  40  * parameters, and performing the NFS mount.
  41  *
  42  * At open time, this does:
  43  *
  44  * find interface      - netif_open()
  45  * RARP for IP address - rarp_getipaddress()
  46  * RPC/bootparams      - callrpc(d, RPC_BOOTPARAMS, ...)
  47  * RPC/mountd          - nfs_mount(sock, ip, path)
  48  *
  49  * the root file handle from mountd is saved in a global
  50  * for use by the NFS open code (NFS/lookup).
  51  */
  52
  53 #include <machine/stdarg.h>
  54 #include <sys/param.h>
  55 #include <sys/socket.h>
  56 #include <net/if.h>
  57 #include <netinet/in.h>
  58 #include <netinet/in_systm.h>
  59
  60 #include <stand.h>
  61 #include <stddef.h>
  62 #include <string.h>
  63 #include <net.h>
  64 #include <netif.h>
  65 #include <bootp.h>
  66 #include <bootparam.h>
  67
  68 #include "dev_net.h"
  69 #include "bootstrap.h"
  70
  71 #ifdef  NETIF_DEBUG
  72 int debug = 0;
  73 #endif
  74
  75 static char *netdev_name;
  76 static int netdev_sock = -1;
  77 static int netdev_opens;
  78
  79 static int      net_init(void);
  80 static int      net_open(struct open_file *, ...);
  81 static int      net_close(struct open_file *);
  82 static void     net_cleanup(void);
  83 static int      net_strategy(void *, int, daddr_t, size_t, char *, size_t *);
  84 static int      net_print(int);
  85
  86 static int net_getparams(int sock);
  87
  88 struct devsw netdev = {
  89         "net",
  90         DEVT_NET,
  91         net_init,
  92         net_strategy,
  93         net_open,
  94         net_close,
  95         noioctl,
  96         net_print,
  97         net_cleanup
  98 };
  99
 100 static struct uri_scheme {
 101         const char *scheme;
 102         int proto;
 103 } uri_schemes[] = {
 104         { "tftp:/", NET_TFTP },
 105         { "nfs:/", NET_NFS },
 106 };
 107
 108 static int
 109 net_init(void)
 110 {
 111
 112         return (0);
 113 }
 114
 115 /*
 116  * Called by devopen after it sets f->f_dev to our devsw entry.
 117  * This opens the low-level device and sets f->f_devdata.
 118  * This is declared with variable arguments...
 119  */
 120 static int
 121 net_open(struct open_file *f, ...)
 122 {
 123         struct iodesc *d;
 124         va_list args;
 125         struct devdesc *dev;
 126         const char *devname;    /* Device part of file name (or NULL). */
 127         int error = 0;
 128
 129         va_start(args, f);
 130         dev = va_arg(args, struct devdesc *);
 131         va_end(args);
 132
 133         devname = dev->d_dev->dv_name;
 134         /* Before opening another interface, close the previous one first. */
 135         if (netdev_sock >= 0 && strcmp(devname, netdev_name) != 0)
 136                 net_cleanup();
 137
 138         /* On first open, do netif open, mount, etc. */
 139         if (netdev_opens == 0) {
 140                 /* Find network interface. */
 141                 if (netdev_sock < 0) {
 142                         netdev_sock = netif_open(dev);
 143                         if (netdev_sock < 0) {
 144                                 printf("%s: netif_open() failed\n", __func__);
 145                                 return (ENXIO);
 146                         }
 147                         netdev_name = strdup(devname);
 148 #ifdef  NETIF_DEBUG
 149                         if (debug)
 150                                 printf("%s: netif_open() succeeded\n",
 151                                     __func__);
 152 #endif
 153                 }
 154                 /*
 155                  * If network params were not set by netif_open(), try to get
 156                  * them via bootp, rarp, etc.
 157                  */
 158                 if (rootip.s_addr == 0) {
 159                         /* Get root IP address, and path, etc. */
 160                         error = net_getparams(netdev_sock);
 161                         if (error) {
 162                                 /* getparams makes its own noise */
 163                                 free(netdev_name);
 164                                 netif_close(netdev_sock);
 165                                 netdev_sock = -1;
 166                                 return (error);
 167                         }
 168                 }
 169                 /*
 170                  * Set the variables required by the kernel's nfs_diskless
 171                  * mechanism.  This is the minimum set of variables required to
 172                  * mount a root filesystem without needing to obtain additional
 173                  * info from bootp or other sources.
 174                  */
 175                 d = socktodesc(netdev_sock);
 176                 setenv("boot.netif.hwaddr", ether_sprintf(d->myea), 1);
 177                 setenv("boot.netif.ip", inet_ntoa(myip), 1);
 178                 setenv("boot.netif.netmask", intoa(netmask), 1);
 179                 setenv("boot.netif.gateway", inet_ntoa(gateip), 1);
 180                 setenv("boot.netif.server", inet_ntoa(rootip), 1);
 181                 if (netproto == NET_TFTP) {
 182                         setenv("boot.tftproot.server", inet_ntoa(rootip), 1);
 183                         setenv("boot.tftproot.path", rootpath, 1);
 184                 } else if (netproto == NET_NFS) {
 185                         setenv("boot.nfsroot.server", inet_ntoa(rootip), 1);
 186                         setenv("boot.nfsroot.path", rootpath, 1);
 187                 }
 188                 if (intf_mtu != 0) {
 189                         char mtu[16];
 190                         snprintf(mtu, sizeof(mtu), "%u", intf_mtu);
 191                         setenv("boot.netif.mtu", mtu, 1);
 192                 }
 193
 194         }
 195         netdev_opens++;
 196         f->f_devdata = &netdev_sock;
 197         return (error);
 198 }
 199
 200 static int
 201 net_close(struct open_file *f)
 202 {
 203
 204 #ifdef  NETIF_DEBUG
 205         if (debug)
 206                 printf("%s: opens=%d\n", __func__, netdev_opens);
 207 #endif
 208
 209         f->f_devdata = NULL;
 210
 211         return (0);
 212 }
 213
 214 static void
 215 net_cleanup(void)
 216 {
 217
 218         if (netdev_sock >= 0) {
 219 #ifdef  NETIF_DEBUG
 220                 if (debug)
 221                         printf("%s: calling netif_close()\n", __func__);
 222 #endif
 223                 rootip.s_addr = 0;
 224                 free(netdev_name);
 225                 netif_close(netdev_sock);
 226                 netdev_sock = -1;
 227         }
 228 }
 229
 230 static int
 231 net_strategy(void *devdata, int rw, daddr_t blk, size_t size, char *buf,
 232     size_t *rsize)
 233 {
 234
 235         return (EIO);
 236 }
 237
 238 #define SUPPORT_BOOTP
 239
 240 /*
 241  * Get info for NFS boot: our IP address, our hostname,
 242  * server IP address, and our root path on the server.
 243  * There are two ways to do this:  The old, Sun way,
 244  * and the more modern, BOOTP way. (RFC951, RFC1048)
 245  *
 246  * The default is to use the Sun bootparams RPC
 247  * (because that is what the kernel will do).
 248  * MD code can make try_bootp initialied data,
 249  * which will override this common definition.
 250  */
 251 #ifdef  SUPPORT_BOOTP
 252 int try_bootp = 1;
 253 #endif
 254
 255 extern n_long ip_convertaddr(char *p);
 256
 257 static int
 258 net_getparams(int sock)
 259 {
 260         char buf[MAXHOSTNAMELEN];
 261         n_long rootaddr, smask;
 262
 263 #ifdef  SUPPORT_BOOTP
 264         /*
 265          * Try to get boot info using BOOTP.  If we succeed, then
 266          * the server IP address, gateway, and root path will all
 267          * be initialized.  If any remain uninitialized, we will
 268          * use RARP and RPC/bootparam (the Sun way) to get them.
 269          */
 270         if (try_bootp)
 271                 bootp(sock);
 272         if (myip.s_addr != 0)
 273                 goto exit;
 274 #ifdef  NETIF_DEBUG
 275         if (debug)
 276                 printf("%s: BOOTP failed, trying RARP/RPC...\n", __func__);
 277 #endif
 278 #endif
 279
 280         /*
 281          * Use RARP to get our IP address.  This also sets our
 282          * netmask to the "natural" default for our address.
 283          */
 284         if (rarp_getipaddress(sock)) {
 285                 printf("%s: RARP failed\n", __func__);
 286                 return (EIO);
 287         }
 288         printf("%s: client addr: %s\n", __func__, inet_ntoa(myip));
 289
 290         /* Get our hostname, server IP address, gateway. */
 291         if (bp_whoami(sock)) {
 292                 printf("%s: bootparam/whoami RPC failed\n", __func__);
 293                 return (EIO);
 294         }
 295 #ifdef  NETIF_DEBUG
 296         if (debug)
 297                 printf("%s: client name: %s\n", __func__, hostname);
 298 #endif
 299
 300         /*
 301          * Ignore the gateway from whoami (unreliable).
 302          * Use the "gateway" parameter instead.
 303          */
 304         smask = 0;
 305         gateip.s_addr = 0;
 306         if (bp_getfile(sock, "gateway", &gateip, buf) == 0) {
 307                 /* Got it!  Parse the netmask. */
 308                 smask = ip_convertaddr(buf);
 309         }
 310         if (smask) {
 311                 netmask = smask;
 312 #ifdef  NETIF_DEBUG
 313                 if (debug)
 314                         printf("%s: subnet mask: %s\n", __func__,
 315                             intoa(netmask));
 316 #endif
 317         }
 318 #ifdef  NETIF_DEBUG
 319         if (gateip.s_addr && debug)
 320                 printf("%s: net gateway: %s\n", __func__, inet_ntoa(gateip));
 321 #endif
 322
 323         /* Get the root server and pathname. */
 324         if (bp_getfile(sock, "root", &rootip, rootpath)) {
 325                 printf("%s: bootparam/getfile RPC failed\n", __func__);
 326                 return (EIO);
 327         }
 328 exit:
 329         if ((rootaddr = net_parse_rootpath()) != INADDR_NONE)
 330                 rootip.s_addr = rootaddr;
 331
 332 #ifdef  NETIF_DEBUG
 333         if (debug) {
 334                 printf("%s: server addr: %s\n", __func__, inet_ntoa(rootip));
 335                 printf("%s: server path: %s\n", __func__, rootpath);
 336         }
 337 #endif
 338
 339         return (0);
 340 }
 341
 342 static int
 343 net_print(int verbose)
 344 {
 345         struct netif_driver *drv;
 346         int i, d, cnt;
 347         int ret = 0;
 348
 349         if (netif_drivers[0] == NULL)
 350                 return (ret);
 351
 352         printf("%s devices:", netdev.dv_name);
 353         if ((ret = pager_output("\n")) != 0)
 354                 return (ret);
 355
 356         cnt = 0;
 357         for (d = 0; netif_drivers[d]; d++) {
 358                 drv = netif_drivers[d];
 359                 for (i = 0; i < drv->netif_nifs; i++) {
 360                         printf("\t%s%d:", netdev.dv_name, cnt++);
 361                         if (verbose) {
 362                                 printf(" (%s%d)", drv->netif_bname,
 363                                     drv->netif_ifs[i].dif_unit);
 364                         }
 365                         if ((ret = pager_output("\n")) != 0)
 366                                 return (ret);
 367                 }
 368         }
 369         return (ret);
 370 }
 371
 372 /*
 373  * Parses the rootpath if present
 374  *
 375  * The rootpath format can be in the form
 376  * <scheme>://ip/path
 377  * <scheme>:/path
 378  *
 379  * For compatibility with previous behaviour it also accepts as an NFS scheme
 380  * ip:/path
 381  * /path
 382  *
 383  * If an ip is set it returns it in network byte order.
 384  * The default scheme defined in the global netproto, if not set it defaults to
 385  * NFS.
 386  * It leaves just the pathname in the global rootpath.
 387  */
 388 uint32_t
 389 net_parse_rootpath(void)
 390 {
 391         n_long addr = htonl(INADDR_NONE);
 392         size_t i;
 393         char ip[FNAME_SIZE];
 394         char *ptr, *val;
 395
 396         netproto = NET_NONE;
 397
 398         for (i = 0; i < nitems(uri_schemes); i++) {
 399                 if (strncmp(rootpath, uri_schemes[i].scheme,
 400                     strlen(uri_schemes[i].scheme)) != 0)
 401                         continue;
 402
 403                 netproto = uri_schemes[i].proto;
 404                 break;
 405         }
 406         ptr = rootpath;
 407         /* Fallback for compatibility mode */
 408         if (netproto == NET_NONE) {
 409                 netproto = NET_NFS;
 410                 (void)strsep(&ptr, ":");
 411                 if (ptr != NULL) {
 412                         addr = inet_addr(rootpath);
 413                         bcopy(ptr, rootpath, strlen(ptr) + 1);
 414                 }
 415         } else {
 416                 ptr += strlen(uri_schemes[i].scheme);
 417                 if (*ptr == '/') {
 418                         /* we are in the form <scheme>://, we do expect an ip */
 419                         ptr++;
 420                         /*
 421                          * XXX when http will be there we will need to check for
 422                          * a port, but right now we do not need it yet
 423                          */
 424                         val = strchr(ptr, '/');
 425                         if (val != NULL) {
 426                                 snprintf(ip, sizeof(ip), "%.*s",
 427                                     (int)((uintptr_t)val - (uintptr_t)ptr),
 428                                     ptr);
 429                                 addr = inet_addr(ip);
 430                                 bcopy(val, rootpath, strlen(val) + 1);
 431                         }
 432                 } else {
 433                         ptr--;
 434                         bcopy(ptr, rootpath, strlen(ptr) + 1);
 435                 }
 436         }
 437
 438         return (addr);
 439 }