sys/boot/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 <string.h>
  62 #include <net.h>
  63 #include <netif.h>
  64 #include <bootp.h>
  65 #include <bootparam.h>
  66
  67 #include "dev_net.h"
  68 #include "bootstrap.h"
  69
  70 #ifdef  NETIF_DEBUG
  71 int debug = 0;
  72 #endif
  73
  74 static char *netdev_name;
  75 static int netdev_sock = -1;
  76 static int netdev_opens;
  77
  78 static int      net_init(void);
  79 static int      net_open(struct open_file *, ...);
  80 static int      net_close(struct open_file *);
  81 static void     net_cleanup(void);
  82 static int      net_strategy();
  83 static void     net_print(int);
  84
  85 static int net_getparams(int sock);
  86
  87 struct devsw netdev = {
  88         "net",
  89         DEVT_NET,
  90         net_init,
  91         net_strategy,
  92         net_open,
  93         net_close,
  94         noioctl,
  95         net_print,
  96         net_cleanup
  97 };
  98
  99 static int
 100 net_init(void)
 101 {
 102
 103         return (0);
 104 }
 105
 106 /*
 107  * Called by devopen after it sets f->f_dev to our devsw entry.
 108  * This opens the low-level device and sets f->f_devdata.
 109  * This is declared with variable arguments...
 110  */
 111 static int
 112 net_open(struct open_file *f, ...)
 113 {
 114         char temp[FNAME_SIZE];
 115         struct iodesc *d;
 116         va_list args;
 117         char *devname;          /* Device part of file name (or NULL). */
 118         int error = 0;
 119
 120         va_start(args, f);
 121         devname = va_arg(args, char*);
 122         va_end(args);
 123
 124 #ifdef  NETIF_OPEN_CLOSE_ONCE
 125         /* Before opening another interface, close the previous one first. */
 126         if (netdev_sock >= 0 && strcmp(devname, netdev_name) != 0)
 127                 net_cleanup();
 128 #endif
 129
 130         /* On first open, do netif open, mount, etc. */
 131         if (netdev_opens == 0) {
 132                 /* Find network interface. */
 133                 if (netdev_sock < 0) {
 134                         netdev_sock = netif_open(devname);
 135                         if (netdev_sock < 0) {
 136                                 printf("net_open: netif_open() failed\n");
 137                                 return (ENXIO);
 138                         }
 139                         netdev_name = strdup(devname);
 140 #ifdef  NETIF_DEBUG
 141                         if (debug)
 142                                 printf("net_open: netif_open() succeeded\n");
 143 #endif
 144                 }
 145                 /*
 146                  * If network params were not set by netif_open(), try to get
 147                  * them via bootp, rarp, etc.
 148                  */
 149                 if (rootip.s_addr == 0) {
 150                         /* Get root IP address, and path, etc. */
 151                         error = net_getparams(netdev_sock);
 152                         if (error) {
 153                                 /* getparams makes its own noise */
 154                                 free(netdev_name);
 155                                 netif_close(netdev_sock);
 156                                 netdev_sock = -1;
 157                                 return (error);
 158                         }
 159                 }
 160                 /*
 161                  * Set the variables required by the kernel's nfs_diskless
 162                  * mechanism.  This is the minimum set of variables required to
 163                  * mount a root filesystem without needing to obtain additional
 164                  * info from bootp or other sources.
 165                  */
 166                 d = socktodesc(netdev_sock);
 167                 sprintf(temp, "%6D", d->myea, ":");
 168                 setenv("boot.netif.hwaddr", temp, 1);
 169                 setenv("boot.netif.ip", inet_ntoa(myip), 1);
 170                 setenv("boot.netif.netmask", intoa(netmask), 1);
 171                 setenv("boot.netif.gateway", inet_ntoa(gateip), 1);
 172                 setenv("boot.nfsroot.server", inet_ntoa(rootip), 1);
 173                 setenv("boot.nfsroot.path", rootpath, 1);
 174         }
 175         netdev_opens++;
 176         f->f_devdata = &netdev_sock;
 177         return (error);
 178 }
 179
 180 static int
 181 net_close(struct open_file *f)
 182 {
 183
 184 #ifdef  NETIF_DEBUG
 185         if (debug)
 186                 printf("net_close: opens=%d\n", netdev_opens);
 187 #endif
 188
 189         f->f_devdata = NULL;
 190
 191 #ifndef NETIF_OPEN_CLOSE_ONCE
 192         /* Extra close call? */
 193         if (netdev_opens <= 0)
 194                 return (0);
 195         netdev_opens--;
 196         /* Not last close? */
 197         if (netdev_opens > 0)
 198                 return (0);
 199         /* On last close, do netif close, etc. */
 200 #ifdef  NETIF_DEBUG
 201         if (debug)
 202                 printf("net_close: calling net_cleanup()\n");
 203 #endif
 204         net_cleanup();
 205 #endif
 206         return (0);
 207 }
 208
 209 static void
 210 net_cleanup(void)
 211 {
 212
 213         if (netdev_sock >= 0) {
 214 #ifdef  NETIF_DEBUG
 215                 if (debug)
 216                         printf("net_cleanup: calling netif_close()\n");
 217 #endif
 218                 rootip.s_addr = 0;
 219                 free(netdev_name);
 220                 netif_close(netdev_sock);
 221                 netdev_sock = -1;
 222         }
 223 }
 224
 225 static int
 226 net_strategy()
 227 {
 228
 229         return (EIO);
 230 }
 231
 232 #define SUPPORT_BOOTP
 233
 234 /*
 235  * Get info for NFS boot: our IP address, our hostname,
 236  * server IP address, and our root path on the server.
 237  * There are two ways to do this:  The old, Sun way,
 238  * and the more modern, BOOTP way. (RFC951, RFC1048)
 239  *
 240  * The default is to use the Sun bootparams RPC
 241  * (because that is what the kernel will do).
 242  * MD code can make try_bootp initialied data,
 243  * which will override this common definition.
 244  */
 245 #ifdef  SUPPORT_BOOTP
 246 int try_bootp = 1;
 247 #endif
 248
 249 extern n_long ip_convertaddr(char *p);
 250
 251 static int
 252 net_getparams(int sock)
 253 {
 254         char buf[MAXHOSTNAMELEN];
 255         n_long rootaddr, smask;
 256
 257 #ifdef  SUPPORT_BOOTP
 258         /*
 259          * Try to get boot info using BOOTP.  If we succeed, then
 260          * the server IP address, gateway, and root path will all
 261          * be initialized.  If any remain uninitialized, we will
 262          * use RARP and RPC/bootparam (the Sun way) to get them.
 263          */
 264         if (try_bootp)
 265                 bootp(sock, BOOTP_NONE);
 266         if (myip.s_addr != 0)
 267                 goto exit;
 268 #ifdef  NETIF_DEBUG
 269         if (debug)
 270                 printf("net_open: BOOTP failed, trying RARP/RPC...\n");
 271 #endif
 272 #endif
 273
 274         /*
 275          * Use RARP to get our IP address.  This also sets our
 276          * netmask to the "natural" default for our address.
 277          */
 278         if (rarp_getipaddress(sock)) {
 279                 printf("net_open: RARP failed\n");
 280                 return (EIO);
 281         }
 282         printf("net_open: client addr: %s\n", inet_ntoa(myip));
 283
 284         /* Get our hostname, server IP address, gateway. */
 285         if (bp_whoami(sock)) {
 286                 printf("net_open: bootparam/whoami RPC failed\n");
 287                 return (EIO);
 288         }
 289 #ifdef  NETIF_DEBUG
 290         if (debug)
 291                 printf("net_open: client name: %s\n", hostname);
 292 #endif
 293
 294         /*
 295          * Ignore the gateway from whoami (unreliable).
 296          * Use the "gateway" parameter instead.
 297          */
 298         smask = 0;
 299         gateip.s_addr = 0;
 300         if (bp_getfile(sock, "gateway", &gateip, buf) == 0) {
 301                 /* Got it!  Parse the netmask. */
 302                 smask = ip_convertaddr(buf);
 303         }
 304         if (smask) {
 305                 netmask = smask;
 306 #ifdef  NETIF_DEBUG
 307                 if (debug)
 308                         printf("net_open: subnet mask: %s\n", intoa(netmask));
 309 #endif
 310         }
 311 #ifdef  NETIF_DEBUG
 312         if (gateip.s_addr && debug)
 313                 printf("net_open: net gateway: %s\n", inet_ntoa(gateip));
 314 #endif
 315
 316         /* Get the root server and pathname. */
 317         if (bp_getfile(sock, "root", &rootip, rootpath)) {
 318                 printf("net_open: bootparam/getfile RPC failed\n");
 319                 return (EIO);
 320         }
 321 exit:
 322         if ((rootaddr = net_parse_rootpath()) != INADDR_NONE)
 323                 rootip.s_addr = rootaddr;
 324
 325 #ifdef  NETIF_DEBUG
 326         if (debug) {
 327                 printf("net_open: server addr: %s\n", inet_ntoa(rootip));
 328                 printf("net_open: server path: %s\n", rootpath);
 329         }
 330 #endif
 331
 332         return (0);
 333 }
 334
 335 static void
 336 net_print(int verbose)
 337 {
 338         struct netif_driver *drv;
 339         int i, d, cnt;
 340
 341         cnt = 0;
 342         for (d = 0; netif_drivers[d]; d++) {
 343                 drv = netif_drivers[d];
 344                 for (i = 0; i < drv->netif_nifs; i++) {
 345                         printf("\t%s%d:", "net", cnt++);
 346                         if (verbose)
 347                                 printf(" (%s%d)", drv->netif_bname,
 348                                     drv->netif_ifs[i].dif_unit);
 349                 }
 350         }
 351         printf("\n");
 352 }
 353
 354 /*
 355  * Strip the server's address off of the rootpath if present and return it in
 356  * network byte order, leaving just the pathname part in the global rootpath.
 357  */
 358 uint32_t
 359 net_parse_rootpath()
 360 {
 361         int i;
 362         n_long addr = INADDR_NONE;
 363
 364         for (i = 0; rootpath[i] != '\0' && i < FNAME_SIZE; i++)
 365                 if (rootpath[i] == ':')
 366                         break;
 367         if (i && i != FNAME_SIZE && rootpath[i] == ':') {
 368                 rootpath[i++] = '\0';
 369                 addr = inet_addr(&rootpath[0]);
 370                 bcopy(&rootpath[i], rootpath, strlen(&rootpath[i])+1);
 371         }
 372         return (addr);
 373 }