/*
 * 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.
 *
 *	From: @(#)if.h	8.1 (Berkeley) 6/10/93
 * $FreeBSD: src/sys/net/if_var.h,v 1.18.2.16 2003/04/15 18:11:19 fjoe Exp $
 */

#ifndef	_NET_IF_VAR_H_
#define	_NET_IF_VAR_H_

#ifndef _SYS_SERIALIZE_H_
#include <sys/serialize.h>
#endif
#ifndef _NET_IF_H_
#include <net/if.h>
#endif
#ifndef _SYS_MUTEX_H_
#include <sys/mutex.h>
#endif

/*
 * 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
 * the routine if_input. It is called with four parameters:
 *
 *	ifp->if_input(ifp, m, pi, cpuid)
 *
 * Here m is the mbuf chain to be received. The input routine removes the
 * protocol dependent header if necessary. A driver may also call using
 * custom struct pktinfo reference pi and a cpuid to take advantage of
 * hardware supplied information. Otherwise, the defaults for pi and cpuid
 * are as follows:
 *
 *	ifp->if_input(ifp, m, NULL, -1);
 *
 * 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
 */

/*
 * Forward structure declarations for function prototypes [sic].
 */
struct	rtentry;		/* ifa_rtrequest */
struct	socket;
struct	ucred;
struct	lwkt_serialize;
struct	ifaddr_container;
struct	ifaddr;
struct	pktinfo;
struct	ifpoll_info;
struct	ifdata_pcpu;

#include <sys/queue.h>		/* get TAILQ macros */

#include <net/altq/if_altq.h>

#ifdef _KERNEL
#include <sys/eventhandler.h>
#include <sys/mbuf.h>
#include <sys/thread2.h>
#endif /* _KERNEL */

#define IF_DUNIT_NONE   -1

/*
 * we use TAILQs so that the order of instantiation is preserved in
 * the list.
 */
TAILQ_HEAD(ifnethead, ifnet);
TAILQ_HEAD(ifaddrhead, ifaddr_container);
TAILQ_HEAD(ifmultihead, ifmultiaddr);
TAILQ_HEAD(ifgrouphead, ifg_group);

/*
 * Structure defining a mbuf queue.
 */
struct ifqueue {
	struct	mbuf *ifq_head;
	struct	mbuf *ifq_tail;
	int	ifq_len;
	int	ifq_maxlen;
	int	ifq_drops;
};

/*
 * Note of IFPOLL_ENABLE
 * 1) Any file(*.c) that depends on IFPOLL_ENABLE supports in this
 *    file should include opt_ifpoll.h at its beginning.
 * 2) When struct changes, which are conditioned by IFPOLL_ENABLE,
 *    are to be introduced, please keep the struct's size and layout
 *    same, no matter whether IFPOLL_ENABLE is defined or not.
 *    See ifnet.if_npoll and ifnet.if_npoll_unused for example.
 */

/*
 * Network serialize/deserialize types
 */
enum ifnet_serialize {
	IFNET_SERIALIZE_ALL	/* all serializers */
};

#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)

/*
 * Structure defining a network interface.
 *
 * (Would like to call this struct ``if'', but C isn't PL/1.)
 */

/*
 * NB: For DragonFlyBSD, it is assumed that each NIC driver's softc starts
 * with one of these structures, typically held within an arpcom structure.
 *
 *	struct <foo>_softc {
 *		struct arpcom {
 *			struct  ifnet ac_if;
 *			...
 *		} <arpcom> ;
 *		...
 *	};
 *
 * The assumption is used in a number of places, including many
 * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
 *
 * Unfortunately devices' softc are opaque, so we depend on this layout
 * to locate the struct ifnet from the softc in the generic code.
 *
 *
 *
 * MPSAFE NOTES:
 *
 * ifnet is protected by calling if_serialize, if_tryserialize and
 * if_deserialize serialize functions with the ifnet_serialize parameter.
 * Callers of if_ioctl, if_watchdog, if_init, if_resolvemulti, and if_npoll
 * should call the ifnet serialize functions with IFNET_SERIALIZE_ALL.
 *
 * if_snd subqueues are protected by its own serializers.  Callers of
 * if_start should call ifsq_serialiize_hw(), ifsq_deserialize_hw() and
 * ifsq_tryserialize_hw() to properly serialize hardware for transmission.
 *
 * Caller of if_output MUST NOT serialize ifnet or if_snd by calling
 * the related serialize functions.
 *
 * For better transmission performance, driver should setup if_snd subqueue
 * owner's cpuid properly using ifsq_set_cpuid() (or ifq_set_cpuid(), if not
 * multiple transmit queue capable).  Normally, the if_snd subqueue owner's
 * cpu is the one that processing the transmission interruption.  And in
 * driver, direct call of if_start should be avoided, use ifsq_devstart() or
 * ifsq_devstart_sched() instead (or if_devstart()/if_devstart_sched(), if
 * not multiple transmit queue capable).
 *
 *
 *
 * STATISTICS:
 *
 * if_data is no longer used to hold per interface statistics, so DO NOT use
 * the old style ifp->if_ipackets++ to update statistics; instead IFNET_STAT_
 * macros should be used.
 *
 *
 *
 * SINGLE SERIALIZER MODE:
 *
 * In this mode, driver MUST NOT setup if_serialize, if_deserialize,
 * if_tryserialize or if_serialize_assert.  Driver could supply its own
 * serializer to be used (through the type specific attach function, e.g.
 * ether_ifattach()) or it could depend on the default serializer.  In this
 * mode if_serializer will be setup properly.
 *
 * If a device driver installs the same serializer for its interrupt
 * as for ifnet, then the driver only really needs to worry about further
 * serialization in timeout based entry points and device_method_t entry
 * points.  All other entry points will already be serialized.
 *
 *
 *
 * MULTI SERIALIZERS MODE:
 *
 * In this mode, driver MUST setup if_serialize, if_deserialize,
 * if_tryserialize and if_serialize_assert.  Driver MUST NOT supply its own
 * serializer to be used.  In this mode, if_serializer will be left as NULL.
 * And driver MUST setup if_snd subqueues' hardware serailizer properly by
 * calling ifsq_set_hw_serialize().
 *
 *
 *
 * MULTIPLE TRANSMIT QUEUES:
 *
 * This should be implemented in "MULTI SERIALIZERS MODE".  Legacy if_watchdog
 * method SHOULD NOT be used.
 *
 * 1) Attach
 *
 * Before the type specific attach, e.g. ether_ifattach(), driver should
 * setup the transmit queue count and cpuid to subqueue mapping method
 * properly (assume QCOUNT is power of 2):
 *
 *	ifq_set_subq_cnt(&ifp->if_snd, QCOUNT);
 *	ifp->if_mapsubq = ifq_mapsubq_modulo;
 *	ifq_set_subq_divisor(&ifp->if_snd, QCOUNT);
 *
 * After the type specific attach, driver should setup the subqueues owner
 * cpu, serializer and watchdog properly:
 *
 *	for (i = 0; i < QCOUNT, ++i) {
 *		struct ifaltq_subque *ifsq = ifq_get_subq(&ifp->if_snd, i);
 *
 *		ifsq_set_cpuid(ifsq, Q_CPUID);
 *		ifsq_set_hw_serialize(ifsq, Q_SLIZE);
 *		ifsq_watchdog_init(Q_WDOG, ifsq, Q_WDOG_FUNC, IF_WDOG_FLAGS);
 *	}
 *
 * Q_CPUID, the cpu which handles the hardware transmit queue interrupt
 * Q_SLIZE, the serializer protects the hardware transmit queue
 * Q_WDOG, per hardware transmit queue watchdog handler, struct ifsubq_watchdog
 * Q_WDOG_FUNC, watchdog function, probably should reset hardware
 * IF_WDOG_FLAGS, various IF_WDOG_* flags (typically 0)
 *
 * The watchdog function is called on the 1->0 transition of wd_timer by
 * default.  Flags modify thiis behavior:
 *	IF_WDOG_ALLTICKS	Issue callback on all wd_timer transitions
 *	IF_WDOG_LASTTICK	Issue callback on 2->1 and 1->0
 *
 * 2) Stop
 *
 * Make sure per hardware transmit queue watchdog is stopped and oactive is
 * cleared:
 *
 *	for (i = 0; i < QCOUNT, ++i) {
 *		ifsq_clr_oactive(ifsq);
 *		ifsq_watchdog_stop(Q_WDOG);
 *	}
 *
 * 3) Initialize
 *
 * Make sure per hardware transmit queue watchdog is started and oactive is
 * cleared:
 *
 *	for (i = 0; i < QCOUNT, ++i) {
 *		ifsq_clr_oactive(ifsq);
 *		ifsq_watchdog_start(Q_WDOG);
 *	}
 *
 * 4) if_start
 *
 * if_start takes subqueue as parameter, so instead of using ifq_ functions
 * ifsq_ functions should be used.  If device could not be programmed to
 * transmit when no media link is not up, MAKE SURE to purge the subqueue:
 *
 *	if ((ifp->if_flags & IFF_RUNNING) == 0 || ifsq_is_oactive(ifsq))
 *		return;
 *	if (NO_LINK) {
 *		ifsq_purge(ifsq);
 *		return;
 *	}
 *	for (;;) {
 *		if (NO_FREE_DESC) {
 *			ifsq_set_oactive(ifsq);
 *			break;
 *		}
 *		m = ifsq_dequeue(ifsq);
 *		if (m != NULL)
 *			DRIVER_ENCAP(m);
 *		Q_WDOG.wd_timer = WDOG_TIMEOUT;
 *	}
 *
 * 5) Transmission done, e.g. transmit queue interrupt processing
 *
 * Same as if_start, ifsq_ functions should be used:
 *
 *	DRIVER_COLLECT_DESC();
 *	if (HAS_FREE_DESC)
 *		ifsq_clr_oactive(ifsq);
 *	if (NO_PENDING_DESC)
 *		Q_WDOG.wd_timer = 0;
 *	if (!ifsq_is_empty(ifsq))
 *		ifsq_devstart(ifsq);
 */
struct ifnet {
	void	*if_softc;		/* pointer to driver state */
	void	*if_l2com;		/* pointer to protocol bits */
	TAILQ_ENTRY(ifnet) if_link;	/* all struct ifnets are chained */
	char	if_xname[IFNAMSIZ];	/* external name (name + unit);
					 * can be renamed (SIOCSIFNAME) */
	const char *if_dname;		/* driver name */
	int	if_dunit;		/* unit or IF_DUNIT_NONE */
	void	*if_vlantrunks;		/* vlan trunks */
	struct	ifaddrhead *if_addrheads; /* per-cpu per-if addresses */
	int	if_pcount;		/* number of promiscuous listeners */
	void	*if_carp;		/* carp interfaces */
	struct	bpf_if *if_bpf;		/* packet filter structure */
	u_short	if_index;		/* numeric abbreviation for this if  */
	short	if_timer;		/* time 'til if_watchdog called */
	int	if_flags;		/* up/down, broadcast, etc. */
	int	if_capabilities;	/* interface capabilities */
	int	if_capenable;		/* enabled features */
	void	*if_linkmib;		/* link-type-specific MIB data */
	size_t	if_linkmiblen;		/* length of above data */
	struct	if_data if_data;	/* NOTE: stats are in if_data_pcpu */
	struct	ifmultihead if_multiaddrs; /* multicast addresses configured */
	int	if_amcount;		/* number of all-multicast requests */
	TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if;
					   * protected by 'ifgroup_lock' */

	/*
	 * procedure handlers
	 */
	int	(*if_output)		/* output routine (enqueue) */
		(struct ifnet *, struct mbuf *, struct sockaddr *,
		     struct rtentry *);
	void	(*if_input)		/* input routine from hardware driver */
		(struct ifnet *, struct mbuf *,
		     const struct pktinfo *pi, int cpuid);
	void	(*if_start)		/* initiate output routine */
		(struct ifnet *, struct ifaltq_subque *);
	int	(*if_ioctl)		/* ioctl routine */
		(struct ifnet *, u_long, caddr_t, struct ucred *);
	void	(*if_watchdog)		/* timer routine */
		(struct ifnet *);
	void	(*if_init)		/* init routine */
		(void *);
	int	(*if_resolvemulti)	/* validate/resolve multicast */
		(struct ifnet *, struct sockaddr **, struct sockaddr *);
	char	*if_description;	/* interface description */
	int	(*if_mapsubq)		/* cpuid to if_snd subqueue map */
		(struct ifaltq *, int);
	int	if_unused2;

	/*
	 * ifnet serialize functions
	 */
	void	(*if_serialize)
		(struct ifnet *, enum ifnet_serialize);
	void	(*if_deserialize)
		(struct ifnet *, enum ifnet_serialize);
	int	(*if_tryserialize)
		(struct ifnet *, enum ifnet_serialize);
#ifdef INVARIANTS
	void	(*if_serialize_assert)
		(struct ifnet *, enum ifnet_serialize, boolean_t);
#else
	/* Place holder */
	void	(*if_serialize_unused)(void);
#endif

#ifdef IFPOLL_ENABLE
	void	(*if_npoll)		/* polling config */
		(struct ifnet *, struct ifpoll_info *);
#else
	/* Place holder */
	void	(*if_npoll_unused)(void);
#endif
	int	if_tsolen;		/* max TSO length */
	struct	ifaltq if_snd;		/* output subqueues */
	const uint8_t	*if_broadcastaddr;
	void	*if_bridge;		/* bridge glue */
	void	*if_lagg;		/* lagg glue */
	void	*if_afdata[AF_MAX];
	struct ifaddr	*if_lladdr;

	/* serializer, in single serializer mode */
	struct lwkt_serialize *if_serializer;
	/*
	 * default serializer, in single serializer mode,
	 * if driver does not supply one
	 */
	struct lwkt_serialize if_default_serializer;

	int	if_unused4;
	struct ifdata_pcpu *if_data_pcpu; /* per-cpu stats */
	void	*if_pf_kif;		/* pf interface */

	/*
	 * Mbuf clusters/jclusters limits should be increased
	 * by if_nmbclusters/if_nmbjclusters.  Mainly for mbuf
	 * clusters/jclusters that could sit on the device
	 * queues, e.g. reception queues, for quite some time.
	 */
	int	if_nmbclusters;
	int	if_nmbjclusters;
};
typedef void if_init_f_t (void *);

#define	if_mtu		if_data.ifi_mtu
#define	if_type		if_data.ifi_type
#define	if_physical	if_data.ifi_physical
#define	if_addrlen	if_data.ifi_addrlen
#define	if_hdrlen	if_data.ifi_hdrlen
#define	if_metric	if_data.ifi_metric
#define	if_link_state	if_data.ifi_link_state
#define	if_baudrate	if_data.ifi_baudrate
#define	if_hwassist	if_data.ifi_hwassist
#define	if_ipackets	if_data.ifi_ipackets
#define	if_ierrors	if_data.ifi_ierrors
#define	if_opackets	if_data.ifi_opackets
#define	if_oerrors	if_data.ifi_oerrors
#define	if_collisions	if_data.ifi_collisions
#define	if_ibytes	if_data.ifi_ibytes
#define	if_obytes	if_data.ifi_obytes
#define	if_imcasts	if_data.ifi_imcasts
#define	if_omcasts	if_data.ifi_omcasts
#define	if_iqdrops	if_data.ifi_iqdrops
#define	if_noproto	if_data.ifi_noproto
#define	if_oqdrops	if_data.ifi_oqdrops
#define	if_lastchange	if_data.ifi_lastchange
#define	if_recvquota	if_data.ifi_recvquota
#define	if_xmitquota	if_data.ifi_xmitquota
#define	if_rawoutput(if, m, sa) if_output(if, m, sa, NULL)

/* for compatibility with other BSDs */
#define	if_list		if_link

/*
 * Per-cpu interface statistics
 */
struct ifdata_pcpu {
	u_long	ifd_ipackets;		/* packets received on interface */
	u_long	ifd_ierrors;		/* input errors on interface */
	u_long	ifd_opackets;		/* packets sent on interface */
	u_long	ifd_oerrors;		/* output errors on interface */
	u_long	ifd_collisions;		/* collisions on csma interfaces */
	u_long	ifd_ibytes;		/* total number of octets received */
	u_long	ifd_obytes;		/* total number of octets sent */
	u_long	ifd_imcasts;		/* packets received via multicast */
	u_long	ifd_omcasts;		/* packets sent via multicast */
	u_long	ifd_iqdrops;		/* dropped on input, this interface */
	u_long	ifd_noproto;		/* destined for unsupported protocol */
	u_long	ifd_oqdrops;		/* dropped on output, this interface */
} __cachealign;

#endif	/* _KERNEL || _KERNEL_STRUCTURES */

/*
 * ifqueue operation macros
 */
#define	IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
#define	IF_DROP(ifq)		((ifq)->ifq_drops++)
#define	IF_QLEN(ifq)		((ifq)->ifq_len)
#define	IF_QEMPTY(ifq)		(IF_QLEN(ifq) == 0)

#define	IF_ENQUEUE(ifq, m) do {						\
	(m)->m_nextpkt = NULL;						\
	if ((ifq)->ifq_tail == NULL)					\
		(ifq)->ifq_head = m;					\
	else								\
		(ifq)->ifq_tail->m_nextpkt = m;				\
	(ifq)->ifq_tail = m;						\
	(ifq)->ifq_len++;						\
} while (0)

#define	IF_PREPEND(ifq, m) do {						\
	(m)->m_nextpkt = (ifq)->ifq_head;				\
	if ((ifq)->ifq_tail == NULL)					\
		(ifq)->ifq_tail = (m);					\
	(ifq)->ifq_head = (m);						\
	(ifq)->ifq_len++;						\
} while (0)

#define	IF_DEQUEUE(ifq, m) do {						\
	(m) = (ifq)->ifq_head;						\
	if (m) {							\
		if (((ifq)->ifq_head = (m)->m_nextpkt) == NULL)		\
			(ifq)->ifq_tail = NULL;				\
		(m)->m_nextpkt = NULL;					\
		(ifq)->ifq_len--;					\
	}								\
} while (0)

#define	IF_POLL(ifq, m)		((m) = (ifq)->ifq_head)

#define IF_DRAIN(ifq) do {						\
	struct mbuf *m;							\
	while (1) {							\
		IF_DEQUEUE(ifq, m);					\
		if (m == NULL)						\
			break;						\
		m_freem(m);						\
	}								\
} while (0)

#ifdef _KERNEL

#ifdef INVARIANTS
#define ASSERT_IFNET_SERIALIZED_ALL(ifp) \
	(ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, TRUE)
#define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp) \
	(ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, FALSE)
#else
#define ASSERT_IFNET_SERIALIZED_ALL(ifp)	((void)0)
#define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp)	((void)0)
#endif

static __inline void
ifnet_serialize_all(struct ifnet *_ifp)
{
	_ifp->if_serialize(_ifp, IFNET_SERIALIZE_ALL);
}

static __inline void
ifnet_deserialize_all(struct ifnet *_ifp)
{
	_ifp->if_deserialize(_ifp, IFNET_SERIALIZE_ALL);
}

static __inline int
ifnet_tryserialize_all(struct ifnet *_ifp)
{
	return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_ALL);
}

/*
 * 72 was chosen below because it is the size of a TCP/IP
 * header (40) + the minimum mss (32).
 */
#define	IF_MINMTU	72
#define	IF_MAXMTU	65535

#endif /* _KERNEL */

struct in_ifaddr;

struct in_ifaddr_container {
	struct in_ifaddr	*ia;
	LIST_ENTRY(in_ifaddr_container) ia_hash;
				/* entry in bucket of inet addresses */
	TAILQ_ENTRY(in_ifaddr_container) ia_link;
				/* list of internet addresses */
	struct ifaddr_container	*ia_ifac; /* parent ifaddr_container */
};

/*
 * Per-cpu ifaddr container:
 * - per-cpu ifaddr reference count
 * - linkage to per-cpu addresses lists
 * - per-cpu ifaddr statistics
 */
struct ifaddr_container {
#define IFA_CONTAINER_MAGIC	0x19810219
#define IFA_CONTAINER_DEAD	0xc0dedead
	uint32_t		ifa_magic;  /* IFA_CONTAINER_MAGIC */
	struct ifaddr		*ifa;
	TAILQ_ENTRY(ifaddr_container)	ifa_link;   /* queue macro glue */
	u_int			ifa_refcnt; /* references to this structure */
	uint16_t		ifa_listmask;	/* IFA_LIST_ */
	uint16_t		ifa_prflags;	/* protocol specific flags */

	u_long			ifa_ipackets;	/* packets received on addr */
	u_long			ifa_ibytes;	/* bytes received on addr */
	u_long			ifa_opackets;	/* packets sent on addr */
	u_long			ifa_obytes;	/* bytes sent on addr */

	/*
	 * Protocol specific states
	 */
	union {
		struct in_ifaddr_container u_in_ifac;
	} ifa_proto_u;
} __cachealign;

#define IFA_LIST_IFADDRHEAD	0x01	/* on ifnet.if_addrheads[cpuid] */
#define IFA_LIST_IN_IFADDRHEAD	0x02	/* on in_ifaddrheads[cpuid] */
#define IFA_LIST_IN_IFADDRHASH	0x04	/* on in_ifaddrhashtbls[cpuid] */

#define IFA_PRF_FLAG0		0x01
#define IFA_PRF_FLAG1		0x02
#define IFA_PRF_FLAG2		0x04
#define IFA_PRF_FLAG3		0x08

/*
 * 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.
 *
 * NOTE:
 * Statistics are no longer stored in if_data, instead, they are stored
 * in the per-cpu ifaddr_container.  So don't use the old style
 * ifa->if_ipackets++ to update statistics, use IFA_STAT_ macros.
 */
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	if_data if_data;	/* not all members are meaningful */
	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
	void	*ifa_link_pad;
	struct ifaddr_container *ifa_containers; /* per-cpu data */
	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
		(int, struct rtentry *);
	u_short	ifa_flags;		/* mostly rt_flags for cloning */
	int	ifa_ncnt;		/* # of valid ifaddr_container */
	int	ifa_metric;		/* cost of going out this interface */
#ifdef notdef
	struct	rtentry *ifa_rt;	/* XXXX for ROUTETOIF ????? */
#endif
	int	(*ifa_claim_addr)	/* check if an addr goes to this if */
		(struct ifaddr *, struct sockaddr *);
};

#define	IFA_ROUTE	RTF_UP		/* route installed */

/* for compatibility with other BSDs */
#define	ifa_list	ifa_link

/*
 * Multicast address structure.  This is analogous to the ifaddr
 * structure except that it keeps track of multicast addresses.
 * Also, the reference count here is a count of requests for this
 * address, not a count of pointers to this structure.
 */
struct ifmultiaddr {
	TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
	struct	sockaddr *ifma_addr;	/* address this membership is for */
	struct	sockaddr *ifma_lladdr;	/* link-layer translation, if any */
	struct	ifnet *ifma_ifp;	/* back-pointer to interface */
	u_int	ifma_refcount;		/* reference count */
	void	*ifma_protospec;	/* protocol-specific state, if any */
};

#ifdef _KERNEL

struct ifaddr_marker {
	struct ifaddr		ifa;
	struct ifaddr_container	ifac;
	struct sockaddr		addr;
	struct sockaddr		netmask;
	struct sockaddr		dstaddr;
};

/*
 * ifaddr statistics update macro
 */
#define IFA_STAT_INC(ifa, name, v) \
do { \
	(ifa)->ifa_containers[mycpuid].ifa_##name += (v); \
} while (0)

/*
 * Interface (ifnet) statistics update macros
 */
#define IFNET_STAT_INC(ifp, name, v) \
do { \
	(ifp)->if_data_pcpu[mycpuid].ifd_##name += (v); \
} while (0)

#define IFNET_STAT_SET(ifp, name, v) \
do { \
	int _cpu; \
	(ifp)->if_data_pcpu[0].ifd_##name = (v); \
	for (_cpu = 1; _cpu < ncpus; ++_cpu) \
		(ifp)->if_data_pcpu[_cpu].ifd_##name = 0; \
} while (0)

#define IFNET_STAT_GET(ifp, name, v) \
do { \
	int _cpu; \
	(v) = (ifp)->if_data_pcpu[0].ifd_##name; \
	for (_cpu = 1; _cpu < ncpus; ++_cpu) \
		(v) += (ifp)->if_data_pcpu[_cpu].ifd_##name; \
} while (0)


enum ifaddr_event {
	IFADDR_EVENT_ADD,
	IFADDR_EVENT_DELETE,
	IFADDR_EVENT_CHANGE
};

/* interface address change event */
typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *,
	enum ifaddr_event, struct ifaddr *);
EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
/* interface link layer address change event */
typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
/* new interface attach event */
typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *);
EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t);
/* interface detach event */
typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *);
EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t);
/* Interface link state change event */
typedef void (*ifnet_link_event_handler_t)(void *, struct ifnet *, int);
EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t);
/* Interface up/down event */
#define IFNET_EVENT_UP		0
#define IFNET_EVENT_DOWN	1
typedef void (*ifnet_event_fn)(void *, struct ifnet *ifp, int event);
EVENTHANDLER_DECLARE(ifnet_event, ifnet_event_fn);

/* Array of all ifnets in the system */
struct ifnet_array {
	int		ifnet_count;	/* # of elem. in ifnet_arr */
	int		ifnet_pad;	/* explicit */
	struct ifnet	*ifnet_arr[];
};

/*
 * interface groups
 */
struct ifg_group {
	char			 ifg_group[IFNAMSIZ];
	u_int			 ifg_refcnt;
	void			*ifg_pf_kif;
	int			 ifg_carp_demoted;
	TAILQ_HEAD(, ifg_member) ifg_members;
	TAILQ_ENTRY(ifg_group)	 ifg_next;
};

struct ifg_member {
	TAILQ_ENTRY(ifg_member)	 ifgm_next;
	struct ifnet		*ifgm_ifp;
};

struct ifg_list {
	struct ifg_group	*ifgl_group;
	TAILQ_ENTRY(ifg_list)	 ifgl_next;
};

/* group attach event */
typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
/* group detach event */
typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
/* group change event */
typedef void (*group_change_event_handler_t)(void *, const char *);
EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);


#ifdef INVARIANTS
#define ASSERT_IFAC_VALID(ifac)	do { \
	KKASSERT((ifac)->ifa_magic == IFA_CONTAINER_MAGIC); \
	KKASSERT((ifac)->ifa_refcnt > 0); \
} while (0)
#else
#define ASSERT_IFAC_VALID(ifac)	((void)0)
#endif

static __inline void
_IFAREF(struct ifaddr *_ifa, int _cpu_id)
{
	struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];

	crit_enter();
	ASSERT_IFAC_VALID(_ifac);
	++_ifac->ifa_refcnt;
	crit_exit();
}

static __inline void
IFAREF(struct ifaddr *_ifa)
{
	_IFAREF(_ifa, mycpuid);
}

#include <sys/serialize2.h>

#ifdef MALLOC_DECLARE
MALLOC_DECLARE(M_IFADDR);
MALLOC_DECLARE(M_IFMADDR);
MALLOC_DECLARE(M_IFNET);
#endif

void	ifac_free(struct ifaddr_container *, int);

static __inline void
_IFAFREE(struct ifaddr *_ifa, int _cpu_id)
{
	struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];

	crit_enter();
	ASSERT_IFAC_VALID(_ifac);
	if (--_ifac->ifa_refcnt == 0)
		ifac_free(_ifac, _cpu_id);
	crit_exit();
}

static __inline void
IFAFREE(struct ifaddr *_ifa)
{
	_IFAFREE(_ifa, mycpuid);
}

static __inline void
ifnet_serialize_array_enter(lwkt_serialize_t *_arr, int _arrcnt,
    enum ifnet_serialize _slz)
{
	KKASSERT(_slz == IFNET_SERIALIZE_ALL);
	lwkt_serialize_array_enter(_arr, _arrcnt, 0);
}

static __inline void
ifnet_serialize_array_exit(lwkt_serialize_t *_arr, int _arrcnt,
    enum ifnet_serialize _slz)
{
	KKASSERT(_slz == IFNET_SERIALIZE_ALL);
	lwkt_serialize_array_exit(_arr, _arrcnt, 0);
}

static __inline int
ifnet_serialize_array_try(lwkt_serialize_t *_arr, int _arrcnt,
    enum ifnet_serialize _slz)
{
	KKASSERT(_slz == IFNET_SERIALIZE_ALL);
	return lwkt_serialize_array_try(_arr, _arrcnt, 0);
}

#ifdef INVARIANTS

static __inline void
ifnet_serialize_array_assert(lwkt_serialize_t *_arr, int _arrcnt,
    enum ifnet_serialize _slz, boolean_t _serialized)
{
	int _i;

	KKASSERT(_slz == IFNET_SERIALIZE_ALL);
	if (_serialized) {
		for (_i = 0; _i < _arrcnt; ++_i)
			ASSERT_SERIALIZED(_arr[_i]);
	} else {
		for (_i = 0; _i < _arrcnt; ++_i)
			ASSERT_NOT_SERIALIZED(_arr[_i]);
	}
}

#endif	/* INVARIANTS */

#define REINPUT_KEEPRCVIF	0x0001	/* ether_reinput_oncpu() */
#define REINPUT_RUNBPF 		0x0002	/* ether_reinput_oncpu() */

/*
 * MPSAFE NOTE for ifnet queue (ifnet), ifnet array, ifunit() and
 * ifindex2ifnet.
 *
 * - ifnet queue must only be accessed by non-netisr threads and
 *   ifnet lock must be held (by ifnet_lock()).
 * - If accessing ifnet queue is needed in netisrs, ifnet array
 *   (obtained through ifnet_array_get()) must be used instead.
 *   There is no need to (must not, actually) hold ifnet lock for
 *   ifnet array accessing.
 * - ifindex2ifnet could be accessed by both non-netisr threads and
 *   netisrs.  Accessing ifindex2ifnet in non-netisr threads must be
 *   protected by ifnet lock (by ifnet_lock()).  Accessing
 *   ifindex2ifnet in netisrs is lockless MPSAFE and ifnet lock must
 *   not be held.  However, ifindex2ifnet should be saved in a stack
 *   variable to get a consistent view of ifindex2ifnet, if
 *   ifindex2ifnet is accessed multiple times from a function in
 *   netisrs.
 * - ifunit() must only be called in non-netisr threads and ifnet
 *   lock must be held before calling this function and for the
 *   accessing of the ifp returned by this function.
 * - If ifunit() is needed in netisr, ifunit_netisr() must be used
 *   instead.  There is no need to (must not, actually) hold ifnet
 *   lock for ifunit_netisr() and the returned ifp.
 */
extern struct ifnethead	ifnet;
#define ifnetlist	ifnet	/* easily distinguished ifnet alias */

extern struct ifnet	**ifindex2ifnet;
extern int		if_index;

struct ifnet		*ifunit(const char *);
struct ifnet		*ifunit_netisr(const char *);
const struct ifnet_array *ifnet_array_get(void);
int			ifnet_array_isempty(void);

extern int ifqmaxlen;
extern struct ifnet *loif;  /* first loopback interface */
extern struct ifgrouphead ifg_head;

struct ip;
struct tcphdr;

void	ether_ifattach(struct ifnet *, const uint8_t *,
	    struct lwkt_serialize *);
void	ether_ifattach_bpf(struct ifnet *, const uint8_t *, u_int, u_int,
	    struct lwkt_serialize *);
void	ether_ifdetach(struct ifnet *);
void	ether_demux(struct mbuf *);
void	ether_demux_oncpu(struct ifnet *, struct mbuf *);
void	ether_reinput_oncpu(struct ifnet *, struct mbuf *, int);
void	ether_input(struct ifnet *, struct mbuf *,
	    const struct pktinfo *, int);
int	ether_output_frame(struct ifnet *, struct mbuf *);
int	ether_ioctl(struct ifnet *, u_long, caddr_t);
u_char	*kether_aton(const char *, u_char *);
char	*kether_ntoa(const u_char *, char *);
struct ifnet *ether_bridge_interface(struct ifnet *ifp);
uint32_t	ether_crc32_le(const uint8_t *, size_t);
uint32_t	ether_crc32_be(const uint8_t *, size_t);

int	if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
int	if_addmulti_serialized(struct ifnet *, struct sockaddr *,
	    struct ifmultiaddr **);
int	if_allmulti(struct ifnet *, int);
void	if_attach(struct ifnet *, struct lwkt_serialize *);
int	if_delmulti(struct ifnet *, struct sockaddr *);
void	if_delallmulti_serialized(struct ifnet *ifp);
void	if_purgeaddrs_nolink(struct ifnet *);
void	if_detach(struct ifnet *);
void	if_down(struct ifnet *);
void	if_link_state_change(struct ifnet *);
void	if_initname(struct ifnet *, const char *, int);
int	if_getanyethermac(uint16_t *, int);
int	if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
struct ifnet *if_alloc(uint8_t);
void	if_free(struct ifnet *);
int	if_setlladdr(struct ifnet *, const u_char *, int);
int	if_tunnel_check_nesting(struct ifnet *, struct mbuf *, uint32_t, int);
struct ifnet *if_bylla(const void *, unsigned char);
void	if_up(struct ifnet *);
/*void	ifinit(void);*/ /* declared in systm.h for main() */
int	ifioctl(struct socket *, u_long, caddr_t, struct ucred *);
int	ifpromisc(struct ifnet *, int);

int	ifgroup_lockmgr(u_int flags);
int	if_addgroup(struct ifnet *, const char *);
int	if_delgroup(struct ifnet *, const char *);

int	ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
int	ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);

struct	ifaddr *ifa_ifwithaddr(struct sockaddr *);
struct	ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
struct	ifaddr *ifa_ifwithnet(struct sockaddr *);
struct	ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
struct	ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);

typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
typedef void if_com_free_t(void *com, u_char type);
void	if_register_com_alloc(u_char, if_com_alloc_t *a, if_com_free_t *);
void	if_deregister_com_alloc(u_char);

void	*ifa_create(int);
void	ifa_destroy(struct ifaddr *);
void	ifa_iflink(struct ifaddr *, struct ifnet *, int);
void	ifa_ifunlink(struct ifaddr *, struct ifnet *);
void	ifa_marker_init(struct ifaddr_marker *, struct ifnet *);

struct	ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
int	if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
void	if_devstart(struct ifnet *ifp); /* COMPAT */
void	if_devstart_sched(struct ifnet *ifp); /* COMPAT */

void	ifnet_lock(void);
void	ifnet_unlock(void);

#define IF_LLSOCKADDR(ifp)	\
	((struct sockaddr_dl *)(ifp)->if_lladdr->ifa_addr)
#define IF_LLADDR(ifp)	LLADDR(IF_LLSOCKADDR(ifp))

#ifdef IFPOLL_ENABLE
int	ifpoll_register(struct ifnet *);
int	ifpoll_deregister(struct ifnet *);
#endif	/* IFPOLL_ENABLE */

#endif /* _KERNEL */

#endif /* !_NET_IF_VAR_H_ */
