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         char *devname;          /* Device part of file name (or NULL). */
 126         int error = 0;
 127
 128         va_start(args, f);
 129         devname = va_arg(args, char*);
 130         va_end(args);
 131
 132         /* Before opening another interface, close the previous one first. */
 133         if (netdev_sock >= 0 && strcmp(devname, netdev_name) != 0)
 134                 net_cleanup();
 135
 136         /* On first open, do netif open, mount, etc. */
 137         if (netdev_opens == 0) {
 138                 /* Find network interface. */
 139                 if (netdev_sock < 0) {
 140                         netdev_sock = netif_open(devname);
 141                         if (netdev_sock < 0) {
 142                                 printf("net_open: netif_open() failed\n");
 143                                 return (ENXIO);
 144                         }
 145                         netdev_name = strdup(devname);
 146 #ifdef  NETIF_DEBUG
 147                         if (debug)
 148                                 printf("net_open: netif_open() succeeded\n");
 149 #endif
 150                 }
 151                 /*
 152                  * If network params were not set by netif_open(), try to get
 153                  * them via bootp, rarp, etc.
 154                  */
 155                 if (rootip.s_addr == 0) {
 156                         /* Get root IP address, and path, etc. */
 157                         error = net_getparams(netdev_sock);
 158                         if (error) {
 159                                 /* getparams makes its own noise */
 160                                 free(netdev_name);
 161                                 netif_close(netdev_sock);
 162                                 netdev_sock = -1;
 163                                 return (error);
 164                         }
 165                 }
 166                 /*
 167                  * Set the variables required by the kernel's nfs_diskless
 168                  * mechanism.  This is the minimum set of variables required to
 169                  * mount a root filesystem without needing to obtain additional
 170                  * info from bootp or other sources.
 171                  */
 172                 d = socktodesc(netdev_sock);
 173                 setenv("boot.netif.hwaddr", ether_sprintf(d->myea), 1);
 174                 setenv("boot.netif.ip", inet_ntoa(myip), 1);
 175                 setenv("boot.netif.netmask", intoa(netmask), 1);
 176                 setenv("boot.netif.gateway", inet_ntoa(gateip), 1);
 177                 setenv("boot.netif.server", inet_ntoa(rootip), 1);
 178                 if (netproto == NET_TFTP) {
 179                         setenv("boot.tftproot.server", inet_ntoa(rootip), 1);
 180                         setenv("boot.tftproot.path", rootpath, 1);
 181                 } else if (netproto == NET_NFS) {
 182                         setenv("boot.nfsroot.server", inet_ntoa(rootip), 1);
 183                         setenv("boot.nfsroot.path", rootpath, 1);
 184                 }
 185                 if (intf_mtu != 0) {
 186                         char mtu[16];
 187                         snprintf(mtu, sizeof(mtu), "%u", intf_mtu);
 188                         setenv("boot.netif.mtu", mtu, 1);
 189                 }
 190
 191         }
 192         netdev_opens++;
 193         return (error);
 194 }
 195
 196 static int
 197 net_close(struct open_file *f)
 198 {
 199
 200 #ifdef  NETIF_DEBUG
 201         if (debug)
 202                 printf("net_close: opens=%d\n", netdev_opens);
 203 #endif
 204         return (0);
 205 }
 206
 207 static void
 208 net_cleanup(void)
 209 {
 210
 211         if (netdev_sock >= 0) {
 212 #ifdef  NETIF_DEBUG
 213                 if (debug)
 214                         printf("net_cleanup: calling netif_close()\n");
 215 #endif
 216                 rootip.s_addr = 0;
 217                 free(netdev_name);
 218                 netif_close(netdev_sock);
 219                 netdev_sock = -1;
 220         }
 221 }
 222
 223 static int
 224 net_strategy(void *devdata, int rw, daddr_t blk, size_t size, char *buf,
 225     size_t *rsize)
 226 {
 227
 228         return (EIO);
 229 }
 230
 231 #define SUPPORT_BOOTP
 232
 233 /*
 234  * Get info for NFS boot: our IP address, our hostname,
 235  * server IP address, and our root path on the server.
 236  * There are two ways to do this:  The old, Sun way,
 237  * and the more modern, BOOTP way. (RFC951, RFC1048)
 238  *
 239  * The default is to use the Sun bootparams RPC
 240  * (because that is what the kernel will do).
 241  * MD code can make try_bootp initialied data,
 242  * which will override this common definition.
 243  */
 244 #ifdef  SUPPORT_BOOTP
 245 int try_bootp = 1;
 246 #endif
 247
 248 extern n_long ip_convertaddr(char *p);
 249
 250 static int
 251 net_getparams(int sock)
 252 {
 253         char buf[MAXHOSTNAMELEN];
 254         n_long rootaddr, smask;
 255
 256 #ifdef  SUPPORT_BOOTP
 257         /*
 258          * Try to get boot info using BOOTP.  If we succeed, then
 259          * the server IP address, gateway, and root path will all
 260          * be initialized.  If any remain uninitialized, we will
 261          * use RARP and RPC/bootparam (the Sun way) to get them.
 262          */
 263         if (try_bootp)
 264                 bootp(sock);
 265         if (myip.s_addr != 0)
 266                 goto exit;
 267 #ifdef  NETIF_DEBUG
 268         if (debug)
 269                 printf("net_open: BOOTP failed, trying RARP/RPC...\n");
 270 #endif
 271 #endif
 272
 273         /*
 274          * Use RARP to get our IP address.  This also sets our
 275          * netmask to the "natural" default for our address.
 276          */
 277         if (rarp_getipaddress(sock)) {
 278                 printf("net_open: RARP failed\n");
 279                 return (EIO);
 280         }
 281         printf("net_open: client addr: %s\n", inet_ntoa(myip));
 282
 283         /* Get our hostname, server IP address, gateway. */
 284         if (bp_whoami(sock)) {
 285                 printf("net_open: bootparam/whoami RPC failed\n");
 286                 return (EIO);
 287         }
 288 #ifdef  NETIF_DEBUG
 289         if (debug)
 290                 printf("net_open: client name: %s\n", hostname);
 291 #endif
 292
 293         /*
 294          * Ignore the gateway from whoami (unreliable).
 295          * Use the "gateway" parameter instead.
 296          */
 297         smask = 0;
 298         gateip.s_addr = 0;
 299         if (bp_getfile(sock, "gateway", &gateip, buf) == 0) {
 300                 /* Got it!  Parse the netmask. */
 301                 smask = ip_convertaddr(buf);
 302         }
 303         if (smask) {
 304                 netmask = smask;
 305 #ifdef  NETIF_DEBUG
 306                 if (debug)
 307                         printf("net_open: subnet mask: %s\n", intoa(netmask));
 308 #endif
 309         }
 310 #ifdef  NETIF_DEBUG
 311         if (gateip.s_addr && debug)
 312                 printf("net_open: net gateway: %s\n", inet_ntoa(gateip));
 313 #endif
 314
 315         /* Get the root server and pathname. */
 316         if (bp_getfile(sock, "root", &rootip, rootpath)) {
 317                 printf("net_open: bootparam/getfile RPC failed\n");
 318                 return (EIO);
 319         }
 320 exit:
 321         if ((rootaddr = net_parse_rootpath()) != INADDR_NONE)
 322                 rootip.s_addr = rootaddr;
 323
 324 #ifdef  NETIF_DEBUG
 325         if (debug) {
 326                 printf("net_open: server addr: %s\n", inet_ntoa(rootip));
 327                 printf("net_open: server path: %s\n", rootpath);
 328         }
 329 #endif
 330
 331         return (0);
 332 }
 333
 334 static int
 335 net_print(int verbose)
 336 {
 337         struct netif_driver *drv;
 338         int i, d, cnt;
 339         int ret = 0;
 340
 341         if (netif_drivers[0] == NULL)
 342                 return (ret);
 343
 344         printf("%s devices:", netdev.dv_name);
 345         if ((ret = pager_output("\n")) != 0)
 346                 return (ret);
 347
 348         cnt = 0;
 349         for (d = 0; netif_drivers[d]; d++) {
 350                 drv = netif_drivers[d];
 351                 for (i = 0; i < drv->netif_nifs; i++) {
 352                         printf("\t%s%d:", netdev.dv_name, cnt++);
 353                         if (verbose) {
 354                                 printf(" (%s%d)", drv->netif_bname,
 355                                     drv->netif_ifs[i].dif_unit);
 356                         }
 357                         if ((ret = pager_output("\n")) != 0)
 358                                 return (ret);
 359                 }
 360         }
 361         return (ret);
 362 }
 363
 364 /*
 365  * Parses the rootpath if present
 366  *
 367  * The rootpath format can be in the form
 368  * <scheme>://ip/path
 369  * <scheme>:/path
 370  *
 371  * For compatibility with previous behaviour it also accepts as an NFS scheme
 372  * ip:/path
 373  * /path
 374  *
 375  * If an ip is set it returns it in network byte order.
 376  * The default scheme defined in the global netproto, if not set it defaults to
 377  * NFS.
 378  * It leaves just the pathname in the global rootpath.
 379  */
 380 uint32_t
 381 net_parse_rootpath(void)
 382 {
 383         n_long addr = htonl(INADDR_NONE);
 384         size_t i;
 385         char ip[FNAME_SIZE];
 386         char *ptr, *val;
 387
 388         netproto = NET_NONE;
 389
 390         for (i = 0; i < nitems(uri_schemes); i++) {
 391                 if (strncmp(rootpath, uri_schemes[i].scheme,
 392                     strlen(uri_schemes[i].scheme)) != 0)
 393                         continue;
 394
 395                 netproto = uri_schemes[i].proto;
 396                 break;
 397         }
 398         ptr = rootpath;
 399         /* Fallback for compatibility mode */
 400         if (netproto == NET_NONE) {
 401                 netproto = NET_NFS;
 402                 (void)strsep(&ptr, ":");
 403                 if (ptr != NULL) {
 404                         addr = inet_addr(rootpath);
 405                         bcopy(ptr, rootpath, strlen(ptr) + 1);
 406                 }
 407         } else {
 408                 ptr += strlen(uri_schemes[i].scheme);
 409                 if (*ptr == '/') {
 410                         /* we are in the form <scheme>://, we do expect an ip */
 411                         ptr++;
 412                         /*
 413                          * XXX when http will be there we will need to check for
 414                          * a port, but right now we do not need it yet
 415                          */
 416                         val = strchr(ptr, '/');
 417                         if (val != NULL) {
 418                                 snprintf(ip, sizeof(ip), "%.*s",
 419                                     (int)((uintptr_t)val - (uintptr_t)ptr),
 420                                     ptr);
 421                                 addr = inet_addr(ip);
 422                                 bcopy(val, rootpath, strlen(val) + 1);
 423                         }
 424                 } else {
 425                         ptr--;
 426                         bcopy(ptr, rootpath, strlen(ptr) + 1);
 427                 }
 428         }
 429
 430         return (addr);
 431 }