/*      $NetBSD: if.h,v 1.310 2026/05/05 10:23:34 roy Exp $     */

/*-
 * Copyright (c) 1999, 2000, 2001 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by William Studenmund and Jason R. Thorpe.
 *
 * 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.
 */

/*
 * Copyright (c) 1982, 1986, 1989, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * 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.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
 *
 *      @(#)if.h        8.3 (Berkeley) 2/9/95
 */

#ifndef _NET_IF_H_
#define _NET_IF_H_

#if !defined(_KERNEL) && !defined(_STANDALONE)
#include <stdbool.h>
#endif

#include <sys/featuretest.h>

/*
 * Length of interface external name, including terminating '\0'.
 * Note: this is the same size as a generic device's external name.
 */
#define IF_NAMESIZE 16

/*
 * Length of interface description, including terminating '\0'.
 */
#define IFDESCRSIZE     64

#if defined(_NETBSD_SOURCE)

#include <sys/socket.h>
#include <sys/queue.h>
#include <sys/mutex.h>
#include <sys/hook.h>

#include <net/dlt.h>
#include <net/pfil.h>
#ifdef _KERNEL
#include <net/pktqueue.h>
#include <sys/pslist.h>
#include <sys/pserialize.h>
#include <sys/psref.h>
#include <sys/module_hook.h>
#endif

/*
 * Always include ALTQ glue here -- we use the ALTQ interface queue
 * structure even when ALTQ is not configured into the kernel so that
 * the size of struct ifnet does not changed based on the option.  The
 * ALTQ queue structure is API-compatible with the legacy ifqueue.
 */
#include <altq/if_altq.h>

/*
 * Structures defining a network interface, providing a packet
 * transport mechanism (ala level 0 of the PUP protocols).
 *
 * Each interface accepts output datagrams of a specified maximum
 * length, and provides higher level routines with input datagrams
 * received from its medium.
 *
 * Output occurs when the routine if_output is called, with four parameters:
 *      (*ifp->if_output)(ifp, m, dst, rt)
 * Here m is the mbuf chain to be sent and dst is the destination address.
 * The output routine encapsulates the supplied datagram if necessary,
 * and then transmits it on its medium.
 *
 * On input, each interface unwraps the data received by it, and either
 * places it on the input queue of a internetwork datagram routine
 * and posts the associated software interrupt, or passes the datagram to a raw
 * packet input routine.
 *
 * Routines exist for locating interfaces by their addresses
 * or for locating a interface on a certain network, as well as more general
 * routing and gateway routines maintaining information used to locate
 * interfaces.  These routines live in the files if.c and route.c
 */
#include <sys/time.h>

#if defined(_KERNEL_OPT)
#include "opt_compat_netbsd.h"
#include "opt_gateway.h"
#endif

struct mbuf;
struct proc;
struct rtentry;
struct socket;
struct ether_header;
struct ifaddr;
struct ifnet;
struct rt_addrinfo;

#define IFNAMSIZ        IF_NAMESIZE

/*
 * Structure describing a `cloning' interface.
 */
struct if_clone {
        LIST_ENTRY(if_clone) ifc_list;  /* on list of cloners */
        const char *ifc_name;           /* name of device, e.g. `gif' */
        size_t ifc_namelen;             /* length of name */

        int     (*ifc_create)(struct if_clone *, int);
        int     (*ifc_destroy)(struct ifnet *);
};

#define IF_CLONE_INITIALIZER(name, create, destroy)                     \
        { { NULL, NULL }, name, sizeof(name) - 1, create, destroy }

/*
 * Structure used to query names of interface cloners.
 */
struct if_clonereq {
        int     ifcr_total;             /* total cloners (out) */
        int     ifcr_count;             /* room for this many in user buffer */
        char    *ifcr_buffer;           /* buffer for cloner names */
};

/*
 * Structure defining statistics and other data kept regarding a network
 * interface.
 *
 * Only used for exporting data from the interface.
 */
struct if_data {
        /* generic interface information */
        u_char  ifi_type;               /* ethernet, tokenring, etc. */
        u_char  ifi_addrlen;            /* media address length */
        u_char  ifi_hdrlen;             /* media header length */
        int     ifi_link_state;         /* current link state */
        uint64_t ifi_mtu;               /* maximum transmission unit */
        uint64_t ifi_metric;            /* routing metric (external only) */
        uint64_t ifi_baudrate;          /* linespeed */
        /* volatile statistics */
        uint64_t ifi_ipackets;          /* packets received on interface */
        uint64_t ifi_ierrors;           /* input errors on interface */
        uint64_t ifi_opackets;          /* packets sent on interface */
        uint64_t ifi_oerrors;           /* output errors on interface */
        uint64_t ifi_collisions;        /* collisions on csma interfaces */
        uint64_t ifi_ibytes;            /* total number of octets received */
        uint64_t ifi_obytes;            /* total number of octets sent */
        uint64_t ifi_imcasts;           /* packets received via multicast */
        uint64_t ifi_omcasts;           /* packets sent via multicast */
        uint64_t ifi_iqdrops;           /* dropped on input, this interface */
        uint64_t ifi_noproto;           /* destined for unsupported protocol */
        struct  timespec ifi_lastchange;/* last operational state change */
};

/*
 * Values for if_link_state.
 */
#define LINK_STATE_UNKNOWN      0       /* link invalid/unknown */
#define LINK_STATE_DOWN         1       /* link is down */
#define LINK_STATE_UP           2       /* link is up */

/*
 * Status bit descriptions for the various interface types.
 */
struct if_status_description {
        unsigned char   ifs_type;
        unsigned char   ifs_state;
        const char      *ifs_string;
};

#define LINK_STATE_DESC_MATCH(_ifs, _t, _s)                             \
        (((_ifs)->ifs_type == (_t) || (_ifs)->ifs_type == 0) &&         \
            (_ifs)->ifs_state == (_s))

#define LINK_STATE_DESCRIPTIONS {                                       \
        { IFT_ETHER, LINK_STATE_DOWN, "no carrier" },                   \
        { IFT_IEEE80211, LINK_STATE_DOWN, "no network" },               \
        { IFT_PPP, LINK_STATE_DOWN, "no carrier" },                     \
        { IFT_CARP, LINK_STATE_DOWN, "backup" },                        \
        { IFT_CARP, LINK_STATE_UP, "master" },                          \
        { 0, LINK_STATE_UP, "active" },                                 \
        { 0, LINK_STATE_UNKNOWN, "unknown" },                           \
        { 0, LINK_STATE_DOWN, "down" },                                 \
        { 0, 0, NULL }                                                  \
}

/*
 * Structure defining a queue for a network interface.
 */
struct ifqueue {
        struct          mbuf *ifq_head;
        struct          mbuf *ifq_tail;
        int             ifq_len;
        int             ifq_maxlen;
        uint64_t        ifq_drops;
        kmutex_t        *ifq_lock;
};

#ifdef _KERNEL
#include <sys/percpu.h>
#include <sys/callout.h>
#include <sys/rwlock.h>
#include <sys/workqueue.h>

#endif /* _KERNEL */

/*
 * Structure defining a queue for a network interface.
 *
 * (Would like to call this struct ``if'', but C isn't PL/1.)
 */
TAILQ_HEAD(ifnet_head, ifnet);          /* the actual queue head */

struct bridge_softc;
struct bridge_iflist;
struct callout;
struct krwlock;
struct if_percpuq;
struct if_deferred_start;
struct in6_multi;

typedef unsigned short if_index_t;

/*
 * Interface.  Field markings and the corresponding locks:
 *
 * i:   IFNET_LOCK (a.k.a., if_ioctl_lock)
 * q:   ifq_lock (struct ifaltq)
 * a:   if_afdata_lock
 * 6:   in6_multilock (global lock)
 * ::   unlocked, stable
 * ?:   unknown, maybe unsafe
 *
 * Lock order: IFNET_LOCK => in6_multilock => if_afdata_lock => ifq_lock
 *   Note that currently if_afdata_lock and ifq_lock aren't held
 *   at the same time, but define the order anyway.
 *
 * Lock order of IFNET_LOCK with other locks:
 *     softnet_lock => solock => IFNET_LOCK => ND6_LOCK, in_multilock
 */
typedef struct ifnet {
        void            *if_softc;      /* :: lower-level data for this if */
        /* DEPRECATED. Keep it to avoid breaking kvm(3) users */
        TAILQ_ENTRY(ifnet)
                        if_list;        /* i: all struct ifnets are chained */
        TAILQ_HEAD(, ifaddr)
                        if_addrlist;    /* i: linked list of addresses per if */
        char            if_xname[IFNAMSIZ];
                                        /* :: external name (name + unit) */
        int             if_pcount;      /* i: number of promiscuous listeners */
        struct bpf_if   *if_bpf;        /* :: packet filter structure */
        if_index_t      if_index;       /* :: numeric abbreviation for this if */
        short           if_timer;       /* ?: time 'til if_slowtimo called */
        unsigned short  if_flags;       /* i: up/down, broadcast, etc. */
        short           if_extflags;    /* :: if_output MP-safe, etc. */
        u_char          if_type;        /* :: ethernet, tokenring, etc. */
        u_char          if_addrlen;     /* :: media address length */
        u_char          if_hdrlen;      /* :: media header length */
        /* XXX audit :? fields here. */
        int             if_link_state;  /* :? current link state */
        uint64_t        if_mtu;         /* :? maximum transmission unit */
        uint64_t        if_metric;      /* :? routing metric (external only) */
        uint64_t        if_baudrate;    /* :? linespeed */
        struct timespec if_lastchange;  /* :? last operational state change */
#ifdef _KERNEL
        percpu_t        *if_stats;      /* :: statistics */
#else
        void            *if_stats;      /* opaque to user-space */
#endif /* _KERNEL */
        /*
         * Procedure handles.  If you add more of these, don't forget the
         * corresponding NULL stub in if.c.
         */
        int             (*if_output)    /* :: output routine (enqueue) */
                            (struct ifnet *, struct mbuf *, const struct sockaddr *,
                             const struct rtentry *);
        void            (*_if_input)    /* :: input routine (from h/w driver) */
                            (struct ifnet *, struct mbuf *);
        void            (*if_start)     /* :: initiate output routine */
                            (struct ifnet *);
        int             (*if_transmit)  /* :: output routine, must be MP-safe */
                            (struct ifnet *, struct mbuf *);
        int             (*if_ioctl)     /* :: ioctl routine */
                            (struct ifnet *, u_long, void *);
        int             (*if_init)      /* :: init routine */
                            (struct ifnet *);
        void            (*if_stop)      /* :: stop routine */
                            (struct ifnet *, int);
        void            (*if_slowtimo)  /* :: timer routine */
                            (struct ifnet *);
#define if_watchdog     if_slowtimo
        void            (*if_drain)     /* :: routine to release resources */
                            (struct ifnet *);
        void            (*if_bpf_mtap)  /* :: bpf routine */
                            (struct bpf_if *, struct mbuf *, u_int);
        struct ifaltq   if_snd;         /* q: output queue (includes altq) */
        struct ifaddr   *if_dl;         /* i: identity of this interface. */
        const struct sockaddr_dl
                        *if_sadl;       /* i: pointer to sockaddr_dl of if_dl */
        /*
         * May be NULL.  If not NULL, it is the address assigned
         * to the interface by the manufacturer, so it very likely
         * to be unique.  It MUST NOT be deleted.  It is highly
         * suitable for deriving the EUI64 for the interface.
         */
        struct ifaddr   *if_hwdl;       /* i: h/w identity */
        const uint8_t   *if_broadcastaddr;
                                        /* :: linklevel broadcast bytestring */
        struct bridge_softc
                        *if_bridge;     /* i: bridge glue */
        struct bridge_iflist
                        *if_bridgeif;   /* i: shortcut to interface list entry */
        int             if_dlt;         /* :: data link type (<net/dlt.h>) */
        pfil_head_t *   if_pfil;        /* :: filtering point */
        uint64_t        if_capabilities;
                                        /* i: interface capabilities */
        uint64_t        if_capenable;   /* i: capabilities enabled */
        union {
                void *          carp_s; /* carp structure (used by !carp ifs) */
                struct ifnet    *carp_d;/* ptr to carpdev (used by carp ifs) */
        }               if_carp_ptr;    /* ?: */
#define if_carp         if_carp_ptr.carp_s
#define if_carpdev      if_carp_ptr.carp_d
        /*
         * These are pre-computed based on an interfaces enabled
         * capabilities, for speed elsewhere.
         */
        int             if_csum_flags_tx;
                                        /* i: M_CSUM_* flags for Tx */
        int             if_csum_flags_rx;
                                        /* i: M_CSUM_* flags for Rx */

        void            *if_afdata[AF_MAX];
                                        /* a: */
        struct mowner   *if_mowner;     /* ?: who owns mbufs for this interface */

        void            *if_lagg;       /* :: lagg or agr structure */
        void            *if_npf_private;/* ?: associated NPF context */

        /*
         * pf specific data, used only when #if NPF > 0.
         */
        void            *if_pf_kif;     /* ?: pf interface abstraction */
        void            *if_pf_groups;  /* ?: pf interface groups */
        /*
         * During an ifnet's lifetime, it has only one if_index, but
         * an if_index is not sufficient to identify an ifnet
         * because during the lifetime of the system, many ifnets may occupy a
         * given if_index.  Let us tell different ifnets at the same
         * if_index apart by their if_index_gen, a unique number that each ifnet
         * is assigned when it if_attach()s.  Now, the kernel can use the
         * pair (if_index, if_index_gen) as a weak reference to an ifnet.
         */
        uint64_t        if_index_gen;   /* :: generation number for the ifnet
                                         * at if_index: if two ifnets' index
                                         * and generation number are both the
                                         * same, they are the same ifnet.
                                         */
        struct sysctllog
                        *if_sysctl_log; /* :: */
        int             (*if_initaddr)  /* :: */
                            (struct ifnet *, struct ifaddr *, bool);
        int             (*if_setflags)  /* :: */
                            (struct ifnet *, const u_short);
        kmutex_t        *if_ioctl_lock; /* :: */
        char            *if_description;        /* i: interface description */
#ifdef _KERNEL /* XXX kvm(3) */
        struct if_slowtimo_data *if_slowtimo_data; /* :: */
        struct krwlock  *if_afdata_lock;/* :: */
        struct if_percpuq
                        *if_percpuq;    /* :: we should remove it in the future */
        struct work     if_link_work;   /* q: linkage on link state work queue */
        uint16_t        if_link_queue;  /* q: masked link state change queue */
#define LINK_QUEUE_LOCKED       (1 << 0)
#define LINK_QUEUE_SCHEDULED    (1 << 1)
#define LINK_QUEUE_DOWN         (1 << 2)
#define LINK_QUEUE_UNKNOWN      (1 << 3)
#define LINK_QUEUE_UP           (1 << 4)
                                        /* if_link_scheduled is unused */
        bool            if_link_scheduled;
        struct pslist_entry
                        if_pslist_entry;/* i: */
        struct psref_target
                        if_psref;       /* :: */
        struct pslist_head
                        if_addr_pslist; /* i: */
        struct if_deferred_start
                        *if_deferred_start;
                                        /* :: */
        /* XXX should be protocol independent */
        LIST_HEAD(, in6_multi)
                        if_multiaddrs;  /* 6: */
        khook_list_t    *if_linkstate_hooks;    /* :: */
#endif
} ifnet_t;

#include <net/if_stats.h>

#define if_name(ifp)    ((ifp)->if_xname)

#define IFF_UP          0x0001          /* interface is up */
#define IFF_BROADCAST   0x0002          /* broadcast address valid */
#define IFF_DEBUG       0x0004          /* turn on debugging */
#define IFF_LOOPBACK    0x0008          /* is a loopback net */
#define IFF_POINTOPOINT 0x0010          /* interface is point-to-point link */
#if 0
/*                      0x0020             was IFF_NOTRAILERS */
#else
/*
 * sys/compat/svr4 is removed on 19 Dec 2018.
 * And then, IFF_NOTRAILERS itself is removed by if.h:r1.268 on 5 Feb 2019.
 */
#define IFF_UNNUMBERED  0x0020          /* explicit unnumbered */
#endif
#define IFF_RUNNING     0x0040          /* resources allocated */
#define IFF_NOARP       0x0080          /* no address resolution protocol */
#define IFF_PROMISC     0x0100          /* receive all packets */
#define IFF_ALLMULTI    0x0200          /* OBSOLETE -- DO NOT USE */
/*
 * IFF_ALLMULTI obsoleted on 2019-05-15 -- existing non-MP-safe drivers
 * can use it for themselves under IFNET_LOCK, but they should be
 * converted to use ETHER_F_ALLMULTI under ETHER_LOCK instead.  For
 * compatibility with existing drivers, if_ethersubr and if_arcsubr
 * will set IFF_ALLMULTI according to other flags, but you should not
 * rely on this.
 */
#define IFF_OACTIVE     0x0400          /* transmission in progress */
#define IFF_SIMPLEX     0x0800          /* can't hear own transmissions */
#define IFF_LINK0       0x1000          /* per link layer defined bit */
#define IFF_LINK1       0x2000          /* per link layer defined bit */
#define IFF_LINK2       0x4000          /* per link layer defined bit */
#define IFF_MULTICAST   0x8000          /* supports multicast */

#define IFEF_MPSAFE                     __BIT(0)        /* handlers can run in parallel (see below) */

/*
 * The guidelines for converting an interface to IFEF_MPSAFE are as follows
 *
 * Enabling IFEF_MPSAFE on an interface suppresses taking KERNEL_LOCK when
 * calling the following handlers:
 * - if_start
 *   - Note that if_transmit is always called without KERNEL_LOCK
 * - if_output
 * - if_ioctl
 * - if_init
 * - if_stop
 *
 * This means that an interface with IFEF_MPSAFE must make the above handlers
 * MP-safe or take KERNEL_LOCK by itself inside handlers that aren't MP-safe
 * yet.
 *
 * There are some additional restrictions to access member variables of struct
 * ifnet:
 * - if_flags
 *   - Must be updated with holding IFNET_LOCK
 *   - You cannot use the flag in Tx/Rx paths anymore because there is no
 *     synchronization on the flag except for IFNET_LOCK
 *   - Note that IFNET_LOCK can't be taken in softint because it's known
 *     that it causes a deadlock
 *     - Some synchronization mechanisms such as pserialize_perform are called
 *       with IFNET_LOCK and also require context switches on every CPUs
 *       that mean softints finish so trying to take IFNET_LOCK in softint
 *       might block on IFNET_LOCK and prevent such synchronization mechanisms
 *       from being completed
 *     - Currently the deadlock occurs only if NET_MPSAFE is enabled, however,
 *       we should deal with the restriction because NET_MPSAFE will be enabled
 *       by default in the future
 * - if_watchdog and if_timer
 *   - The watchdog framework works only for non-IFEF_MPSAFE interfaces
 *     that rely on KERNEL_LOCK
 *   - Interfaces with IFEF_MPSAFE have to provide its own watchdog mechanism
 *     if needed
 *     - Keep if_watchdog NULL when calling if_attach
 */

#ifdef _KERNEL
static __inline bool
if_is_mpsafe(struct ifnet *ifp)
{

        return ((ifp->if_extflags & IFEF_MPSAFE) != 0);
}

static __inline int
if_output_lock(struct ifnet *cifp, struct ifnet *ifp, struct mbuf *m,
    const struct sockaddr *dst, const struct rtentry *rt)
{

        if (if_is_mpsafe(cifp)) {
                return (*cifp->if_output)(ifp, m, dst, rt);
        } else {
                int ret;

                KERNEL_LOCK(1, NULL);
                ret = (*cifp->if_output)(ifp, m, dst, rt);
                KERNEL_UNLOCK_ONE(NULL);
                return ret;
        }
}

static __inline void
if_start_lock(struct ifnet *ifp)
{

        if (if_is_mpsafe(ifp)) {
                (*ifp->if_start)(ifp);
        } else {
                KERNEL_LOCK(1, NULL);
                (*ifp->if_start)(ifp);
                KERNEL_UNLOCK_ONE(NULL);
        }
}

#define KERNEL_LOCK_IF_IFP_MPSAFE(ifp)                                  \
        do { if (if_is_mpsafe(ifp)) { KERNEL_LOCK(1, NULL); } } while (0)
#define KERNEL_UNLOCK_IF_IFP_MPSAFE(ifp)                                \
        do { if (if_is_mpsafe(ifp)) { KERNEL_UNLOCK_ONE(NULL); } } while (0)

#define KERNEL_LOCK_UNLESS_IFP_MPSAFE(ifp)                              \
        do { if (!if_is_mpsafe(ifp)) { KERNEL_LOCK(1, NULL); } } while (0)
#define KERNEL_UNLOCK_UNLESS_IFP_MPSAFE(ifp)                            \
        do { if (!if_is_mpsafe(ifp)) { KERNEL_UNLOCK_ONE(NULL); } } while (0)

#ifdef _KERNEL_OPT
#include "opt_net_mpsafe.h"
#endif

/* XXX explore a better place to define */
#ifdef NET_MPSAFE

#define KERNEL_LOCK_UNLESS_NET_MPSAFE()         do { } while (0)
#define KERNEL_UNLOCK_UNLESS_NET_MPSAFE()       do { } while (0)

#define SOFTNET_LOCK_UNLESS_NET_MPSAFE()        do { } while (0)
#define SOFTNET_UNLOCK_UNLESS_NET_MPSAFE()      do { } while (0)

#define SOFTNET_LOCK_IF_NET_MPSAFE()                                    \
        do { mutex_enter(softnet_lock); } while (0)
#define SOFTNET_UNLOCK_IF_NET_MPSAFE()                                  \
        do { mutex_exit(softnet_lock); } while (0)

#else /* NET_MPSAFE */

#define KERNEL_LOCK_UNLESS_NET_MPSAFE()                                 \
        do { KERNEL_LOCK(1, NULL); } while (0)
#define KERNEL_UNLOCK_UNLESS_NET_MPSAFE()                               \
        do { KERNEL_UNLOCK_ONE(NULL); } while (0)

#define SOFTNET_LOCK_UNLESS_NET_MPSAFE()                                \
        do { mutex_enter(softnet_lock); } while (0)
#define SOFTNET_UNLOCK_UNLESS_NET_MPSAFE()                              \
        do { mutex_exit(softnet_lock); } while (0)

#define SOFTNET_LOCK_IF_NET_MPSAFE()            do { } while (0)
#define SOFTNET_UNLOCK_IF_NET_MPSAFE()          do { } while (0)

#endif /* NET_MPSAFE */

#define SOFTNET_KERNEL_LOCK_UNLESS_NET_MPSAFE()                         \
        do {                                                            \
                SOFTNET_LOCK_UNLESS_NET_MPSAFE();                       \
                KERNEL_LOCK_UNLESS_NET_MPSAFE();                        \
        } while (0)

#define SOFTNET_KERNEL_UNLOCK_UNLESS_NET_MPSAFE()                       \
        do {                                                            \
                KERNEL_UNLOCK_UNLESS_NET_MPSAFE();                      \
                SOFTNET_UNLOCK_UNLESS_NET_MPSAFE();                     \
        } while (0)

#endif /* _KERNEL */

#define IFFBITS \
    "\020\1UP\2BROADCAST\3DEBUG\4LOOPBACK\5POINTOPOINT\6UNNUMBERED" \
    "\7RUNNING\10NOARP\11PROMISC\12ALLMULTI\13OACTIVE\14SIMPLEX" \
    "\15LINK0\16LINK1\17LINK2\20MULTICAST"

/* flags set internally only: */
#define IFF_CANTCHANGE \
        (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
            IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC)

/*
 * Some convenience macros used for setting ifi_baudrate.
 */
#define IF_Kbps(x)      ((x) * 1000ULL)                 /* kilobits/sec. */
#define IF_Mbps(x)      (IF_Kbps((x) * 1000ULL))        /* megabits/sec. */
#define IF_Gbps(x)      (IF_Mbps((x) * 1000ULL))        /* gigabits/sec. */

/* Capabilities that interfaces can advertise. */
                                        /* 0x01 .. 0x40 were previously used */
#define IFCAP_TSOv4             0x00080 /* can do TCPv4 segmentation offload */
#define IFCAP_CSUM_IPv4_Rx      0x00100 /* can do IPv4 header checksums (Rx) */
#define IFCAP_CSUM_IPv4_Tx      0x00200 /* can do IPv4 header checksums (Tx) */
#define IFCAP_CSUM_TCPv4_Rx     0x00400 /* can do IPv4/TCP checksums (Rx) */
#define IFCAP_CSUM_TCPv4_Tx     0x00800 /* can do IPv4/TCP checksums (Tx) */
#define IFCAP_CSUM_UDPv4_Rx     0x01000 /* can do IPv4/UDP checksums (Rx) */
#define IFCAP_CSUM_UDPv4_Tx     0x02000 /* can do IPv4/UDP checksums (Tx) */
#define IFCAP_CSUM_TCPv6_Rx     0x04000 /* can do IPv6/TCP checksums (Rx) */
#define IFCAP_CSUM_TCPv6_Tx     0x08000 /* can do IPv6/TCP checksums (Tx) */
#define IFCAP_CSUM_UDPv6_Rx     0x10000 /* can do IPv6/UDP checksums (Rx) */
#define IFCAP_CSUM_UDPv6_Tx     0x20000 /* can do IPv6/UDP checksums (Tx) */
#define IFCAP_TSOv6             0x40000 /* can do TCPv6 segmentation offload */
#define IFCAP_LRO               0x80000 /* can do Large Receive Offload */
#define IFCAP_MASK              0xfff80 /* currently valid capabilities */

#define IFCAPBITS               \
        "\020"                  \
        "\10TSO4"               \
        "\11IP4CSUM_Rx"         \
        "\12IP4CSUM_Tx"         \
        "\13TCP4CSUM_Rx"        \
        "\14TCP4CSUM_Tx"        \
        "\15UDP4CSUM_Rx"        \
        "\16UDP4CSUM_Tx"        \
        "\17TCP6CSUM_Rx"        \
        "\20TCP6CSUM_Tx"        \
        "\21UDP6CSUM_Rx"        \
        "\22UDP6CSUM_Tx"        \
        "\23TSO6"               \
        "\24LRO"                \

#define IF_AFDATA_LOCK_INIT(ifp)        \
        do {(ifp)->if_afdata_lock = rw_obj_alloc();} while (0)

#define IF_AFDATA_LOCK_DESTROY(ifp)     rw_obj_free((ifp)->if_afdata_lock)

#define IF_AFDATA_WLOCK(ifp)    rw_enter((ifp)->if_afdata_lock, RW_WRITER)
#define IF_AFDATA_RLOCK(ifp)    rw_enter((ifp)->if_afdata_lock, RW_READER)
#define IF_AFDATA_WUNLOCK(ifp)  rw_exit((ifp)->if_afdata_lock)
#define IF_AFDATA_RUNLOCK(ifp)  rw_exit((ifp)->if_afdata_lock)
#define IF_AFDATA_LOCK(ifp)     IF_AFDATA_WLOCK(ifp)
#define IF_AFDATA_UNLOCK(ifp)   IF_AFDATA_WUNLOCK(ifp)
#define IF_AFDATA_TRYLOCK(ifp)  rw_tryenter((ifp)->if_afdata_lock, RW_WRITER)

#define IF_AFDATA_LOCK_ASSERT(ifp)      \
        KASSERT(rw_lock_held((ifp)->if_afdata_lock))
#define IF_AFDATA_RLOCK_ASSERT(ifp)     \
        KASSERT(rw_read_held((ifp)->if_afdata_lock))
#define IF_AFDATA_WLOCK_ASSERT(ifp)     \
        KASSERT(rw_write_held((ifp)->if_afdata_lock))

/*
 * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
 * input routines have queues of messages stored on ifqueue structures
 * (defined above).  Entries are added to and deleted from these structures
 * by these macros, which should be called with ipl raised to splnet().
 */
#define IF_QFULL(ifq)           ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
#define IF_DROP(ifq)            ((ifq)->ifq_drops++)
#define IF_ENQUEUE(ifq, m) do { \
        (m)->m_nextpkt = 0; \
        if ((ifq)->ifq_tail == 0) \
                (ifq)->ifq_head = m; \
        else \
                (ifq)->ifq_tail->m_nextpkt = m; \
        (ifq)->ifq_tail = m; \
        (ifq)->ifq_len++; \
} while (/*CONSTCOND*/0)
#define IF_PREPEND(ifq, m) do { \
        (m)->m_nextpkt = (ifq)->ifq_head; \
        if ((ifq)->ifq_tail == 0) \
                (ifq)->ifq_tail = (m); \
        (ifq)->ifq_head = (m); \
        (ifq)->ifq_len++; \
} while (/*CONSTCOND*/0)
#define IF_DEQUEUE(ifq, m) do { \
        (m) = (ifq)->ifq_head; \
        if (m) { \
                if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
                        (ifq)->ifq_tail = 0; \
                (m)->m_nextpkt = 0; \
                (ifq)->ifq_len--; \
        } \
} while (/*CONSTCOND*/0)
#define IF_POLL(ifq, m)         ((m) = (ifq)->ifq_head)
#define IF_PURGE(ifq)                                                   \
do {                                                                    \
        struct mbuf *__m0;                                              \
                                                                        \
        for (;;) {                                                      \
                IF_DEQUEUE((ifq), __m0);                                \
                if (__m0 == NULL)                                       \
                        break;                                          \
                else                                                    \
                        m_freem(__m0);                                  \
        }                                                               \
} while (/*CONSTCOND*/ 0)
#define IF_IS_EMPTY(ifq)        ((ifq)->ifq_len == 0)

#ifndef IFQ_MAXLEN
#define IFQ_MAXLEN      256
#endif
#define IFNET_SLOWHZ    1               /* granularity is 1 second */

/*
 * Structure defining statistics and other data kept regarding an address
 * on a network interface.
 */
struct ifaddr_data {
        int64_t ifad_inbytes;
        int64_t ifad_outbytes;
};

/*
 * The ifaddr structure contains information about one address
 * of an interface.  They are maintained by the different address families,
 * are allocated and attached when an address is set, and are linked
 * together so all addresses for an interface can be located.
 */
struct ifaddr {
        struct  sockaddr *ifa_addr;     /* address of interface */
        struct  sockaddr *ifa_dstaddr;  /* other end of p-to-p link */
#define ifa_broadaddr   ifa_dstaddr     /* broadcast address interface */
        struct  sockaddr *ifa_netmask;  /* used to determine subnet */
        struct  ifnet *ifa_ifp;         /* back-pointer to interface */
        TAILQ_ENTRY(ifaddr) ifa_list;   /* list of addresses for interface */
        struct  ifaddr_data     ifa_data;       /* statistics on the address */
        void    (*ifa_rtrequest)        /* check or clean routes (+ or -)'d */
                        (int, struct rtentry *, const struct rt_addrinfo *);
        u_int   ifa_flags;              /* mostly rt_flags for cloning */
        int     ifa_refcnt;             /* count of references */
        int     ifa_metric;             /* cost of going out this interface */
        struct ifaddr   *(*ifa_getifa)(struct ifaddr *,
                                       const struct sockaddr *);
        uint32_t        *ifa_seqno;
        int16_t ifa_preference; /* preference level for this address */
#ifdef _KERNEL
        struct pslist_entry     ifa_pslist_entry;
        struct psref_target     ifa_psref;
#endif
};
#define IFA_ROUTE       RTF_UP  /* (0x01) route installed */
#define IFA_DESTROYING  0x2

/*
 * Message format for use in obtaining information about interfaces from
 * sysctl and the routing socket.  We need to force 64-bit alignment if we
 * aren't using compatibility definitions.
 */
#if !defined(_KERNEL) || !defined(COMPAT_RTSOCK)
#define __align64       __aligned(sizeof(uint64_t))
#else
#define __align64
#endif
struct if_msghdr {
        u_short ifm_msglen __align64;
                                /* to skip over non-understood messages */
        u_char  ifm_version;    /* future binary compatibility */
        u_char  ifm_type;       /* message type */
        int     ifm_addrs;      /* like rtm_addrs */
        int     ifm_flags;      /* value of if_flags */
        u_short ifm_index;      /* index for associated ifp */
        struct  if_data ifm_data __align64;
                                /* statistics and other data about if */
};

/*
 * Message format for use in obtaining information about interface addresses
 * from sysctl and the routing socket.
 */
struct ifa_msghdr {
        u_short ifam_msglen __align64;
                                /* to skip over non-understood messages */
        u_char  ifam_version;   /* future binary compatibility */
        u_char  ifam_type;      /* message type */
        u_short ifam_index;     /* index for associated ifp */
        int     ifam_flags;     /* value of ifa_flags */
        int     ifam_addrs;     /* like rtm_addrs */
        pid_t   ifam_pid;       /* identify sender */
        int     ifam_addrflags; /* family specific address flags */
        int     ifam_metric;    /* value of ifa_metric */
};

/*
 * Message format announcing the arrival or departure of a network interface.
 */
struct if_announcemsghdr {
        u_short ifan_msglen __align64;
                                /* to skip over non-understood messages */
        u_char  ifan_version;   /* future binary compatibility */
        u_char  ifan_type;      /* message type */
        u_short ifan_index;     /* index for associated ifp */
        char    ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
        u_short ifan_what;      /* what type of announcement */
};

#define IFAN_ARRIVAL    0       /* interface arrival */
#define IFAN_DEPARTURE  1       /* interface departure */

#undef __align64

/*
 * Interface request structure used for socket
 * ioctl's.  All interface ioctl's must have parameter
 * definitions which begin with ifr_name.  The
 * remainder may be interface specific.
 */
struct  ifreq {
        char    ifr_name[IFNAMSIZ];             /* if name, e.g. "en0" */
        union {
                struct  sockaddr ifru_addr;
                struct  sockaddr ifru_dstaddr;
                struct  sockaddr ifru_broadaddr;
                struct  sockaddr_storage ifru_space;
                short   ifru_flags;
                int     ifru_addrflags;
                int     ifru_metric;
                int     ifru_mtu;
                int     ifru_dlt;
                u_int   ifru_value;
                void *  ifru_data;
                struct {
                        uint32_t        b_buflen;
                        void            *b_buf;
                } ifru_b;
        } ifr_ifru;
#define ifr_addr        ifr_ifru.ifru_addr      /* address */
#define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
#define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
#define ifr_space       ifr_ifru.ifru_space     /* sockaddr_storage */
#define ifr_flags       ifr_ifru.ifru_flags     /* flags */
#define ifr_addrflags   ifr_ifru.ifru_addrflags /* addr flags */
#define ifr_metric      ifr_ifru.ifru_metric    /* metric */
#define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu */
#define ifr_dlt         ifr_ifru.ifru_dlt       /* data link type (DLT_*) */
#define ifr_value       ifr_ifru.ifru_value     /* generic value */
#define ifr_media       ifr_ifru.ifru_metric    /* media options (overload) */
#define ifr_data        ifr_ifru.ifru_data      /* for use by interface
                                                 * XXX deprecated
                                                 */
#define ifr_buf         ifr_ifru.ifru_b.b_buf   /* new interface ioctls */
#define ifr_buflen      ifr_ifru.ifru_b.b_buflen
#define ifr_index       ifr_ifru.ifru_value     /* interface index, BSD */
#define ifr_ifindex     ifr_index               /* interface index, linux */
};

#ifdef _KERNEL
#define ifreq_setdstaddr        ifreq_setaddr
#define ifreq_setbroadaddr      ifreq_setaddr
#define ifreq_getdstaddr        ifreq_getaddr
#define ifreq_getbroadaddr      ifreq_getaddr

static __inline const struct sockaddr *
/*ARGSUSED*/
ifreq_getaddr(u_long cmd, const struct ifreq *ifr)
{
        return &ifr->ifr_addr;
}
#endif /* _KERNEL */

struct ifcapreq {
        char            ifcr_name[IFNAMSIZ];    /* if name, e.g. "en0" */
        uint64_t        ifcr_capabilities;      /* supported capabiliites */
        uint64_t        ifcr_capenable;         /* capabilities enabled */
};

struct ifaliasreq {
        char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
        struct  sockaddr ifra_addr;
        struct  sockaddr ifra_dstaddr;
#define ifra_broadaddr  ifra_dstaddr
        struct  sockaddr ifra_mask;
};

struct ifdatareq {
        char    ifdr_name[IFNAMSIZ];            /* if name, e.g. "en0" */
        struct  if_data ifdr_data;
};

struct ifmediareq {
        char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
        int     ifm_current;            /* IFMWD: current media options */
        int     ifm_mask;               /* IFMWD: don't care mask */
        int     ifm_status;             /* media status */
        int     ifm_active;             /* IFMWD: active options */
        int     ifm_count;              /* # entries in ifm_ulist
                                           array */
        int     *ifm_ulist;             /* array of ifmedia word */
};


struct  ifdrv {
        char            ifd_name[IFNAMSIZ];     /* if name, e.g. "en0" */
        unsigned long   ifd_cmd;
        size_t          ifd_len;
        void            *ifd_data;
};
#define IFLINKSTR_QUERYLEN      0x01
#define IFLINKSTR_UNSET         0x02

/*
 * Structure used in SIOCGIFCONF request.
 * Used to retrieve interface configuration
 * for machine (useful for programs which
 * must know all networks accessible).
 */
struct  ifconf {
        int     ifc_len;                /* size of associated buffer */
        union {
                void *  ifcu_buf;
                struct  ifreq *ifcu_req;
        } ifc_ifcu;
#define ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
#define ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
};

/*
 * Structure for SIOC[AGD]LIFADDR
 */
struct if_laddrreq {
        char iflr_name[IFNAMSIZ];
        unsigned int flags;
#define IFLR_PREFIX     0x8000  /* in: prefix given  out: kernel fills id */
#define IFLR_ACTIVE     0x4000  /* in/out: link-layer address activation */
#define IFLR_FACTORY    0x2000  /* in/out: factory link-layer address */
        unsigned int prefixlen;         /* in/out */
        struct sockaddr_storage addr;   /* in/out */
        struct sockaddr_storage dstaddr; /* out */
};

/*
 * Structure for SIOC[SG]IFADDRPREF
 */
struct if_addrprefreq {
        char                    ifap_name[IFNAMSIZ];
        int16_t                 ifap_preference;        /* in/out */
        struct sockaddr_storage ifap_addr;              /* in/out */
};

#include <net/if_arp.h>

#endif /* _NETBSD_SOURCE */

#ifdef _KERNEL
#ifdef ALTQ
#define IFQ_ENQUEUE(ifq, m, err)                                        \
do {                                                                    \
        mutex_enter((ifq)->ifq_lock);                                   \
        if (ALTQ_IS_ENABLED(ifq))                                       \
                ALTQ_ENQUEUE((ifq), (m), (err));                        \
        else {                                                          \
                if (IF_QFULL(ifq)) {                                    \
                        m_freem(m);                                     \
                        (err) = ENOBUFS;                                \
                } else {                                                \
                        IF_ENQUEUE((ifq), (m));                         \
                        (err) = 0;                                      \
                }                                                       \
        }                                                               \
        if ((err))                                                      \
                (ifq)->ifq_drops++;                                     \
        mutex_exit((ifq)->ifq_lock);                                    \
} while (/*CONSTCOND*/ 0)

#define IFQ_DEQUEUE(ifq, m)                                             \
do {                                                                    \
        mutex_enter((ifq)->ifq_lock);                                   \
        if (TBR_IS_ENABLED(ifq))                                        \
                (m) = tbr_dequeue((ifq), ALTDQ_REMOVE);                 \
        else if (ALTQ_IS_ENABLED(ifq))                                  \
                ALTQ_DEQUEUE((ifq), (m));                               \
        else                                                            \
                IF_DEQUEUE((ifq), (m));                                 \
        mutex_exit((ifq)->ifq_lock);                                    \
} while (/*CONSTCOND*/ 0)

#define IFQ_POLL(ifq, m)                                                \
do {                                                                    \
        mutex_enter((ifq)->ifq_lock);                                   \
        if (TBR_IS_ENABLED(ifq))                                        \
                (m) = tbr_dequeue((ifq), ALTDQ_POLL);                   \
        else if (ALTQ_IS_ENABLED(ifq))                                  \
                ALTQ_POLL((ifq), (m));                                  \
        else                                                            \
                IF_POLL((ifq), (m));                                    \
        mutex_exit((ifq)->ifq_lock);                                    \
} while (/*CONSTCOND*/ 0)

#define IFQ_PURGE(ifq)                                                  \
do {                                                                    \
        mutex_enter((ifq)->ifq_lock);                                   \
        if (ALTQ_IS_ENABLED(ifq))                                       \
                ALTQ_PURGE(ifq);                                        \
        else                                                            \
                IF_PURGE(ifq);                                          \
        mutex_exit((ifq)->ifq_lock);                                    \
} while (/*CONSTCOND*/ 0)

#define IFQ_SET_READY(ifq)                                              \
do {                                                                    \
        (ifq)->altq_flags |= ALTQF_READY;                               \
} while (/*CONSTCOND*/ 0)

#define IFQ_CLASSIFY(ifq, m, af)                                        \
do {                                                                    \
        KASSERT(((m)->m_flags & M_PKTHDR) != 0);                        \
        mutex_enter((ifq)->ifq_lock);                                   \
        if (ALTQ_IS_ENABLED(ifq)) {                                     \
                if (ALTQ_NEEDS_CLASSIFY(ifq))                           \
                        (m)->m_pkthdr.pattr_class = (*(ifq)->altq_classify) \
                                ((ifq)->altq_clfier, (m), (af));        \
                (m)->m_pkthdr.pattr_af = (af);                          \
                (m)->m_pkthdr.pattr_hdr = mtod((m), void *);            \
        }                                                               \
        mutex_exit((ifq)->ifq_lock);                                    \
} while (/*CONSTCOND*/ 0)
#else /* ! ALTQ */
#define IFQ_ENQUEUE(ifq, m, err)                                        \
do {                                                                    \
        mutex_enter((ifq)->ifq_lock);                                   \
        if (IF_QFULL(ifq)) {                                            \
                m_freem(m);                                             \
                (err) = ENOBUFS;                                        \
        } else {                                                        \
                IF_ENQUEUE((ifq), (m));                                 \
                (err) = 0;                                              \
        }                                                               \
        if (err)                                                        \
                (ifq)->ifq_drops++;                                     \
        mutex_exit((ifq)->ifq_lock);                                    \
} while (/*CONSTCOND*/ 0)

#define IFQ_DEQUEUE(ifq, m)                                             \
do {                                                                    \
        mutex_enter((ifq)->ifq_lock);                                   \
        IF_DEQUEUE((ifq), (m));                                         \
        mutex_exit((ifq)->ifq_lock);                                    \
} while (/*CONSTCOND*/ 0)

#define IFQ_POLL(ifq, m)                                                \
do {                                                                    \
        mutex_enter((ifq)->ifq_lock);                                   \
        IF_POLL((ifq), (m));                                            \
        mutex_exit((ifq)->ifq_lock);                                    \
} while (/*CONSTCOND*/ 0)

#define IFQ_PURGE(ifq)                                                  \
do {                                                                    \
        mutex_enter((ifq)->ifq_lock);                                   \
        IF_PURGE(ifq);                                                  \
        mutex_exit((ifq)->ifq_lock);                                    \
} while (/*CONSTCOND*/ 0)

#define IFQ_SET_READY(ifq)      /* nothing */

#define IFQ_CLASSIFY(ifq, m, af) /* nothing */

#endif /* ALTQ */

#define IFQ_LOCK_INIT(ifq)      (ifq)->ifq_lock =                       \
            mutex_obj_alloc(MUTEX_DEFAULT, IPL_NET)
#define IFQ_LOCK_DESTROY(ifq)   mutex_obj_free((ifq)->ifq_lock)
#define IFQ_LOCK(ifq)           mutex_enter((ifq)->ifq_lock)
#define IFQ_UNLOCK(ifq)         mutex_exit((ifq)->ifq_lock)

#define IFQ_IS_EMPTY(ifq)               IF_IS_EMPTY(ifq)
#define IFQ_INC_LEN(ifq)                ((ifq)->ifq_len++)
#define IFQ_DEC_LEN(ifq)                (--(ifq)->ifq_len)
#define IFQ_INC_DROPS(ifq)              ((ifq)->ifq_drops++)
#define IFQ_SET_MAXLEN(ifq, len)        ((ifq)->ifq_maxlen = (len))

#include <sys/mallocvar.h>
MALLOC_DECLARE(M_IFADDR);
MALLOC_DECLARE(M_IFMADDR);

int ifreq_setaddr(u_long, struct ifreq *, const struct sockaddr *);

struct ifnet *if_alloc(u_char);
void if_free(struct ifnet *);
void if_initname(struct ifnet *, const char *, int);
struct ifaddr *if_dl_create(const struct ifnet *, const struct sockaddr_dl **);
void if_activate_sadl(struct ifnet *, struct ifaddr *,
    const struct sockaddr_dl *);
void    if_set_sadl(struct ifnet *, const void *, u_char, bool);
void    if_alloc_sadl(struct ifnet *);
void    if_free_sadl(struct ifnet *, int);
void    if_initialize(struct ifnet *);
void    if_register(struct ifnet *);
void    if_attach(struct ifnet *); /* Deprecated. Use if_initialize and if_register */
void    if_attachdomain(void);
void    if_deactivate(struct ifnet *);
bool    if_is_deactivated(const struct ifnet *);
void    if_export_if_data(struct ifnet *, struct if_data *, bool);
void    if_purgeaddrs(struct ifnet *, int, void (*)(struct ifaddr *));
void    if_detach(struct ifnet *);
void    if_down(struct ifnet *);
void    if_down_locked(struct ifnet *);
void    if_link_state_change(struct ifnet *, int);
void    if_domain_link_state_change(struct ifnet *, int);
void    if_up(struct ifnet *);
void    ifinit(void);
void    ifinit1(void);
void    ifinit_post(void);
int     ifaddrpref_ioctl(struct socket *, u_long, void *, struct ifnet *);
extern int (*ifioctl)(struct socket *, u_long, void *, struct lwp *);
int     ifioctl_common(struct ifnet *, u_long, void *);
int     ifpromisc(struct ifnet *, int);
int     ifpromisc_locked(struct ifnet *, int);
int     if_addr_init(ifnet_t *, struct ifaddr *, bool);
int     if_do_dad(struct ifnet *);
int     if_mcast_op(ifnet_t *, const unsigned long, const struct sockaddr *);
int     if_flags_set(struct ifnet *, const u_short);
int     if_clone_list(int, char *, int *);

int     if_ioctl(struct ifnet *, u_long, void *);
int     if_init(struct ifnet *);
void    if_stop(struct ifnet *, int);

struct  ifnet *ifunit(const char *);
struct  ifnet *if_get(const char *, struct psref *);
ifnet_t *if_byindex(u_int);
ifnet_t *_if_byindex(u_int);
ifnet_t *if_get_byindex(u_int, struct psref *);
ifnet_t *if_get_bylla(const void *, unsigned char, struct psref *);
void    if_put(const struct ifnet *, struct psref *);
void    if_acquire(struct ifnet *, struct psref *);
#define if_release      if_put

int if_tunnel_check_nesting(struct ifnet *, struct mbuf *, int);
percpu_t *if_tunnel_alloc_ro_percpu(void);
void if_tunnel_free_ro_percpu(percpu_t *);
void if_tunnel_ro_percpu_rtcache_free(percpu_t *);

struct tunnel_ro {
        struct route *tr_ro;
        kmutex_t *tr_lock;
};

static inline void
if_tunnel_get_ro(percpu_t *ro_percpu, struct route **ro, kmutex_t **lock)
{
        struct tunnel_ro *tro;

        tro = percpu_getref(ro_percpu);
        *ro = tro->tr_ro;
        *lock = tro->tr_lock;
        mutex_enter(*lock);
}

static inline void
if_tunnel_put_ro(percpu_t *ro_percpu, kmutex_t *lock)
{

        mutex_exit(lock);
        percpu_putref(ro_percpu);
}

static __inline if_index_t
if_get_index(const struct ifnet *ifp)
{

        return ifp != NULL ? ifp->if_index : 0;
}

bool    if_held(struct ifnet *);

void    if_input(struct ifnet *, struct mbuf *);

struct if_percpuq *
        if_percpuq_create(struct ifnet *);
void    if_percpuq_destroy(struct if_percpuq *);
void
        if_percpuq_enqueue(struct if_percpuq *, struct mbuf *);

void    if_deferred_start_init(struct ifnet *, void (*)(struct ifnet *));
void    if_schedule_deferred_start(struct ifnet *);

void ifa_insert(struct ifnet *, struct ifaddr *);
void ifa_remove(struct ifnet *, struct ifaddr *);

void    ifa_psref_init(struct ifaddr *);
void    ifa_acquire(struct ifaddr *, struct psref *);
void    ifa_release(struct ifaddr *, struct psref *);
bool    ifa_held(struct ifaddr *);
bool    ifa_is_destroying(struct ifaddr *);

void    ifaref(struct ifaddr *);
void    ifafree(struct ifaddr *);

struct  ifaddr *ifa_ifwithaddr(const struct sockaddr *);
struct  ifaddr *ifa_ifwithaddr_psref(const struct sockaddr *, struct psref *);
struct  ifaddr *ifa_ifwithdstaddr(const struct sockaddr *);
struct  ifaddr *ifa_ifwithdstaddr_psref(const struct sockaddr *,
            struct psref *);
struct  ifaddr *ifa_ifwithnet(const struct sockaddr *);
struct  ifaddr *ifa_ifwithnet_psref(const struct sockaddr *, struct psref *);
struct  ifaddr *ifa_ifwithladdr(const struct sockaddr *);
struct  ifaddr *ifa_ifwithladdr_psref(const struct sockaddr *, struct psref *);
struct  ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *);
struct  ifaddr *ifaof_ifpforaddr_psref(const struct sockaddr *, struct ifnet *,
            struct psref *);
void    link_rtrequest(int, struct rtentry *, const struct rt_addrinfo *);
void    p2p_rtrequest(int, struct rtentry *, const struct rt_addrinfo *);

struct ifaddr *if_first_addr(const struct ifnet *, const int);
struct ifaddr *if_first_addr_psref(const struct ifnet *, const int, struct psref *);

void    if_clone_attach(struct if_clone *);
void    if_clone_detach(struct if_clone *);

int     if_transmit_lock(struct ifnet *, struct mbuf *);

int     ifq_enqueue(struct ifnet *, struct mbuf *);
int     ifq_enqueue2(struct ifnet *, struct ifqueue *, struct mbuf *);

int     loioctl(struct ifnet *, u_long, void *);
void    loopattach(int);
void    loopinit(void);
int     looutput(struct ifnet *,
           struct mbuf *, const struct sockaddr *, const struct rtentry *);

void *  if_linkstate_change_establish(struct ifnet *,
            void (*)(void *), void *);
void    if_linkstate_change_disestablish(struct ifnet *,
            void *, kmutex_t *);

/*
 * These are exported because they're an easy way to tell if
 * an interface is going away without having to burn a flag.
 */
int     if_nulloutput(struct ifnet *, struct mbuf *,
            const struct sockaddr *, const struct rtentry *);
void    if_nullinput(struct ifnet *, struct mbuf *);
void    if_nullstart(struct ifnet *);
int     if_nulltransmit(struct ifnet *, struct mbuf *);
int     if_nullioctl(struct ifnet *, u_long, void *);
int     if_nullinit(struct ifnet *);
void    if_nullstop(struct ifnet *, int);
void    if_nullslowtimo(struct ifnet *);
#define if_nullwatchdog if_nullslowtimo
void    if_nulldrain(struct ifnet *);
#else
struct if_nameindex {
        unsigned int    if_index;       /* 1, 2, ... */
        char            *if_name;       /* null terminated name: "le0", ... */
};

#include <sys/cdefs.h>
__BEGIN_DECLS
unsigned int if_nametoindex(const char *);
char *  if_indextoname(unsigned int, char *);
struct  if_nameindex * if_nameindex(void);
void    if_freenameindex(struct if_nameindex *);
__END_DECLS
#endif /* _KERNEL */ /* XXX really ALTQ? */

#ifdef _KERNEL

#define IFADDR_FIRST(__ifp)             TAILQ_FIRST(&(__ifp)->if_addrlist)
#define IFADDR_NEXT(__ifa)              TAILQ_NEXT((__ifa), ifa_list)
#define IFADDR_FOREACH(__ifa, __ifp)    TAILQ_FOREACH(__ifa, \
                                            &(__ifp)->if_addrlist, ifa_list)
#define IFADDR_FOREACH_SAFE(__ifa, __ifp, __nifa) \
                                            TAILQ_FOREACH_SAFE(__ifa, \
                                            &(__ifp)->if_addrlist, ifa_list, __nifa)
#define IFADDR_EMPTY(__ifp)             TAILQ_EMPTY(&(__ifp)->if_addrlist)

#define IFADDR_ENTRY_INIT(__ifa)                                        \
        PSLIST_ENTRY_INIT((__ifa), ifa_pslist_entry)
#define IFADDR_ENTRY_DESTROY(__ifa)                                     \
        PSLIST_ENTRY_DESTROY((__ifa), ifa_pslist_entry)
#define IFADDR_READER_EMPTY(__ifp)                                      \
        (PSLIST_READER_FIRST(&(__ifp)->if_addr_pslist, struct ifaddr,   \
                             ifa_pslist_entry) == NULL)
#define IFADDR_READER_FIRST(__ifp)                                      \
        PSLIST_READER_FIRST(&(__ifp)->if_addr_pslist, struct ifaddr,    \
                            ifa_pslist_entry)
#define IFADDR_READER_NEXT(__ifa)                                       \
        PSLIST_READER_NEXT((__ifa), struct ifaddr, ifa_pslist_entry)
#define IFADDR_READER_FOREACH(__ifa, __ifp)                             \
        PSLIST_READER_FOREACH((__ifa), &(__ifp)->if_addr_pslist, struct ifaddr,\
                              ifa_pslist_entry)
#define IFADDR_WRITER_INSERT_HEAD(__ifp, __ifa)                         \
        PSLIST_WRITER_INSERT_HEAD(&(__ifp)->if_addr_pslist, (__ifa),    \
                                  ifa_pslist_entry)
#define IFADDR_WRITER_REMOVE(__ifa)                                     \
        PSLIST_WRITER_REMOVE((__ifa), ifa_pslist_entry)
#define IFADDR_WRITER_FOREACH(__ifa, __ifp)                             \
        PSLIST_WRITER_FOREACH((__ifa), &(__ifp)->if_addr_pslist, struct ifaddr,\
                              ifa_pslist_entry)
#define IFADDR_WRITER_NEXT(__ifp)                                       \
        PSLIST_WRITER_NEXT((__ifp), struct ifaddr, ifa_pslist_entry)
#define IFADDR_WRITER_INSERT_AFTER(__ifp, __new)                        \
        PSLIST_WRITER_INSERT_AFTER((__ifp), (__new), ifa_pslist_entry)
#define IFADDR_WRITER_EMPTY(__ifp)                                      \
        (PSLIST_WRITER_FIRST(&(__ifp)->if_addr_pslist, struct ifaddr,   \
                             ifa_pslist_entry) == NULL)
#define IFADDR_WRITER_INSERT_TAIL(__ifp, __new)                         \
        do {                                                            \
                if (IFADDR_WRITER_EMPTY(__ifp)) {                       \
                        IFADDR_WRITER_INSERT_HEAD((__ifp), (__new));    \
                } else {                                                \
                        struct ifaddr *__ifa;                           \
                        IFADDR_WRITER_FOREACH(__ifa, (__ifp)) {         \
                                if (IFADDR_WRITER_NEXT(__ifa) == NULL) {\
                                        IFADDR_WRITER_INSERT_AFTER(__ifa,\
                                            (__new));                   \
                                        break;                          \
                                }                                       \
                        }                                               \
                }                                                       \
        } while (0)

#define IFNET_GLOBAL_LOCK()                     mutex_enter(&ifnet_mtx)
#define IFNET_GLOBAL_UNLOCK()                   mutex_exit(&ifnet_mtx)
#define IFNET_GLOBAL_LOCKED()                   mutex_owned(&ifnet_mtx)

#define IFNET_READER_EMPTY() \
        (PSLIST_READER_FIRST(&ifnet_pslist, struct ifnet, if_pslist_entry) == NULL)
#define IFNET_READER_FIRST() \
        PSLIST_READER_FIRST(&ifnet_pslist, struct ifnet, if_pslist_entry)
#define IFNET_READER_NEXT(__ifp) \
        PSLIST_READER_NEXT((__ifp), struct ifnet, if_pslist_entry)
#define IFNET_READER_FOREACH(__ifp) \
        PSLIST_READER_FOREACH((__ifp), &ifnet_pslist, struct ifnet, \
                              if_pslist_entry)
#define IFNET_WRITER_INSERT_HEAD(__ifp) \
        PSLIST_WRITER_INSERT_HEAD(&ifnet_pslist, (__ifp), if_pslist_entry)
#define IFNET_WRITER_REMOVE(__ifp) \
        PSLIST_WRITER_REMOVE((__ifp), if_pslist_entry)
#define IFNET_WRITER_FOREACH(__ifp) \
        PSLIST_WRITER_FOREACH((__ifp), &ifnet_pslist, struct ifnet, \
                              if_pslist_entry)
#define IFNET_WRITER_NEXT(__ifp) \
        PSLIST_WRITER_NEXT((__ifp), struct ifnet, if_pslist_entry)
#define IFNET_WRITER_INSERT_AFTER(__ifp, __new) \
        PSLIST_WRITER_INSERT_AFTER((__ifp), (__new), if_pslist_entry)
#define IFNET_WRITER_EMPTY() \
        (PSLIST_WRITER_FIRST(&ifnet_pslist, struct ifnet, if_pslist_entry) == NULL)
#define IFNET_WRITER_INSERT_TAIL(__new)                                 \
        do {                                                            \
                if (IFNET_WRITER_EMPTY()) {                             \
                        IFNET_WRITER_INSERT_HEAD(__new);                \
                } else {                                                \
                        struct ifnet *__ifp;                            \
                        IFNET_WRITER_FOREACH(__ifp) {                   \
                                if (IFNET_WRITER_NEXT(__ifp) == NULL) { \
                                        IFNET_WRITER_INSERT_AFTER(__ifp,\
                                            (__new));                   \
                                        break;                          \
                                }                                       \
                        }                                               \
                }                                                       \
        } while (0)

#define IFNET_LOCK(ifp)         mutex_enter((ifp)->if_ioctl_lock)
#define IFNET_UNLOCK(ifp)       mutex_exit((ifp)->if_ioctl_lock)
#define IFNET_LOCKED(ifp)       mutex_owned((ifp)->if_ioctl_lock)

#define IFNET_ASSERT_UNLOCKED(ifp)      \
        KDASSERT(mutex_ownable((ifp)->if_ioctl_lock))

extern struct pslist_head ifnet_pslist;
extern kmutex_t ifnet_mtx;

extern struct ifnet *lo0ifp;

/*
 * ifq sysctl support
 */
int     sysctl_ifq(int *name, u_int namelen, void *oldp,
                       size_t *oldlenp, void *newp, size_t newlen,
                       struct ifqueue *ifq);
/* symbolic names for terminal (per-protocol) CTL_IFQ_ nodes */
#define IFQCTL_LEN      1
#define IFQCTL_MAXLEN   2
#define IFQCTL_PEAK     3
#define IFQCTL_DROPS    4

/*
 * Hook for if_vlan - needed by if_agr
 */
MODULE_HOOK(if_vlan_vlan_input_hook,
    struct mbuf *, (struct ifnet *, struct mbuf *));

#endif /* _KERNEL */

#endif /* !_NET_IF_H_ */