root/sys/net/if_pppoe.c
/* $OpenBSD: if_pppoe.c,v 1.90 2025/11/02 08:33:43 dlg Exp $ */
/* $NetBSD: if_pppoe.c,v 1.51 2003/11/28 08:56:48 keihan Exp $ */

/*
 * Copyright (c) 2002 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Martin Husemann <martin@NetBSD.org>.
 *
 * 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 "bpfilter.h"

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/timeout.h>
#include <sys/malloc.h>
#include <sys/mbuf.h>
#include <sys/socket.h>
#include <sys/syslog.h>
#include <sys/ioctl.h>
#include <sys/smr.h>
#include <sys/percpu.h>
#include <net/if.h>
#include <net/if_var.h>
#include <net/if_types.h>
#include <net/if_sppp.h>
#include <net/if_pppoe.h>
#include <net/netisr.h>
#include <netinet/if_ether.h>

#if NBPFILTER > 0
#include <net/bpf.h>
#endif

#undef PPPOE_DEBUG      /* XXX - remove this or make it an option */

#define PPPOEDEBUG(a)   ((sc->sc_sppp.pp_if.if_flags & IFF_DEBUG) ? printf a : 0)

struct pppoehdr {
        u_int8_t vertype;
        u_int8_t code;
        u_int16_t session;
        u_int16_t plen;
} __packed;

struct pppoetag {
        u_int16_t tag;
        u_int16_t len;
} __packed;

#define PPPOE_HEADERLEN         sizeof(struct pppoehdr)
#define PPPOE_OVERHEAD          (PPPOE_HEADERLEN + 2)
#define PPPOE_VERTYPE           0x11            /* VER=1, TYPE = 1 */

#define PPPOE_TAG_EOL           0x0000          /* end of list */
#define PPPOE_TAG_SNAME         0x0101          /* service name */
#define PPPOE_TAG_ACNAME        0x0102          /* access concentrator name */
#define PPPOE_TAG_HUNIQUE       0x0103          /* host unique */
#define PPPOE_TAG_ACCOOKIE      0x0104          /* AC cookie */
#define PPPOE_TAG_VENDOR        0x0105          /* vendor specific */
#define PPPOE_TAG_RELAYSID      0x0110          /* relay session id */
#define PPPOE_TAG_MAX_PAYLOAD   0x0120          /* RFC 4638 max payload */
#define PPPOE_TAG_SNAME_ERR     0x0201          /* service name error */
#define PPPOE_TAG_ACSYS_ERR     0x0202          /* AC system error */
#define PPPOE_TAG_GENERIC_ERR   0x0203          /* generic error */

#define PPPOE_CODE_PADI         0x09            /* Active Discovery Initiation */
#define PPPOE_CODE_PADO         0x07            /* Active Discovery Offer */
#define PPPOE_CODE_PADR         0x19            /* Active Discovery Request */
#define PPPOE_CODE_PADS         0x65            /* Active Discovery Session confirmation */
#define PPPOE_CODE_PADT         0xA7            /* Active Discovery Terminate */

/* two byte PPP protocol discriminator, then IP data */
#define PPPOE_MTU       (ETHERMTU - PPPOE_OVERHEAD)
#define PPPOE_MAXMTU    PP_MAX_MRU

/* Add a 16 bit unsigned value to a buffer pointed to by PTR */
#define PPPOE_ADD_16(PTR, VAL)                  \
                *(PTR)++ = (VAL) / 256;         \
                *(PTR)++ = (VAL) % 256

/* Add a complete PPPoE header to the buffer pointed to by PTR */
#define PPPOE_ADD_HEADER(PTR, CODE, SESS, LEN)  \
                *(PTR)++ = PPPOE_VERTYPE;       \
                *(PTR)++ = (CODE);              \
                PPPOE_ADD_16(PTR, SESS);        \
                PPPOE_ADD_16(PTR, LEN)

#define PPPOE_DISC_TIMEOUT      5       /* base for quick timeout calculation (seconds) */
#define PPPOE_SLOW_RETRY        60      /* persistent retry interval (seconds) */
#define PPPOE_DISC_MAXPADI      4       /* retry PADI four times (quickly) */
#define PPPOE_DISC_MAXPADR      2       /* retry PADR twice */

/*
 * Locks used to protect struct members and global data
 *       I       immutable after creation
 *       K       kernel lock
 */

struct pppoe_softc {
        struct sppp sc_sppp;            /* contains a struct ifnet as first element */
        LIST_ENTRY(pppoe_softc) sc_list;/* [K] */
        unsigned int sc_eth_ifidx;      /* [K] */
        caddr_t sc_bpf;

        SMR_LIST_ENTRY(pppoe_softc) sc_session_entry; /* [K] */
        int sc_state;                   /* [K] discovery phase or session connected */
        struct ether_addr sc_dest;      /* [K] hardware address of concentrator */
        u_int16_t sc_session;           /* [K] PPPoE session id */

        char *sc_service_name;          /* [K] if != NULL: requested name of service */
        char *sc_concentrator_name;     /* [K] if != NULL: requested concentrator id */
        u_int8_t *sc_ac_cookie;         /* [K] content of AC cookie we must echo back */
        size_t sc_ac_cookie_len;        /* [K] length of cookie data */
        u_int8_t *sc_relay_sid;         /* [K] content of relay SID we must echo back */
        size_t sc_relay_sid_len;        /* [K] length of relay SID data */
        u_int32_t sc_unique;            /* [I] our unique id */
        struct timeout sc_timeout;      /* [K] timeout while not in session state */
        int sc_padi_retried;            /* [K] number of PADI retries already done */
        int sc_padr_retried;            /* [K] number of PADR retries already done */

        struct timeval sc_session_time; /* [K] time the session was established */
};

/* input routines */
void pppoe_disc_input(struct mbuf *);
void pppoe_data_input(struct mbuf *);
static void pppoe_dispatch_disc_pkt(struct mbuf *);

/* management routines */
void pppoeattach(int);
static int  pppoe_connect(struct pppoe_softc *);
static int  pppoe_disconnect(struct pppoe_softc *);
static void pppoe_abort_connect(struct pppoe_softc *);
static int  pppoe_ioctl(struct ifnet *, unsigned long, caddr_t);
static void pppoe_tls(struct sppp *);
static void pppoe_tlf(struct sppp *);
static int  pppoe_enqueue(struct ifnet *, struct mbuf *);
static void pppoe_start(struct ifnet *);

/* internal timeout handling */
static void pppoe_timeout(void *);

/* sending actual protocol control packets */
static int pppoe_send_padi(struct pppoe_softc *);
static int pppoe_send_padr(struct pppoe_softc *);
static int pppoe_send_padt(unsigned int, u_int, const u_int8_t *, u_int8_t);

/* raw output */
static int pppoe_output(struct pppoe_softc *, struct mbuf *);

/* internal helper functions */
static struct pppoe_softc *pppoe_find_softc_by_session(u_int, u_int);
static struct pppoe_softc *pppoe_find_softc_by_hunique(u_int8_t *, size_t, u_int);
static struct mbuf        *pppoe_get_mbuf(size_t len);

LIST_HEAD(pppoe_softc_head, pppoe_softc) pppoe_softc_list;
SMR_LIST_HEAD(pppoe_softc_sessions, pppoe_softc) pppoe_sessions; /* [K] */

/* interface cloning */
int pppoe_clone_create(struct if_clone *, int);
int pppoe_clone_destroy(struct ifnet *);

struct if_clone pppoe_cloner =
    IF_CLONE_INITIALIZER("pppoe", pppoe_clone_create, pppoe_clone_destroy);

struct mbuf_queue pppoediscinq = MBUF_QUEUE_INITIALIZER(
        IFQ_MAXLEN, IPL_SOFTNET);
struct mbuf_queue pppoeinq = MBUF_QUEUE_INITIALIZER(
        IFQ_MAXLEN, IPL_SOFTNET);

void
pppoeintr(void)
{
        struct mbuf_list ml;
        struct mbuf *m;

        NET_ASSERT_LOCKED();

        mq_delist(&pppoediscinq, &ml);
        while ((m = ml_dequeue(&ml)) != NULL)
                pppoe_disc_input(m);

        mq_delist(&pppoeinq, &ml);
        while ((m = ml_dequeue(&ml)) != NULL)
                pppoe_data_input(m);
}

void
pppoeattach(int count)
{
        LIST_INIT(&pppoe_softc_list);
        SMR_LIST_INIT(&pppoe_sessions);
        if_clone_attach(&pppoe_cloner);
}

static void
pppoe_set_state(struct pppoe_softc *sc, int state)
{
        KERNEL_ASSERT_LOCKED();
        if (sc->sc_state == PPPOE_STATE_SESSION)
                SMR_LIST_REMOVE_LOCKED(sc, sc_session_entry);
        sc->sc_state = state;
}

/* Create a new interface. */
int
pppoe_clone_create(struct if_clone *ifc, int unit)
{
        struct pppoe_softc *sc, *tmpsc;
        u_int32_t unique;

        sc = malloc(sizeof(*sc), M_DEVBUF, M_WAITOK|M_ZERO);
        snprintf(sc->sc_sppp.pp_if.if_xname,
                 sizeof(sc->sc_sppp.pp_if.if_xname),
                 "pppoe%d", unit);
        sc->sc_sppp.pp_if.if_softc = sc;
        sc->sc_sppp.pp_if.if_mtu = PPPOE_MTU;
        sc->sc_sppp.pp_if.if_flags = IFF_SIMPLEX | IFF_POINTOPOINT | IFF_MULTICAST;
        sc->sc_sppp.pp_if.if_type = IFT_PPP;
        sc->sc_sppp.pp_if.if_hdrlen = sizeof(struct ether_header) + PPPOE_HEADERLEN;
        sc->sc_sppp.pp_flags |= PP_KEEPALIVE;           /* use LCP keepalive */
        sc->sc_sppp.pp_framebytes = PPPOE_HEADERLEN;    /* framing added to ppp packets */
        sc->sc_sppp.pp_if.if_input = p2p_input;
        sc->sc_sppp.pp_if.if_bpf_mtap = p2p_bpf_mtap;
        sc->sc_sppp.pp_if.if_ioctl = pppoe_ioctl;
        sc->sc_sppp.pp_if.if_enqueue = pppoe_enqueue;
        sc->sc_sppp.pp_if.if_start = pppoe_start;
        sc->sc_sppp.pp_if.if_rtrequest = p2p_rtrequest;
        sc->sc_sppp.pp_if.if_xflags = IFXF_CLONED;
        sc->sc_sppp.pp_tls = pppoe_tls;
        sc->sc_sppp.pp_tlf = pppoe_tlf;

        /* changed to real address later */
        memcpy(&sc->sc_dest, etherbroadcastaddr, sizeof(sc->sc_dest));

        /* init timer for interface watchdog */
        timeout_set_proc(&sc->sc_timeout, pppoe_timeout, sc);

        if_counters_alloc(&sc->sc_sppp.pp_if);
        if_attach(&sc->sc_sppp.pp_if);
        if_alloc_sadl(&sc->sc_sppp.pp_if);
        sppp_attach(&sc->sc_sppp.pp_if);
#if NBPFILTER > 0
        bpfattach(&sc->sc_bpf, &sc->sc_sppp.pp_if, DLT_PPP_ETHER, 0);
        bpfattach(&sc->sc_sppp.pp_if.if_bpf, &sc->sc_sppp.pp_if,
            DLT_LOOP, sizeof(uint32_t));
#endif

        NET_LOCK();
retry:
        unique = arc4random();
        LIST_FOREACH(tmpsc, &pppoe_softc_list, sc_list)
                if (tmpsc->sc_unique == unique)
                        goto retry;
        sc->sc_unique = unique;
        LIST_INSERT_HEAD(&pppoe_softc_list, sc, sc_list);
        NET_UNLOCK();

        return (0);
}

/* Destroy a given interface. */
int
pppoe_clone_destroy(struct ifnet *ifp)
{
        struct pppoe_softc *sc = ifp->if_softc;

        NET_LOCK();
        LIST_REMOVE(sc, sc_list);
        NET_UNLOCK();

        timeout_del(&sc->sc_timeout);
        pppoe_set_state(sc, PPPOE_STATE_INITIAL);

        sppp_detach(&sc->sc_sppp.pp_if);
        if_detach(ifp);

        if (sc->sc_concentrator_name)
                free(sc->sc_concentrator_name, M_DEVBUF,
                    strlen(sc->sc_concentrator_name) + 1);
        if (sc->sc_service_name)
                free(sc->sc_service_name, M_DEVBUF,
                    strlen(sc->sc_service_name) + 1);
        if (sc->sc_ac_cookie)
                free(sc->sc_ac_cookie, M_DEVBUF, sc->sc_ac_cookie_len);
        if (sc->sc_relay_sid)
                free(sc->sc_relay_sid, M_DEVBUF, sc->sc_relay_sid_len);

        smr_barrier();

        free(sc, M_DEVBUF, sizeof(*sc));

        return (0);
}

/*
 * Find the interface handling the specified session.
 * Note: O(number of sessions open), this is a client-side only, mean
 * and lean implementation, so number of open sessions typically should
 * be 1.
 */
static struct pppoe_softc *
pppoe_find_softc_by_session(u_int session, u_int ifidx)
{
        struct pppoe_softc *sc;

        if (session == 0)
                return (NULL);

        LIST_FOREACH(sc, &pppoe_softc_list, sc_list) {
                if (sc->sc_state == PPPOE_STATE_SESSION
                    && sc->sc_session == session
                    && sc->sc_eth_ifidx == ifidx) {
                        return (sc);
                }
        }
        return (NULL);
}

static struct pppoe_softc *
pppoe_smr_find_by_session(u_int session, u_int ifidx)
{
        struct pppoe_softc *sc;

        if (session == 0)
                return (NULL);

        smr_read_enter();
        SMR_LIST_FOREACH(sc, &pppoe_sessions, sc_session_entry) {
                if (sc->sc_session == session &&
                    sc->sc_eth_ifidx == ifidx) {
                        /* XXX if_ref() */
                        refcnt_take(&sc->sc_sppp.pp_if.if_refcnt);
                        break;
                }
        }
        smr_read_leave();

        return (sc);
}

/*
 * Check host unique token passed and return appropriate softc pointer,
 * or NULL if token is bogus.
 */
static struct pppoe_softc *
pppoe_find_softc_by_hunique(u_int8_t *token, size_t len, u_int ifidx)
{
        struct pppoe_softc *sc;
        u_int32_t hunique;

        if (LIST_EMPTY(&pppoe_softc_list))
                return (NULL);

        if (len != sizeof(hunique))
                return (NULL);
        memcpy(&hunique, token, len);

        LIST_FOREACH(sc, &pppoe_softc_list, sc_list)
                if (sc->sc_unique == hunique)
                        break;

        if (sc == NULL) {
                printf("pppoe: alien host unique tag, no session found\n");
                return (NULL);
        }

        /* should be safe to access *sc now */
        if (sc->sc_state < PPPOE_STATE_PADI_SENT || sc->sc_state >= PPPOE_STATE_SESSION) {
                printf("%s: host unique tag found, but it belongs to a connection in state %d\n",
                        sc->sc_sppp.pp_if.if_xname, sc->sc_state);
                return (NULL);
        }
        if (sc->sc_eth_ifidx != ifidx) {
                printf("%s: wrong interface, not accepting host unique\n",
                        sc->sc_sppp.pp_if.if_xname);
                return (NULL);
        }
        return (sc);
}

/* Analyze and handle a single received packet while not in session state. */
static void
pppoe_dispatch_disc_pkt(struct mbuf *m)
{
        struct pppoe_softc *sc;
        struct pppoehdr *ph;
        struct pppoetag *pt;
        struct mbuf *n;
        struct ether_header *eh;
        const char *err_msg, *devname;
        size_t ac_cookie_len;
        size_t relay_sid_len;
        int off, noff, err, errortag, max_payloadtag;
        u_int16_t max_payload;
        u_int16_t tag, len;
        u_int16_t session, plen;
        u_int8_t *ac_cookie;
        u_int8_t *relay_sid;
        u_int8_t code;

        err_msg = NULL;
        devname = "pppoe";
        off = 0;
        errortag = 0;
        max_payloadtag = 0;

        if (m->m_len < sizeof(*eh)) {
                m = m_pullup(m, sizeof(*eh));
                if (m == NULL)
                        goto done;
        }
        eh = mtod(m, struct ether_header *);
        off += sizeof(*eh);

        ac_cookie = NULL;
        ac_cookie_len = 0;
        relay_sid = NULL;
        relay_sid_len = 0;
        max_payload = 0;

        session = 0;
        if (m->m_pkthdr.len - off <= PPPOE_HEADERLEN) {
                printf("pppoe: packet too short: %d\n", m->m_pkthdr.len);
                goto done;
        }

        n = m_pulldown(m, off, sizeof(*ph), &noff);
        if (n == NULL) {
                printf("pppoe: could not get PPPoE header\n");
                m = NULL;
                goto done;
        }
        ph = (struct pppoehdr *)(mtod(n, caddr_t) + noff);
        if (ph->vertype != PPPOE_VERTYPE) {
                printf("pppoe: unknown version/type packet: 0x%x\n",
                    ph->vertype);
                goto done;
        }

        session = ntohs(ph->session);
        plen = ntohs(ph->plen);
        code = ph->code;
        off += sizeof(*ph);
        if (plen + off > m->m_pkthdr.len) {
                printf("pppoe: packet content does not fit: data available = %d, packet size = %u\n",
                    m->m_pkthdr.len - off, plen);
                goto done;
        }

        /* ignore trailing garbage */
        m_adj(m, off + plen - m->m_pkthdr.len);

        tag = 0;
        len = 0;
        sc = NULL;
        while (off + sizeof(*pt) <= m->m_pkthdr.len) {
                n = m_pulldown(m, off, sizeof(*pt), &noff);
                if (n == NULL) {
                        printf("%s: parse error\n", devname);
                        m = NULL;
                        goto done;
                }
                pt = (struct pppoetag *)(mtod(n, caddr_t) + noff);
                tag = ntohs(pt->tag);
                len = ntohs(pt->len);
                off += sizeof(*pt);
                if (off + len > m->m_pkthdr.len) {
                        printf("%s: tag 0x%x len 0x%x is too long\n",
                            devname, tag, len);
                        goto done;
                }
                switch (tag) {
                case PPPOE_TAG_EOL:
                        goto breakbreak;
                case PPPOE_TAG_SNAME:
                        break;  /* ignored */
                case PPPOE_TAG_ACNAME:
                        break;  /* ignored */
                case PPPOE_TAG_HUNIQUE:
                        if (sc != NULL)
                                break;
                        n = m_pulldown(m, off, len, &noff);
                        if (n == NULL) {
                                m = NULL;
                                err_msg = "TAG HUNIQUE ERROR";
                                break;
                        }
                        sc = pppoe_find_softc_by_hunique(mtod(n, caddr_t) + noff,
                            len, m->m_pkthdr.ph_ifidx);
                        if (sc != NULL)
                                devname = sc->sc_sppp.pp_if.if_xname;
                        break;
                case PPPOE_TAG_ACCOOKIE:
                        if (ac_cookie == NULL) {
                                n = m_pulldown(m, off, len,
                                    &noff);
                                if (n == NULL) {
                                        err_msg = "TAG ACCOOKIE ERROR";
                                        m = NULL;
                                        break;
                                }
                                ac_cookie = mtod(n, caddr_t) + noff;
                                ac_cookie_len = len;
                        }
                        break;
                case PPPOE_TAG_RELAYSID:
                        if (relay_sid == NULL) {
                                n = m_pulldown(m, off, len,
                                    &noff);
                                if (n == NULL) {
                                        err_msg = "TAG RELAYSID ERROR";
                                        m = NULL;
                                        break;
                                }
                                relay_sid = mtod(n, caddr_t) + noff;
                                relay_sid_len = len;
                        }
                        break;
                case PPPOE_TAG_MAX_PAYLOAD:
                        if (!max_payloadtag) {
                                n = m_pulldown(m, off, len,
                                    &noff);
                                if (n == NULL || len != sizeof(max_payload)) {
                                        err_msg = "TAG MAX_PAYLOAD ERROR";
                                        m = NULL;
                                        break;
                                }
                                memcpy(&max_payload, mtod(n, caddr_t) + noff,
                                    sizeof(max_payload));
                                max_payloadtag = 1;
                        }
                        break;
                case PPPOE_TAG_SNAME_ERR:
                        err_msg = "SERVICE NAME ERROR";
                        errortag = 1;
                        break;
                case PPPOE_TAG_ACSYS_ERR:
                        err_msg = "AC SYSTEM ERROR";
                        errortag = 1;
                        break;
                case PPPOE_TAG_GENERIC_ERR:
                        err_msg = "GENERIC ERROR";
                        errortag = 1;
                        break;
                }
                if (err_msg) {
                        log(LOG_INFO, "%s: %s: ", devname, err_msg);
                        if (errortag && len) {
                                n = m_pulldown(m, off, len,
                                    &noff);
                                if (n == NULL) {
                                        m = NULL;
                                } else {
                                        u_int8_t *et = mtod(n, caddr_t) + noff;
                                        while (len--)
                                                addlog("%c", *et++);
                                }
                        }
                        addlog("\n");
                        goto done;
                }
                off += len;
        }
breakbreak:
        switch (code) {
        case PPPOE_CODE_PADI:
        case PPPOE_CODE_PADR:
                /* ignore, we are no access concentrator */
                goto done;
        case PPPOE_CODE_PADO:
                if (sc == NULL) {
                        /* be quiet if there is not a single pppoe instance */
                        if (!LIST_EMPTY(&pppoe_softc_list))
                                printf("pppoe: received PADO but could not find request for it\n");
                        goto done;
                }
                if (sc->sc_state != PPPOE_STATE_PADI_SENT) {
                        printf("%s: received unexpected PADO\n",
                            sc->sc_sppp.pp_if.if_xname);
                        goto done;
                }
                if (ac_cookie) {
                        if (sc->sc_ac_cookie)
                                free(sc->sc_ac_cookie, M_DEVBUF,
                                    sc->sc_ac_cookie_len);
                        sc->sc_ac_cookie = malloc(ac_cookie_len, M_DEVBUF,
                            M_DONTWAIT);
                        if (sc->sc_ac_cookie == NULL) {
                                sc->sc_ac_cookie_len = 0;
                                goto done;
                        }
                        sc->sc_ac_cookie_len = ac_cookie_len;
                        memcpy(sc->sc_ac_cookie, ac_cookie, ac_cookie_len);
                } else if (sc->sc_ac_cookie) {
                        free(sc->sc_ac_cookie, M_DEVBUF, sc->sc_ac_cookie_len);
                        sc->sc_ac_cookie = NULL;
                        sc->sc_ac_cookie_len = 0;
                }
                if (relay_sid) {
                        if (sc->sc_relay_sid)
                                free(sc->sc_relay_sid, M_DEVBUF,
                                    sc->sc_relay_sid_len);
                        sc->sc_relay_sid = malloc(relay_sid_len, M_DEVBUF,
                            M_DONTWAIT);
                        if (sc->sc_relay_sid == NULL) {
                                sc->sc_relay_sid_len = 0;
                                goto done;
                        }
                        sc->sc_relay_sid_len = relay_sid_len;
                        memcpy(sc->sc_relay_sid, relay_sid, relay_sid_len);
                } else if (sc->sc_relay_sid) {
                        free(sc->sc_relay_sid, M_DEVBUF, sc->sc_relay_sid_len);
                        sc->sc_relay_sid = NULL;
                        sc->sc_relay_sid_len = 0;
                }
                if (sc->sc_sppp.pp_if.if_mtu > PPPOE_MTU &&
                    (!max_payloadtag ||
                     ntohs(max_payload) != sc->sc_sppp.pp_if.if_mtu)) {
                        printf("%s: No valid PPP-Max-Payload tag received in PADO\n",
                            sc->sc_sppp.pp_if.if_xname);
                        sc->sc_sppp.pp_if.if_mtu = PPPOE_MTU;
                }

                memcpy(&sc->sc_dest, eh->ether_shost, sizeof(sc->sc_dest));
                sc->sc_padr_retried = 0;
                pppoe_set_state(sc, PPPOE_STATE_PADR_SENT);
                if ((err = pppoe_send_padr(sc)) != 0) {
                        PPPOEDEBUG(("%s: failed to send PADR, error=%d\n",
                            sc->sc_sppp.pp_if.if_xname, err));
                }
                timeout_add_sec(&sc->sc_timeout,
                    PPPOE_DISC_TIMEOUT * (1 + sc->sc_padr_retried));

                break;
        case PPPOE_CODE_PADS:
                if (sc == NULL)
                        goto done;

                KERNEL_ASSERT_LOCKED();

                sc->sc_session = session;
                timeout_del(&sc->sc_timeout);
                PPPOEDEBUG(("%s: session 0x%x connected\n",
                    sc->sc_sppp.pp_if.if_xname, session));
                sc->sc_state = PPPOE_STATE_SESSION;
                getmicrouptime(&sc->sc_session_time);
                SMR_LIST_INSERT_HEAD_LOCKED(&pppoe_sessions, sc,
                    sc_session_entry);
                sc->sc_sppp.pp_up(&sc->sc_sppp);        /* notify upper layers */

                break;
        case PPPOE_CODE_PADT:
                if (sc == NULL)
                        goto done;

                /* stop timer (we might be about to transmit a PADT ourself) */
                timeout_del(&sc->sc_timeout);
                PPPOEDEBUG(("%s: session 0x%x terminated, received PADT\n",
                    sc->sc_sppp.pp_if.if_xname, session));

                /* clean up softc */
                pppoe_set_state(sc, PPPOE_STATE_PADR_SENT);
                memcpy(&sc->sc_dest, etherbroadcastaddr, sizeof(sc->sc_dest));
                if (sc->sc_ac_cookie) {
                        free(sc->sc_ac_cookie, M_DEVBUF,
                            sc->sc_ac_cookie_len);
                        sc->sc_ac_cookie = NULL;
                }
                if (sc->sc_relay_sid) {
                        free(sc->sc_relay_sid, M_DEVBUF, sc->sc_relay_sid_len);
                        sc->sc_relay_sid = NULL;
                }
                sc->sc_ac_cookie_len = 0;
                sc->sc_relay_sid_len = 0;
                sc->sc_session = 0;
                sc->sc_session_time.tv_sec = 0;
                sc->sc_session_time.tv_usec = 0;
                sc->sc_sppp.pp_down(&sc->sc_sppp);      /* signal upper layer */

                break;
        default:
                printf("%s: unknown code (0x%04x) session = 0x%04x\n",
                    sc ? sc->sc_sppp.pp_if.if_xname : "pppoe",
                    code, session);
                break;
        }

done:
        m_freem(m);
}

/* Input function for discovery packets. */
void
pppoe_disc_input(struct mbuf *m)
{
        /* avoid error messages if there is not a single pppoe instance */
        if (!LIST_EMPTY(&pppoe_softc_list)) {
                KASSERT(m->m_flags & M_PKTHDR);
                pppoe_dispatch_disc_pkt(m);
        } else
                m_freem(m);
}

struct mbuf *
pppoe_vinput(struct ifnet *ifp0, struct mbuf *m, struct netstack *ns)
{
        struct pppoe_softc *sc;
        struct ifnet *ifp;
        struct ether_header *eh;
        struct pppoehdr *ph;
        uint16_t proto;
        int hlen = sizeof(*eh) + sizeof(*ph);
        int phlen;
        int plen;
        int af = AF_UNSPEC;
#if NBPFILTER > 0
        caddr_t if_bpf;
#endif
        time_t now;

        smr_read_enter();
        sc = SMR_LIST_FIRST(&pppoe_sessions);
        smr_read_leave();
        if (sc == NULL)
                return (m);

        if (m->m_pkthdr.len < hlen)
                return (m);
        if (m->m_len < hlen) {
                m = m_pullup(m, hlen);
                if (m == NULL)
                        return (NULL);
        }

        eh = mtod(m, struct ether_header *);
        ph = (struct pppoehdr *)(eh + 1);
        if (ph->vertype != PPPOE_VERTYPE)
                return (m);
        if (ph->code != 0)
                return (m);

        sc = pppoe_smr_find_by_session(ntohs(ph->session), ifp0->if_index);
        if (sc == NULL) {
                /* no session, don't waste any more time */
                m_freem(m);
                return (NULL);
        }

        ifp = &sc->sc_sppp.pp_if;

        plen = ntohs(ph->plen);
        if (plen < sizeof(proto))
                goto drop;

        phlen = hlen + sizeof(proto);
        if (m->m_pkthdr.len < phlen)
                goto drop;
        if (m->m_len < phlen) {
                m = m_pullup(m, phlen);
                if (m == NULL)
                        goto put;
        }

        proto = *(uint16_t *)(mtod(m, caddr_t) + hlen);
        af = sppp_proto_up(ifp, proto);
        if (af == AF_UNSPEC)
                goto put;

#if NBPFILTER > 0
        if_bpf = sc->sc_bpf;
        if (if_bpf) {
                m_adj(m, sizeof(*eh));
                bpf_mtap(sc->sc_bpf, m, BPF_DIRECTION_IN);
                m_adj(m, phlen - sizeof(*eh));
        } else
#endif
                m_adj(m, phlen);

        plen -= sizeof(proto);
        if (m->m_pkthdr.len < plen) {
                counters_inc(ifp->if_counters, ifc_ierrors);
                goto drop;
        }

        if (m->m_pkthdr.len > plen)
                m_adj(m, plen - m->m_pkthdr.len);

        /* XXX not 64bit or MP safe */
        now = getuptime();
        if (sc->sc_sppp.pp_last_activity < now)
                sc->sc_sppp.pp_last_activity = now;

        m->m_pkthdr.ph_family = af;
        if_vinput(ifp, m, ns);
done:
        m = NULL;
put:
        if_put(ifp);

        return (m);
drop:
        m_freem(m);
        goto done;
}

/* Input function for data packets */
void
pppoe_data_input(struct mbuf *m)
{
        struct pppoe_softc *sc;
        struct pppoehdr *ph;
        u_int16_t session, plen;
#ifdef PPPOE_TERM_UNKNOWN_SESSIONS
        u_int8_t shost[ETHER_ADDR_LEN];
#endif
        if (LIST_EMPTY(&pppoe_softc_list))
                goto drop;

        KASSERT(m->m_flags & M_PKTHDR);

#ifdef PPPOE_TERM_UNKNOWN_SESSIONS
        memcpy(shost, mtod(m, struct ether_header*)->ether_shost, ETHER_ADDR_LEN);
#endif
        m_adj(m, sizeof(struct ether_header));
        if (m->m_pkthdr.len <= PPPOE_HEADERLEN) {
                printf("pppoe (data): dropping too short packet: %d bytes\n",
                    m->m_pkthdr.len);
                goto drop;
        }
        if (m->m_len < sizeof(*ph)) {
                m = m_pullup(m, sizeof(*ph));
                if (m == NULL) {
                        printf("pppoe (data): could not get PPPoE header\n");
                        return;
                }
        }
        ph = mtod(m, struct pppoehdr *);
        if (ph->vertype != PPPOE_VERTYPE) {
                printf("pppoe (data): unknown version/type packet: 0x%x\n",
                    ph->vertype);
                goto drop;
        }
        if (ph->code != 0)
                goto drop;

        session = ntohs(ph->session);
        sc = pppoe_find_softc_by_session(session, m->m_pkthdr.ph_ifidx);
        if (sc == NULL) {
#ifdef PPPOE_TERM_UNKNOWN_SESSIONS
                printf("pppoe (data): input for unknown session 0x%x, sending PADT\n",
                    session);
                pppoe_send_padt(m->m_pkthdr.ph_ifidx, session, shost, 0);
#endif
                goto drop;
        }

        plen = ntohs(ph->plen);

#if NBPFILTER > 0
        if (sc->sc_bpf)
                bpf_mtap(sc->sc_bpf, m, BPF_DIRECTION_IN);
#endif

        m_adj(m, PPPOE_HEADERLEN);

#ifdef PPPOE_DEBUG
        {
                struct mbuf *p;

                printf("%s: pkthdr.len=%d, pppoe.len=%d",
                        sc->sc_sppp.pp_if.if_xname,
                        m->m_pkthdr.len, plen);
                p = m;
                while (p) {
                        printf(" l=%d", p->m_len);
                        p = p->m_next;
                }
                printf("\n");
        }
#endif

        if (m->m_pkthdr.len < plen)
                goto drop;

        /* fix incoming interface pointer (not the raw ethernet interface anymore) */
        m->m_pkthdr.ph_ifidx = sc->sc_sppp.pp_if.if_index;

        /* pass packet up and account for it */
        sc->sc_sppp.pp_if.if_ipackets++;
        sppp_input(&sc->sc_sppp.pp_if, m);
        return;

drop:
        m_freem(m);
}

static int
pppoe_output(struct pppoe_softc *sc, struct mbuf *m)
{
        struct sockaddr dst;
        struct ether_header *eh;
        struct ifnet *eth_if;
        u_int16_t etype;
        int ret;

        if ((eth_if = if_get(sc->sc_eth_ifidx)) == NULL) {
                m_freem(m);
                return (EIO);
        }

        if ((eth_if->if_flags & (IFF_UP|IFF_RUNNING))
            != (IFF_UP|IFF_RUNNING)) {
                if_put(eth_if);
                m_freem(m);
                return (ENETDOWN);
        }

        memset(&dst, 0, sizeof dst);
        dst.sa_family = AF_UNSPEC;
        eh = (struct ether_header*)&dst.sa_data;
        etype = sc->sc_state == PPPOE_STATE_SESSION ? ETHERTYPE_PPPOE : ETHERTYPE_PPPOEDISC;
        eh->ether_type = htons(etype);
        memcpy(&eh->ether_dhost, &sc->sc_dest, sizeof sc->sc_dest);

        PPPOEDEBUG(("%s (%x) state=%d, session=0x%x output -> %s, len=%d\n",
            sc->sc_sppp.pp_if.if_xname, etype,
            sc->sc_state, sc->sc_session,
            ether_sprintf((unsigned char *)&sc->sc_dest), m->m_pkthdr.len));

        m->m_flags &= ~(M_BCAST|M_MCAST);
        /* encapsulated packet is forced into rdomain of physical interface */
        m->m_pkthdr.ph_rtableid = eth_if->if_rdomain;

        ret = eth_if->if_output(eth_if, m, &dst, NULL);
        if_put(eth_if);

        return (ret);
}

/* The ioctl routine. */
static int
pppoe_ioctl(struct ifnet *ifp, unsigned long cmd, caddr_t data)
{
        struct proc *p = curproc;       /* XXX */
        struct pppoe_softc *sc = (struct pppoe_softc *)ifp;
        struct ifnet *eth_if;
        int error = 0;

        switch (cmd) {
        case PPPOESETPARMS:
        {
                struct pppoediscparms *parms = (struct pppoediscparms *)data;
                int len;

                if ((error = suser(p)) != 0)
                        return (error);
                if (parms->eth_ifname[0] != '\0') {
                        struct ifnet    *eth_if;

                        eth_if = if_unit(parms->eth_ifname);
                        if (eth_if == NULL || eth_if->if_type != IFT_ETHER) {
                                if_put(eth_if);
                                sc->sc_eth_ifidx = 0;
                                return (ENXIO);
                        }

                        if (sc->sc_sppp.pp_if.if_mtu >
                            eth_if->if_mtu - PPPOE_OVERHEAD) {
                                sc->sc_sppp.pp_if.if_mtu = eth_if->if_mtu -
                                    PPPOE_OVERHEAD;
                        }
                        sc->sc_eth_ifidx = eth_if->if_index;
                        if_put(eth_if);
                }

                if (sc->sc_concentrator_name)
                        free(sc->sc_concentrator_name, M_DEVBUF,
                            strlen(sc->sc_concentrator_name) + 1);
                sc->sc_concentrator_name = NULL;

                len = strlen(parms->ac_name);
                if (len > 0 && len < sizeof(parms->ac_name)) {
                        char *p = malloc(len + 1, M_DEVBUF, M_WAITOK|M_CANFAIL);
                        if (p == NULL)
                                return (ENOMEM);
                        strlcpy(p, parms->ac_name, len + 1);
                        sc->sc_concentrator_name = p;
                }

                if (sc->sc_service_name)
                        free(sc->sc_service_name, M_DEVBUF,
                            strlen(sc->sc_service_name) + 1);
                sc->sc_service_name = NULL;

                len = strlen(parms->service_name);
                if (len > 0 && len < sizeof(parms->service_name)) {
                        char *p = malloc(len + 1, M_DEVBUF, M_WAITOK|M_CANFAIL);
                        if (p == NULL)
                                return (ENOMEM);
                        strlcpy(p, parms->service_name, len + 1);
                        sc->sc_service_name = p;
                }
                return (0);
        }
        break;
        case PPPOEGETPARMS:
        {
                struct pppoediscparms *parms = (struct pppoediscparms *)data;

                if ((eth_if = if_get(sc->sc_eth_ifidx)) != NULL) {
                        strlcpy(parms->eth_ifname, eth_if->if_xname,
                            IFNAMSIZ);
                        if_put(eth_if);
                } else
                        parms->eth_ifname[0] = '\0';

                if (sc->sc_concentrator_name)
                        strlcpy(parms->ac_name, sc->sc_concentrator_name,
                            sizeof(parms->ac_name));
                else
                        parms->ac_name[0] = '\0';

                if (sc->sc_service_name)
                        strlcpy(parms->service_name, sc->sc_service_name,
                            sizeof(parms->service_name));
                else
                        parms->service_name[0] = '\0';

                return (0);
        }
        break;
        case PPPOEGETSESSION:
        {
                struct pppoeconnectionstate *state =
                    (struct pppoeconnectionstate *)data;
                state->state = sc->sc_state;
                state->session_id = sc->sc_session;
                state->padi_retry_no = sc->sc_padi_retried;
                state->padr_retry_no = sc->sc_padr_retried;
                state->session_time.tv_sec = sc->sc_session_time.tv_sec;
                state->session_time.tv_usec = sc->sc_session_time.tv_usec;
                return (0);
        }
        break;
        case SIOCSIFFLAGS:
        {
                struct ifreq *ifr = (struct ifreq *)data;
                /*
                 * Prevent running re-establishment timers overriding
                 * administrators choice.
                 */
                if ((ifr->ifr_flags & IFF_UP) == 0
                     && sc->sc_state >= PPPOE_STATE_PADI_SENT
                     && sc->sc_state < PPPOE_STATE_SESSION) {
                        timeout_del(&sc->sc_timeout);
                        pppoe_set_state(sc, PPPOE_STATE_INITIAL);
                        sc->sc_padi_retried = 0;
                        sc->sc_padr_retried = 0;
                        memcpy(&sc->sc_dest, etherbroadcastaddr,
                            sizeof(sc->sc_dest));
                }
                return (sppp_ioctl(ifp, cmd, data));
        }
        case SIOCSIFMTU:
        {
                struct ifreq *ifr = (struct ifreq *)data;

                eth_if = if_get(sc->sc_eth_ifidx);

                if (ifr->ifr_mtu > MIN(PPPOE_MAXMTU,
                    (eth_if == NULL ? PPPOE_MAXMTU :
                    (eth_if->if_mtu - PPPOE_OVERHEAD))))
                        error = EINVAL;
                else
                        error = 0;

                if_put(eth_if);

                if (error != 0)
                        return (error);

                return (sppp_ioctl(ifp, cmd, data));
        }
        default:
                error = sppp_ioctl(ifp, cmd, data);
                if (error == ENETRESET) {
                        error = 0;
                        if ((ifp->if_flags & (IFF_UP | IFF_RUNNING)) ==
                            (IFF_UP | IFF_RUNNING)) {
                                if_down(ifp);
                                if (sc->sc_state >= PPPOE_STATE_PADI_SENT &&
                                    sc->sc_state < PPPOE_STATE_SESSION) {
                                        timeout_del(&sc->sc_timeout);
                                        pppoe_set_state(sc,
                                            PPPOE_STATE_INITIAL);
                                        sc->sc_padi_retried = 0;
                                        sc->sc_padr_retried = 0;
                                        memcpy(&sc->sc_dest,
                                            etherbroadcastaddr,
                                            sizeof(sc->sc_dest));
                                }
                                error = sppp_ioctl(ifp, SIOCSIFFLAGS, NULL);
                                if (error)
                                        return (error);
                                if_up(ifp);
                                return (sppp_ioctl(ifp, SIOCSIFFLAGS, NULL));
                        }
                }
                return (error);
        }
        return (0);
}

/*
 * Allocate a mbuf/cluster with space to store the given data length
 * of payload, leaving space for prepending an ethernet header
 * in front.
 */
static struct mbuf *
pppoe_get_mbuf(size_t len)
{
        struct mbuf *m;

        if (len + sizeof(struct ether_header) > MCLBYTES)
                return NULL;

        MGETHDR(m, M_DONTWAIT, MT_DATA);
        if (m == NULL)
                return (NULL);
        if (len + sizeof(struct ether_header) > MHLEN) {
                MCLGET(m, M_DONTWAIT);
                if ((m->m_flags & M_EXT) == 0) {
                        m_free(m);
                        return (NULL);
                }
        }
        m->m_data += sizeof(struct ether_header);
        m->m_len = len;
        m->m_pkthdr.len = len;
        m->m_pkthdr.ph_ifidx = 0;

        return (m);
}

/* Send PADI. */
static int
pppoe_send_padi(struct pppoe_softc *sc)
{
        struct mbuf *m0;
        int len, l1 = 0, l2 = 0; /* XXX: gcc */
        u_int8_t *p;

        if (sc->sc_state > PPPOE_STATE_PADI_SENT)
                panic("pppoe_send_padi in state %d", sc->sc_state);

        /* calculate length of frame (excluding ethernet header + pppoe header) */
        len = 2 + 2 + 2 + 2 + sizeof(sc->sc_unique); /* service name tag is required, host unique is sent too */
        if (sc->sc_service_name != NULL) {
                l1 = strlen(sc->sc_service_name);
                len += l1;
        }
        if (sc->sc_concentrator_name != NULL) {
                l2 = strlen(sc->sc_concentrator_name);
                len += 2 + 2 + l2;
        }
        if (sc->sc_sppp.pp_if.if_mtu > PPPOE_MTU)
                len += 2 + 2 + 2;

        /* allocate a buffer */
        m0 = pppoe_get_mbuf(len + PPPOE_HEADERLEN);     /* header len + payload len */
        if (m0 == NULL)
                return (ENOBUFS);
        m0->m_pkthdr.pf.prio = sc->sc_sppp.pp_if.if_llprio;

        /* fill in pkt */
        p = mtod(m0, u_int8_t *);
        PPPOE_ADD_HEADER(p, PPPOE_CODE_PADI, 0, len);
        PPPOE_ADD_16(p, PPPOE_TAG_SNAME);
        if (sc->sc_service_name != NULL) {
                PPPOE_ADD_16(p, l1);
                memcpy(p, sc->sc_service_name, l1);
                p += l1;
        } else {
                PPPOE_ADD_16(p, 0);
        }
        if (sc->sc_concentrator_name != NULL) {
                PPPOE_ADD_16(p, PPPOE_TAG_ACNAME);
                PPPOE_ADD_16(p, l2);
                memcpy(p, sc->sc_concentrator_name, l2);
                p += l2;
        }
        PPPOE_ADD_16(p, PPPOE_TAG_HUNIQUE);
        PPPOE_ADD_16(p, sizeof(sc->sc_unique));
        memcpy(p, &sc->sc_unique, sizeof(sc->sc_unique));
        p += sizeof(sc->sc_unique);

        if (sc->sc_sppp.pp_if.if_mtu > PPPOE_MTU) {
                PPPOE_ADD_16(p, PPPOE_TAG_MAX_PAYLOAD);
                PPPOE_ADD_16(p, 2);
                PPPOE_ADD_16(p, (u_int16_t)sc->sc_sppp.pp_if.if_mtu);
        }

#ifdef PPPOE_DEBUG
        if (p - mtod(m0, u_int8_t *) != len + PPPOE_HEADERLEN)
                panic("pppoe_send_padi: garbled output len, should be %ld, is %ld",
                    (long)(len + PPPOE_HEADERLEN), (long)(p - mtod(m0, u_int8_t *)));
#endif

        /* send pkt */
        return (pppoe_output(sc, m0));
}

/* Watchdog function. */
static void
pppoe_timeout(void *arg)
{
        struct pppoe_softc *sc = (struct pppoe_softc *)arg;
        int x, retry_wait, err;

        PPPOEDEBUG(("%s: timeout\n", sc->sc_sppp.pp_if.if_xname));

        NET_LOCK();

        switch (sc->sc_state) {
        case PPPOE_STATE_PADI_SENT:
                /*
                 * We have two basic ways of retrying:
                 *  - Quick retry mode: try a few times in short sequence
                 *  - Slow retry mode: we already had a connection successfully
                 *    established and will try infinitely (without user
                 *    intervention)
                 * We only enter slow retry mode if IFF_LINK1 (aka autodial)
                 * is not set.
                 */

                /* initialize for quick retry mode */
                retry_wait = PPPOE_DISC_TIMEOUT * (1 + sc->sc_padi_retried);

                x = splnet();
                sc->sc_padi_retried++;
                if (sc->sc_padi_retried >= PPPOE_DISC_MAXPADI) {
                        if ((sc->sc_sppp.pp_if.if_flags & IFF_LINK1) == 0) {
                                /* slow retry mode */
                                retry_wait = PPPOE_SLOW_RETRY;
                        } else {
                                pppoe_abort_connect(sc);
                                splx(x);
                                break;
                        }
                }
                if ((err = pppoe_send_padi(sc)) != 0) {
                        sc->sc_padi_retried--;
                        PPPOEDEBUG(("%s: failed to transmit PADI, error=%d\n",
                            sc->sc_sppp.pp_if.if_xname, err));
                }
                timeout_add_sec(&sc->sc_timeout, retry_wait);
                splx(x);

                break;
        case PPPOE_STATE_PADR_SENT:
                x = splnet();
                sc->sc_padr_retried++;
                if (sc->sc_padr_retried >= PPPOE_DISC_MAXPADR) {
                        memcpy(&sc->sc_dest, etherbroadcastaddr,
                            sizeof(sc->sc_dest));
                        pppoe_set_state(sc, PPPOE_STATE_PADI_SENT);
                        sc->sc_padr_retried = 0;
                        if ((err = pppoe_send_padi(sc)) != 0) {
                                PPPOEDEBUG(("%s: failed to send PADI, error=%d\n",
                                    sc->sc_sppp.pp_if.if_xname, err));
                        }
                        timeout_add_sec(&sc->sc_timeout,
                            PPPOE_DISC_TIMEOUT * (1 + sc->sc_padi_retried));
                        splx(x);
                        break;
                }
                if ((err = pppoe_send_padr(sc)) != 0) {
                        sc->sc_padr_retried--;
                        PPPOEDEBUG(("%s: failed to send PADR, error=%d\n",
                            sc->sc_sppp.pp_if.if_xname, err));
                }
                timeout_add_sec(&sc->sc_timeout,
                    PPPOE_DISC_TIMEOUT * (1 + sc->sc_padr_retried));
                splx(x);

                break;
        case PPPOE_STATE_CLOSING:
                pppoe_disconnect(sc);
                break;
        default:
                break;  /* all done, work in peace */
        }

        NET_UNLOCK();
}

/* Start a connection (i.e. initiate discovery phase). */
static int
pppoe_connect(struct pppoe_softc *sc)
{
        int x, err;

        if (sc->sc_state != PPPOE_STATE_INITIAL)
                return (EBUSY);

        x = splnet();

        /* save state, in case we fail to send PADI */
        pppoe_set_state(sc, PPPOE_STATE_PADI_SENT);
        sc->sc_padr_retried = 0;
        err = pppoe_send_padi(sc);
        if (err != 0)
                PPPOEDEBUG(("%s: failed to send PADI, error=%d\n",
                    sc->sc_sppp.pp_if.if_xname, err));

        timeout_add_sec(&sc->sc_timeout, PPPOE_DISC_TIMEOUT);
        splx(x);

        return (err);
}

/* disconnect */
static int
pppoe_disconnect(struct pppoe_softc *sc)
{
        int err, x;

        x = splnet();

        if (sc->sc_state < PPPOE_STATE_SESSION)
                err = EBUSY;
        else {
                PPPOEDEBUG(("%s: disconnecting\n",
                    sc->sc_sppp.pp_if.if_xname));
                err = pppoe_send_padt(sc->sc_eth_ifidx,
                    sc->sc_session, (const u_int8_t *)&sc->sc_dest,
                    sc->sc_sppp.pp_if.if_llprio);
        }

        /* cleanup softc */
        pppoe_set_state(sc, PPPOE_STATE_INITIAL);
        memcpy(&sc->sc_dest, etherbroadcastaddr, sizeof(sc->sc_dest));
        if (sc->sc_ac_cookie) {
                free(sc->sc_ac_cookie, M_DEVBUF, sc->sc_ac_cookie_len);
                sc->sc_ac_cookie = NULL;
        }
        sc->sc_ac_cookie_len = 0;
        if (sc->sc_relay_sid) {
                free(sc->sc_relay_sid, M_DEVBUF, sc->sc_relay_sid_len);
                sc->sc_relay_sid = NULL;
        }
        sc->sc_relay_sid_len = 0;
        sc->sc_session = 0;

        /* notify upper layer */
        sc->sc_sppp.pp_down(&sc->sc_sppp);

        splx(x);

        return (err);
}

/* Connection attempt aborted. */
static void
pppoe_abort_connect(struct pppoe_softc *sc)
{
        printf("%s: could not establish connection\n",
                sc->sc_sppp.pp_if.if_xname);
        pppoe_set_state(sc, PPPOE_STATE_CLOSING);

        /* notify upper layer */
        sc->sc_sppp.pp_down(&sc->sc_sppp);

        /* clear connection state */
        memcpy(&sc->sc_dest, etherbroadcastaddr, sizeof(sc->sc_dest));
        pppoe_set_state(sc, PPPOE_STATE_INITIAL);
}

/* Send a PADR packet */
static int
pppoe_send_padr(struct pppoe_softc *sc)
{
        struct mbuf *m0;
        u_int8_t *p;
        size_t len, l1 = 0; /* XXX: gcc */

        if (sc->sc_state != PPPOE_STATE_PADR_SENT)
                return (EIO);

        len = 2 + 2 + 2 + 2 + sizeof(sc->sc_unique);    /* service name, host unique */
        if (sc->sc_service_name != NULL) {              /* service name tag maybe empty */
                l1 = strlen(sc->sc_service_name);
                len += l1;
        }
        if (sc->sc_ac_cookie_len > 0)
                len += 2 + 2 + sc->sc_ac_cookie_len;    /* AC cookie */
        if (sc->sc_relay_sid_len > 0)
                len += 2 + 2 + sc->sc_relay_sid_len;    /* Relay SID */
        if (sc->sc_sppp.pp_if.if_mtu > PPPOE_MTU)
                len += 2 + 2 + 2;

        m0 = pppoe_get_mbuf(len + PPPOE_HEADERLEN);
        if (m0 == NULL)
                return (ENOBUFS);
        m0->m_pkthdr.pf.prio = sc->sc_sppp.pp_if.if_llprio;

        p = mtod(m0, u_int8_t *);
        PPPOE_ADD_HEADER(p, PPPOE_CODE_PADR, 0, len);
        PPPOE_ADD_16(p, PPPOE_TAG_SNAME);

        if (sc->sc_service_name != NULL) {
                PPPOE_ADD_16(p, l1);
                memcpy(p, sc->sc_service_name, l1);
                p += l1;
        } else {
                PPPOE_ADD_16(p, 0);
        }
        if (sc->sc_ac_cookie_len > 0) {
                PPPOE_ADD_16(p, PPPOE_TAG_ACCOOKIE);
                PPPOE_ADD_16(p, sc->sc_ac_cookie_len);
                memcpy(p, sc->sc_ac_cookie, sc->sc_ac_cookie_len);
                p += sc->sc_ac_cookie_len;
        }
        if (sc->sc_relay_sid_len > 0) {
                PPPOE_ADD_16(p, PPPOE_TAG_RELAYSID);
                PPPOE_ADD_16(p, sc->sc_relay_sid_len);
                memcpy(p, sc->sc_relay_sid, sc->sc_relay_sid_len);
                p += sc->sc_relay_sid_len;
        }
        PPPOE_ADD_16(p, PPPOE_TAG_HUNIQUE);
        PPPOE_ADD_16(p, sizeof(sc->sc_unique));
        memcpy(p, &sc->sc_unique, sizeof(sc->sc_unique));
        p += sizeof(sc->sc_unique);

        if (sc->sc_sppp.pp_if.if_mtu > PPPOE_MTU) {
                PPPOE_ADD_16(p, PPPOE_TAG_MAX_PAYLOAD);
                PPPOE_ADD_16(p, 2);
                PPPOE_ADD_16(p, (u_int16_t)sc->sc_sppp.pp_if.if_mtu);
        }

#ifdef PPPOE_DEBUG
        if (p - mtod(m0, u_int8_t *) != len + PPPOE_HEADERLEN)
                panic("pppoe_send_padr: garbled output len, should be %ld, is %ld",
                        (long)(len + PPPOE_HEADERLEN), (long)(p - mtod(m0, u_int8_t *)));
#endif

        return (pppoe_output(sc, m0));
}

/* Send a PADT packet. */
static int
pppoe_send_padt(unsigned int ifidx, u_int session, const u_int8_t *dest, u_int8_t prio)
{
        struct ether_header *eh;
        struct sockaddr dst;
        struct ifnet *eth_if;
        struct mbuf *m0;
        u_int8_t *p;
        int ret;

        if ((eth_if = if_get(ifidx)) == NULL)
                return (EINVAL);

        m0 = pppoe_get_mbuf(PPPOE_HEADERLEN);
        if (m0 == NULL) {
                if_put(eth_if);
                return (ENOBUFS);
        }
        m0->m_pkthdr.pf.prio = prio;

        p = mtod(m0, u_int8_t *);
        PPPOE_ADD_HEADER(p, PPPOE_CODE_PADT, session, 0);

        memset(&dst, 0, sizeof(dst));
        dst.sa_family = AF_UNSPEC;
        eh = (struct ether_header *)&dst.sa_data;
        eh->ether_type = htons(ETHERTYPE_PPPOEDISC);
        memcpy(&eh->ether_dhost, dest, ETHER_ADDR_LEN);

        m0->m_flags &= ~(M_BCAST|M_MCAST);
        /* encapsulated packet is forced into rdomain of physical interface */
        m0->m_pkthdr.ph_rtableid = eth_if->if_rdomain;

        ret = eth_if->if_output(eth_if, m0, &dst, NULL);
        if_put(eth_if);

        return (ret);
}


/* this-layer-start function */
static void
pppoe_tls(struct sppp *sp)
{
        struct pppoe_softc *sc = (void *)sp;

        if (sc->sc_state != PPPOE_STATE_INITIAL)
                return;
        pppoe_connect(sc);
}

/* this-layer-finish function */
static void
pppoe_tlf(struct sppp *sp)
{
        struct pppoe_softc *sc = (void *)sp;

        if (sc->sc_state < PPPOE_STATE_SESSION)
                return;
        /*
         * Do not call pppoe_disconnect here, the upper layer state
         * machine gets confused by this. We must return from this
         * function and defer disconnecting to the timeout handler.
         */
        pppoe_set_state(sc, PPPOE_STATE_CLOSING);
        timeout_add_msec(&sc->sc_timeout, 20);
}

int
pppoe_transmit(struct pppoe_softc *sc, struct mbuf *m)
{
        size_t len;
        uint8_t *p;
#if NBPFILTER > 0
        struct ifnet *ifp = &sc->sc_sppp.pp_if;
        caddr_t if_bpf;
#endif

        len = m->m_pkthdr.len;
        M_PREPEND(m, PPPOE_HEADERLEN, M_DONTWAIT);
        if (m == NULL)
                return (ENOBUFS);

        p = mtod(m, u_int8_t *);
        PPPOE_ADD_HEADER(p, 0, sc->sc_session, len);

#if NBPFILTER > 0
        if_bpf = ifp->if_bpf;
        if (if_bpf && m->m_pkthdr.ph_family != AF_UNSPEC) {
                struct m_hdr mh;
                struct mbuf *n;
                int off;

                n = m_getptr(m, PPPOE_OVERHEAD, &off);
                KASSERT(n != NULL);

                mh.mh_flags = 0;
                mh.mh_next = n->m_next;
                mh.mh_len = n->m_len - off;
                mh.mh_data = n->m_data + off;

                bpf_mtap_af(if_bpf, m->m_pkthdr.ph_family,
                    (struct mbuf *)&mh, BPF_DIRECTION_OUT);
        }

        if_bpf = sc->sc_bpf;
        if (if_bpf)
                bpf_mtap(if_bpf, m, BPF_DIRECTION_OUT);
#endif

        return (pppoe_output(sc, m));
}

int
pppoe_enqueue(struct ifnet *ifp, struct mbuf *m)
{
        struct pppoe_softc *sc;
        int error;

        if (!ifq_is_priq(&ifp->if_snd))
                return (if_enqueue_ifq(ifp, m));

        sc = ifp->if_softc;
        if (sc->sc_state < PPPOE_STATE_SESSION) {
                m_freem(m);
                return (ENETDOWN);
        }

        error = pppoe_transmit(sc, m);
        if (error != 0)
                counters_inc(ifp->if_counters, ifc_oerrors);

        return (error);
}

static void
pppoe_start(struct ifnet *ifp)
{
        struct pppoe_softc *sc = (void *)ifp;
        struct mbuf *m;

        if (sppp_isempty(ifp))
                return;

        /* are we ready to process data yet? */
        if (sc->sc_state < PPPOE_STATE_SESSION) {
                sppp_flush(&sc->sc_sppp.pp_if);
                return;
        }

        while ((m = sppp_dequeue(ifp)) != NULL)
                pppoe_transmit(sc, m);
}