boot/common/dev_net.c

/*  $NetBSD: dev_net.c,v 1.23 2008/04/28 20:24:06 martin Exp $  */

/*-
 * Copyright (c) 1997 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Gordon W. Ross.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");

/*-
 * This module implements a "raw device" interface suitable for
 * use by the stand-alone I/O library NFS code.  This interface
 * does not support any "block" access, and exists only for the
 * purpose of initializing the network interface, getting boot
 * parameters, and performing the NFS mount.
 *
 * At open time, this does:
 *
 * find interface      - netif_open()
 * RARP for IP address - rarp_getipaddress()
 * RPC/bootparams      - callrpc(d, RPC_BOOTPARAMS, ...)
 * RPC/mountd          - nfs_mount(sock, ip, path)
 *
 * the root file handle from mountd is saved in a global
 * for use by the NFS open code (NFS/lookup).
 */

#include <machine/stdarg.h>
#include <sys/param.h>
#include <sys/socket.h>
#include <net/if.h>
#include <netinet/in.h>
#include <netinet/in_systm.h>

#include <stand.h>
#include <string.h>
#include <net.h>
#include <netif.h>
#include <bootp.h>
#include <bootparam.h>

#include "dev_net.h"
#include "bootstrap.h"

#ifdef  NETIF_DEBUG
int debug = 0;
#endif

static char *netdev_name;
static int netdev_sock = -1;
static int netdev_opens;

static int  net_init(void);
static int  net_open(struct open_file *, ...);
static int  net_close(struct open_file *);
static void net_cleanup(void);
static int  net_strategy();
static int  net_print(int);

static int net_getparams(int sock);

struct devsw netdev = {
    "net",
    DEVT_NET,
    net_init,
    net_strategy,
    net_open,
    net_close,
    noioctl,
    net_print,
    net_cleanup
};

static int
net_init(void)
{

    return (0);
}

/*
 * Called by devopen after it sets f->f_dev to our devsw entry.
 * This opens the low-level device and sets f->f_devdata.
 * This is declared with variable arguments...
 */
static int
net_open(struct open_file *f, ...)
{
    struct iodesc *d;
    va_list args;
    char *devname;      /* Device part of file name (or NULL). */
    int error = 0;

    va_start(args, f);
    devname = va_arg(args, char*);
    va_end(args);

#ifdef  NETIF_OPEN_CLOSE_ONCE
    /* Before opening another interface, close the previous one first. */
    if (netdev_sock >= 0 && strcmp(devname, netdev_name) != 0)
        net_cleanup();
#endif

    /* On first open, do netif open, mount, etc. */
    if (netdev_opens == 0) {
        /* Find network interface. */
        if (netdev_sock < 0) {
            netdev_sock = netif_open(devname);
            if (netdev_sock < 0) {
                printf("net_open: netif_open() failed\n");
                return (ENXIO);
            }
            netdev_name = strdup(devname);
#ifdef  NETIF_DEBUG
            if (debug)
                printf("net_open: netif_open() succeeded\n");
#endif
        }
        /*
         * If network params were not set by netif_open(), try to get
         * them via bootp, rarp, etc.
         */
        if (rootip.s_addr == 0) {
            /* Get root IP address, and path, etc. */
            error = net_getparams(netdev_sock);
            if (error) {
                /* getparams makes its own noise */
                free(netdev_name);
                netif_close(netdev_sock);
                netdev_sock = -1;
                return (error);
            }
        }
        /*
         * Set the variables required by the kernel's nfs_diskless
         * mechanism.  This is the minimum set of variables required to
         * mount a root filesystem without needing to obtain additional
         * info from bootp or other sources.
         */
        d = socktodesc(netdev_sock);
        setenv("boot.netif.hwaddr", ether_sprintf(d->myea), 1);
        setenv("boot.netif.ip", inet_ntoa(myip), 1);
        setenv("boot.netif.netmask", intoa(netmask), 1);
        setenv("boot.netif.gateway", inet_ntoa(gateip), 1);
        setenv("boot.nfsroot.server", inet_ntoa(rootip), 1);
        setenv("boot.nfsroot.path", rootpath, 1);
    }
    netdev_opens++;
    f->f_devdata = &netdev_sock;
    return (error);
}

static int
net_close(struct open_file *f)
{

#ifdef  NETIF_DEBUG
    if (debug)
        printf("net_close: opens=%d\n", netdev_opens);
#endif

    f->f_devdata = NULL;

#ifndef NETIF_OPEN_CLOSE_ONCE
    /* Extra close call? */
    if (netdev_opens <= 0)
        return (0);
    netdev_opens--;
    /* Not last close? */
    if (netdev_opens > 0)
        return (0);
    /* On last close, do netif close, etc. */
#ifdef  NETIF_DEBUG
    if (debug)
        printf("net_close: calling net_cleanup()\n");
#endif
    net_cleanup();
#endif
    return (0);
}

static void
net_cleanup(void)
{

    if (netdev_sock >= 0) {
#ifdef  NETIF_DEBUG
        if (debug)
            printf("net_cleanup: calling netif_close()\n");
#endif
        rootip.s_addr = 0;
        free(netdev_name);
        netif_close(netdev_sock);
        netdev_sock = -1;
    }
}

static int
net_strategy()
{

    return (EIO);
}

#define SUPPORT_BOOTP

/*
 * Get info for NFS boot: our IP address, our hostname,
 * server IP address, and our root path on the server.
 * There are two ways to do this:  The old, Sun way,
 * and the more modern, BOOTP way. (RFC951, RFC1048)
 *
 * The default is to use the Sun bootparams RPC
 * (because that is what the kernel will do).
 * MD code can make try_bootp initialied data,
 * which will override this common definition.
 */
#ifdef  SUPPORT_BOOTP
int try_bootp = 1;
#endif

extern n_long ip_convertaddr(char *p);

static int
net_getparams(int sock)
{
    char buf[MAXHOSTNAMELEN];
    n_long rootaddr, smask;

#ifdef  SUPPORT_BOOTP
    /*
     * Try to get boot info using BOOTP.  If we succeed, then
     * the server IP address, gateway, and root path will all
     * be initialized.  If any remain uninitialized, we will
     * use RARP and RPC/bootparam (the Sun way) to get them.
     */
    if (try_bootp)
        bootp(sock, BOOTP_NONE);
    if (myip.s_addr != 0)
        goto exit;
#ifdef  NETIF_DEBUG
    if (debug)
        printf("net_open: BOOTP failed, trying RARP/RPC...\n");
#endif
#endif

    /*
     * Use RARP to get our IP address.  This also sets our
     * netmask to the "natural" default for our address.
     */
    if (rarp_getipaddress(sock)) {
        printf("net_open: RARP failed\n");
        return (EIO);
    }
    printf("net_open: client addr: %s\n", inet_ntoa(myip));

    /* Get our hostname, server IP address, gateway. */
    if (bp_whoami(sock)) {
        printf("net_open: bootparam/whoami RPC failed\n");
        return (EIO);
    }
#ifdef  NETIF_DEBUG
    if (debug)
        printf("net_open: client name: %s\n", hostname);
#endif

    /*
     * Ignore the gateway from whoami (unreliable).
     * Use the "gateway" parameter instead.
     */
    smask = 0;
    gateip.s_addr = 0;
    if (bp_getfile(sock, "gateway", &gateip, buf) == 0) {
        /* Got it!  Parse the netmask. */
        smask = ip_convertaddr(buf);
    }
    if (smask) {
        netmask = smask;
#ifdef  NETIF_DEBUG
        if (debug)
            printf("net_open: subnet mask: %s\n", intoa(netmask));
#endif
    }
#ifdef  NETIF_DEBUG
    if (gateip.s_addr && debug)
        printf("net_open: net gateway: %s\n", inet_ntoa(gateip));
#endif

    /* Get the root server and pathname. */
    if (bp_getfile(sock, "root", &rootip, rootpath)) {
        printf("net_open: bootparam/getfile RPC failed\n");
        return (EIO);
    }
exit:
    if ((rootaddr = net_parse_rootpath()) != INADDR_NONE)
        rootip.s_addr = rootaddr;

#ifdef  NETIF_DEBUG
    if (debug) {
        printf("net_open: server addr: %s\n", inet_ntoa(rootip));
        printf("net_open: server path: %s\n", rootpath);
    }
#endif

    return (0);
}

static int
net_print(int verbose)
{
    struct netif_driver *drv;
    char line[80];
    int i, d, cnt;
    int ret = 0;

    cnt = 0;
    for (d = 0; netif_drivers[d]; d++) {
        drv = netif_drivers[d];
        for (i = 0; i < drv->netif_nifs; i++) {
            snprintf(line, 80, "\t%s%d:", "net", cnt++);
            ret = pager_output(line);
            if (ret != 0)
                break;
            if (verbose) {
                snprintf(line, 80, " (%s%d)", drv->netif_bname,
                    drv->netif_ifs[i].dif_unit);
                ret = pager_output(line);
                if (ret != 0)
                    break;
            }
        }
    }
    return (ret |= pager_output("\n"));
}

/*
 * Strip the server's address off of the rootpath if present and return it in
 * network byte order, leaving just the pathname part in the global rootpath.
 */
uint32_t
net_parse_rootpath()
{
    int i;
    n_long addr = INADDR_NONE;

    for (i = 0; rootpath[i] != '\0' && i < FNAME_SIZE; i++)
        if (rootpath[i] == ':')
            break;
    if (i && i != FNAME_SIZE && rootpath[i] == ':') {
        rootpath[i++] = '\0';
        addr = inet_addr(&rootpath[0]);
        bcopy(&rootpath[i], rootpath, strlen(&rootpath[i])+1);
    }
    return (addr);
}