Home | History | Annotate | Line # | Download | only in net
if.h revision 1.84
      1 /*	$NetBSD: if.h,v 1.84 2003/02/01 06:23:46 thorpej Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1999, 2000, 2001 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by William Studnemund and Jason R. Thorpe.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  * 3. All advertising materials mentioning features or use of this software
     19  *    must display the following acknowledgement:
     20  *	This product includes software developed by the NetBSD
     21  *	Foundation, Inc. and its contributors.
     22  * 4. Neither the name of The NetBSD Foundation nor the names of its
     23  *    contributors may be used to endorse or promote products derived
     24  *    from this software without specific prior written permission.
     25  *
     26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36  * POSSIBILITY OF SUCH DAMAGE.
     37  */
     38 
     39 /*
     40  * Copyright (c) 1982, 1986, 1989, 1993
     41  *	The Regents of the University of California.  All rights reserved.
     42  *
     43  * Redistribution and use in source and binary forms, with or without
     44  * modification, are permitted provided that the following conditions
     45  * are met:
     46  * 1. Redistributions of source code must retain the above copyright
     47  *    notice, this list of conditions and the following disclaimer.
     48  * 2. Redistributions in binary form must reproduce the above copyright
     49  *    notice, this list of conditions and the following disclaimer in the
     50  *    documentation and/or other materials provided with the distribution.
     51  * 3. All advertising materials mentioning features or use of this software
     52  *    must display the following acknowledgement:
     53  *	This product includes software developed by the University of
     54  *	California, Berkeley and its contributors.
     55  * 4. Neither the name of the University nor the names of its contributors
     56  *    may be used to endorse or promote products derived from this software
     57  *    without specific prior written permission.
     58  *
     59  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     60  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     61  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     62  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     63  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     64  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     65  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     66  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     67  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     68  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     69  * SUCH DAMAGE.
     70  *
     71  *	@(#)if.h	8.3 (Berkeley) 2/9/95
     72  */
     73 
     74 #ifndef _NET_IF_H_
     75 #define _NET_IF_H_
     76 
     77 #if !defined(_XOPEN_SOURCE)
     78 
     79 #include <sys/socket.h>
     80 #include <sys/queue.h>
     81 #include <net/dlt.h>
     82 #include <net/pfil.h>
     83 
     84 /*
     85  * Always include ALTQ glue here -- we use the ALTQ interface queue
     86  * structure even when ALTQ is not configured into the kernel so that
     87  * the size of struct ifnet does not changed based on the option.  The
     88  * ALTQ queue structure is API-compatible with the legacy ifqueue.
     89  */
     90 #include <altq/if_altq.h>
     91 
     92 /*
     93  * Structures defining a network interface, providing a packet
     94  * transport mechanism (ala level 0 of the PUP protocols).
     95  *
     96  * Each interface accepts output datagrams of a specified maximum
     97  * length, and provides higher level routines with input datagrams
     98  * received from its medium.
     99  *
    100  * Output occurs when the routine if_output is called, with four parameters:
    101  *	(*ifp->if_output)(ifp, m, dst, rt)
    102  * Here m is the mbuf chain to be sent and dst is the destination address.
    103  * The output routine encapsulates the supplied datagram if necessary,
    104  * and then transmits it on its medium.
    105  *
    106  * On input, each interface unwraps the data received by it, and either
    107  * places it on the input queue of a internetwork datagram routine
    108  * and posts the associated software interrupt, or passes the datagram to a raw
    109  * packet input routine.
    110  *
    111  * Routines exist for locating interfaces by their addresses
    112  * or for locating a interface on a certain network, as well as more general
    113  * routing and gateway routines maintaining information used to locate
    114  * interfaces.  These routines live in the files if.c and route.c
    115  */
    116 /*  XXX fast fix for SNMP, going away soon */
    117 #include <sys/time.h>
    118 
    119 #if defined(_KERNEL_OPT)
    120 #include "opt_compat_netbsd.h"
    121 #endif
    122 
    123 struct mbuf;
    124 struct proc;
    125 struct rtentry;
    126 struct socket;
    127 struct ether_header;
    128 struct ifnet;
    129 struct rt_addrinfo;
    130 
    131 /*
    132  * Length of interface external name, including terminating '\0'.
    133  * Note: this is the same size as a generic device's external name.
    134  */
    135 #define	IFNAMSIZ	16
    136 #define	IF_NAMESIZE	IFNAMSIZ
    137 
    138 /*
    139  * Structure describing a `cloning' interface.
    140  */
    141 struct if_clone {
    142 	LIST_ENTRY(if_clone) ifc_list;	/* on list of cloners */
    143 	const char *ifc_name;		/* name of device, e.g. `gif' */
    144 	size_t ifc_namelen;		/* length of name */
    145 
    146 	int	(*ifc_create)(struct if_clone *, int);
    147 	void	(*ifc_destroy)(struct ifnet *);
    148 };
    149 
    150 #define	IF_CLONE_INITIALIZER(name, create, destroy)			\
    151 	{ { 0 }, name, sizeof(name) - 1, create, destroy }
    152 
    153 /*
    154  * Structure used to query names of interface cloners.
    155  */
    156 struct if_clonereq {
    157 	int	ifcr_total;		/* total cloners (out) */
    158 	int	ifcr_count;		/* room for this many in user buffer */
    159 	char	*ifcr_buffer;		/* buffer for cloner names */
    160 };
    161 
    162 /*
    163  * Structure defining statistics and other data kept regarding a network
    164  * interface.
    165  */
    166 struct if_data {
    167 	/* generic interface information */
    168 	u_char	ifi_type;		/* ethernet, tokenring, etc. */
    169 	u_char	ifi_addrlen;		/* media address length */
    170 	u_char	ifi_hdrlen;		/* media header length */
    171 	int	ifi_link_state;		/* current link state */
    172 	u_quad_t ifi_mtu;		/* maximum transmission unit */
    173 	u_quad_t ifi_metric;		/* routing metric (external only) */
    174 	u_quad_t ifi_baudrate;		/* linespeed */
    175 	/* volatile statistics */
    176 	u_quad_t ifi_ipackets;		/* packets received on interface */
    177 	u_quad_t ifi_ierrors;		/* input errors on interface */
    178 	u_quad_t ifi_opackets;		/* packets sent on interface */
    179 	u_quad_t ifi_oerrors;		/* output errors on interface */
    180 	u_quad_t ifi_collisions;	/* collisions on csma interfaces */
    181 	u_quad_t ifi_ibytes;		/* total number of octets received */
    182 	u_quad_t ifi_obytes;		/* total number of octets sent */
    183 	u_quad_t ifi_imcasts;		/* packets received via multicast */
    184 	u_quad_t ifi_omcasts;		/* packets sent via multicast */
    185 	u_quad_t ifi_iqdrops;		/* dropped on input, this interface */
    186 	u_quad_t ifi_noproto;		/* destined for unsupported protocol */
    187 	struct	timeval ifi_lastchange;	/* last operational state change */
    188 };
    189 
    190 /*
    191  * Values for if_link_state.
    192  */
    193 #define	LINK_STATE_UNKNOWN	0	/* link invalid/unknown */
    194 #define	LINK_STATE_DOWN		1	/* link is down */
    195 #define	LINK_STATE_UP		2	/* link is up */
    196 
    197 #if defined(_KERNEL) && defined(COMPAT_14)
    198 /* Pre-1.5 if_data struct */
    199 struct if_data14 {
    200 	/* generic interface information */
    201 	u_char	ifi_type;		/* ethernet, tokenring, etc. */
    202 	u_char	ifi_addrlen;		/* media address length */
    203 	u_char	ifi_hdrlen;		/* media header length */
    204 	u_long	ifi_mtu;		/* maximum transmission unit */
    205 	u_long	ifi_metric;		/* routing metric (external only) */
    206 	u_long	ifi_baudrate;		/* linespeed */
    207 	/* volatile statistics */
    208 	u_long	ifi_ipackets;		/* packets received on interface */
    209 	u_long	ifi_ierrors;		/* input errors on interface */
    210 	u_long	ifi_opackets;		/* packets sent on interface */
    211 	u_long	ifi_oerrors;		/* output errors on interface */
    212 	u_long	ifi_collisions;		/* collisions on csma interfaces */
    213 	u_long	ifi_ibytes;		/* total number of octets received */
    214 	u_long	ifi_obytes;		/* total number of octets sent */
    215 	u_long	ifi_imcasts;		/* packets received via multicast */
    216 	u_long	ifi_omcasts;		/* packets sent via multicast */
    217 	u_long	ifi_iqdrops;		/* dropped on input, this interface */
    218 	u_long	ifi_noproto;		/* destined for unsupported protocol */
    219 	struct	timeval ifi_lastchange;	/* last operational state change */
    220 };
    221 #endif /* _KERNEL && COMPAT_14 */
    222 
    223 /*
    224  * Structure defining a queue for a network interface.
    225  */
    226 struct ifqueue {
    227 	struct	mbuf *ifq_head;
    228 	struct	mbuf *ifq_tail;
    229 	int	ifq_len;
    230 	int	ifq_maxlen;
    231 	int	ifq_drops;
    232 };
    233 
    234 /*
    235  * Structure defining a queue for a network interface.
    236  *
    237  * (Would like to call this struct ``if'', but C isn't PL/1.)
    238  */
    239 TAILQ_HEAD(ifnet_head, ifnet);		/* the actual queue head */
    240 
    241 struct ifnet {				/* and the entries */
    242 	void	*if_softc;		/* lower-level data for this if */
    243 	TAILQ_ENTRY(ifnet) if_list;	/* all struct ifnets are chained */
    244 	TAILQ_HEAD(, ifaddr) if_addrlist; /* linked list of addresses per if */
    245 	char	if_xname[IFNAMSIZ];	/* external name (name + unit) */
    246 	int	if_pcount;		/* number of promiscuous listeners */
    247 	caddr_t	if_bpf;			/* packet filter structure */
    248 	u_short	if_index;		/* numeric abbreviation for this if */
    249 	short	if_timer;		/* time 'til if_watchdog called */
    250 	short	if_flags;		/* up/down, broadcast, etc. */
    251 	short	if__pad1;		/* be nice to m68k ports */
    252 	struct	if_data if_data;	/* statistics and other data about if */
    253 	/*
    254 	 * Procedure handles.  If you add more of these, don't forget the
    255 	 * corresponding NULL stub in if.c.
    256 	 */
    257 	int	(*if_output)		/* output routine (enqueue) */
    258 		__P((struct ifnet *, struct mbuf *, struct sockaddr *,
    259 		     struct rtentry *));
    260 	void	(*if_input)		/* input routine (from h/w driver) */
    261 		__P((struct ifnet *, struct mbuf *));
    262 	void	(*if_start)		/* initiate output routine */
    263 		__P((struct ifnet *));
    264 	int	(*if_ioctl)		/* ioctl routine */
    265 		__P((struct ifnet *, u_long, caddr_t));
    266 	int	(*if_init)		/* init routine */
    267 		__P((struct ifnet *));
    268 	void	(*if_stop)		/* stop routine */
    269 		__P((struct ifnet *, int));
    270 	void	(*if_watchdog)		/* timer routine */
    271 		__P((struct ifnet *));
    272 	void	(*if_drain)		/* routine to release resources */
    273 		__P((struct ifnet *));
    274 	struct ifaltq if_snd;		/* output queue (includes altq) */
    275 	struct	sockaddr_dl *if_sadl;	/* pointer to our sockaddr_dl */
    276 	u_int8_t *if_broadcastaddr;	/* linklevel broadcast bytestring */
    277 	void	*if_bridge;		/* bridge glue */
    278 	int	if_dlt;			/* data link type (<net/dlt.h>) */
    279 	struct pfil_head if_pfil;	/* filtering point */
    280 	uint64_t if_capabilities;	/* interface capabilities */
    281 	uint64_t if_capenable;		/* capabilities enabled */
    282 
    283 	/*
    284 	 * These are pre-computed based on an interfaces enabled
    285 	 * capabilities, for speed elsewhere.
    286 	 */
    287 	int	if_csum_flags_tx;	/* M_CSUM_* flags for Tx */
    288 	int	if_csum_flags_rx;	/* M_CSUM_* flags for Rx */
    289 
    290 	void	*if_afdata[AF_MAX];
    291 };
    292 #define	if_mtu		if_data.ifi_mtu
    293 #define	if_type		if_data.ifi_type
    294 #define	if_addrlen	if_data.ifi_addrlen
    295 #define	if_hdrlen	if_data.ifi_hdrlen
    296 #define	if_metric	if_data.ifi_metric
    297 #define	if_link_state	if_data.ifi_link_state
    298 #define	if_baudrate	if_data.ifi_baudrate
    299 #define	if_ipackets	if_data.ifi_ipackets
    300 #define	if_ierrors	if_data.ifi_ierrors
    301 #define	if_opackets	if_data.ifi_opackets
    302 #define	if_oerrors	if_data.ifi_oerrors
    303 #define	if_collisions	if_data.ifi_collisions
    304 #define	if_ibytes	if_data.ifi_ibytes
    305 #define	if_obytes	if_data.ifi_obytes
    306 #define	if_imcasts	if_data.ifi_imcasts
    307 #define	if_omcasts	if_data.ifi_omcasts
    308 #define	if_iqdrops	if_data.ifi_iqdrops
    309 #define	if_noproto	if_data.ifi_noproto
    310 #define	if_lastchange	if_data.ifi_lastchange
    311 
    312 #define	IFF_UP		0x0001		/* interface is up */
    313 #define	IFF_BROADCAST	0x0002		/* broadcast address valid */
    314 #define	IFF_DEBUG	0x0004		/* turn on debugging */
    315 #define	IFF_LOOPBACK	0x0008		/* is a loopback net */
    316 #define	IFF_POINTOPOINT	0x0010		/* interface is point-to-point link */
    317 #define	IFF_NOTRAILERS	0x0020		/* avoid use of trailers */
    318 #define	IFF_RUNNING	0x0040		/* resources allocated */
    319 #define	IFF_NOARP	0x0080		/* no address resolution protocol */
    320 #define	IFF_PROMISC	0x0100		/* receive all packets */
    321 #define	IFF_ALLMULTI	0x0200		/* receive all multicast packets */
    322 #define	IFF_OACTIVE	0x0400		/* transmission in progress */
    323 #define	IFF_SIMPLEX	0x0800		/* can't hear own transmissions */
    324 #define	IFF_LINK0	0x1000		/* per link layer defined bit */
    325 #define	IFF_LINK1	0x2000		/* per link layer defined bit */
    326 #define	IFF_LINK2	0x4000		/* per link layer defined bit */
    327 #define	IFF_MULTICAST	0x8000		/* supports multicast */
    328 
    329 /* flags set internally only: */
    330 #define	IFF_CANTCHANGE \
    331 	(IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
    332 	    IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC)
    333 
    334 /*
    335  * Some convenience macros used for setting ifi_baudrate.
    336  * XXX 1000 vs. 1024? --thorpej (at) netbsd.org
    337  */
    338 #define	IF_Kbps(x)	((x) * 1000)		/* kilobits/sec. */
    339 #define	IF_Mbps(x)	(IF_Kbps((x) * 1000))	/* megabits/sec. */
    340 #define	IF_Gbps(x)	(IF_Mbps((x) * 1000))	/* gigabits/sec. */
    341 
    342 /* Capabilities that interfaces can advertise. */
    343 #define	IFCAP_CSUM_IPv4		0x0001	/* can do IPv4 header checksums */
    344 #define	IFCAP_CSUM_TCPv4	0x0002	/* can do IPv4/TCP checksums */
    345 #define	IFCAP_CSUM_UDPv4	0x0004	/* can do IPv4/UDP checksums */
    346 #define	IFCAP_CSUM_TCPv6	0x0008	/* can do IPv6/TCP checksums */
    347 #define	IFCAP_CSUM_UDPv6	0x0010	/* can do IPv6/UDP checksums */
    348 #define	IFCAP_CSUM_TCPv4_Rx	0x0020	/* can do IPv4/TCP (Rx only) */
    349 #define	IFCAP_CSUM_UDPv4_Rx	0x0040	/* can do IPv4/UDP (Rx only) */
    350 
    351 /*
    352  * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
    353  * input routines have queues of messages stored on ifqueue structures
    354  * (defined above).  Entries are added to and deleted from these structures
    355  * by these macros, which should be called with ipl raised to splnet().
    356  */
    357 #define	IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
    358 #define	IF_DROP(ifq)		((ifq)->ifq_drops++)
    359 #define	IF_ENQUEUE(ifq, m) { \
    360 	(m)->m_nextpkt = 0; \
    361 	if ((ifq)->ifq_tail == 0) \
    362 		(ifq)->ifq_head = m; \
    363 	else \
    364 		(ifq)->ifq_tail->m_nextpkt = m; \
    365 	(ifq)->ifq_tail = m; \
    366 	(ifq)->ifq_len++; \
    367 }
    368 #define	IF_PREPEND(ifq, m) { \
    369 	(m)->m_nextpkt = (ifq)->ifq_head; \
    370 	if ((ifq)->ifq_tail == 0) \
    371 		(ifq)->ifq_tail = (m); \
    372 	(ifq)->ifq_head = (m); \
    373 	(ifq)->ifq_len++; \
    374 }
    375 #define	IF_DEQUEUE(ifq, m) { \
    376 	(m) = (ifq)->ifq_head; \
    377 	if (m) { \
    378 		if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
    379 			(ifq)->ifq_tail = 0; \
    380 		(m)->m_nextpkt = 0; \
    381 		(ifq)->ifq_len--; \
    382 	} \
    383 }
    384 #define	IF_POLL(ifq, m)		((m) = (ifq)->ifq_head)
    385 #define	IF_PURGE(ifq)							\
    386 do {									\
    387 	struct mbuf *__m0;						\
    388 									\
    389 	for (;;) {							\
    390 		IF_DEQUEUE((ifq), __m0);				\
    391 		if (__m0 == NULL)					\
    392 			break;						\
    393 		else							\
    394 			m_freem(__m0);					\
    395 	}								\
    396 } while (/*CONSTCOND*/ 0)
    397 #define	IF_IS_EMPTY(ifq)	((ifq)->ifq_len == 0)
    398 
    399 #define	IFQ_MAXLEN	50
    400 #define	IFNET_SLOWHZ	1		/* granularity is 1 second */
    401 
    402 /*
    403  * Structure defining statistics and other data kept regarding an address
    404  * on a network interface.
    405  */
    406 struct ifaddr_data {
    407 	int64_t	ifad_inbytes;
    408 	int64_t	ifad_outbytes;
    409 };
    410 
    411 /*
    412  * The ifaddr structure contains information about one address
    413  * of an interface.  They are maintained by the different address families,
    414  * are allocated and attached when an address is set, and are linked
    415  * together so all addresses for an interface can be located.
    416  */
    417 struct ifaddr {
    418 	struct	sockaddr *ifa_addr;	/* address of interface */
    419 	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
    420 #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
    421 	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
    422 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
    423 	TAILQ_ENTRY(ifaddr) ifa_list;	/* list of addresses for interface */
    424 	struct	ifaddr_data	ifa_data;	/* statistics on the address */
    425 	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
    426 		    __P((int, struct rtentry *, struct rt_addrinfo *));
    427 	u_int	ifa_flags;		/* mostly rt_flags for cloning */
    428 	int	ifa_refcnt;		/* count of references */
    429 	int	ifa_metric;		/* cost of going out this interface */
    430 };
    431 #define	IFA_ROUTE	RTF_UP /* 0x01 *//* route installed */
    432 
    433 /*
    434  * Message format for use in obtaining information about interfaces
    435  * from sysctl and the routing socket.
    436  */
    437 struct if_msghdr {
    438 	u_short	ifm_msglen;	/* to skip over non-understood messages */
    439 	u_char	ifm_version;	/* future binary compatibility */
    440 	u_char	ifm_type;	/* message type */
    441 	int	ifm_addrs;	/* like rtm_addrs */
    442 	int	ifm_flags;	/* value of if_flags */
    443 	u_short	ifm_index;	/* index for associated ifp */
    444 	struct	if_data ifm_data;/* statistics and other data about if */
    445 };
    446 
    447 #if defined(_KERNEL) && defined(COMPAT_14)
    448 /* pre-1.5 if_msghdr (ifm_data changed) */
    449 struct if_msghdr14 {
    450 	u_short	ifm_msglen;	/* to skip over non-understood messages */
    451 	u_char	ifm_version;	/* future binary compatibility */
    452 	u_char	ifm_type;	/* message type */
    453 	int	ifm_addrs;	/* like rtm_addrs */
    454 	int	ifm_flags;	/* value of if_flags */
    455 	u_short	ifm_index;	/* index for associated ifp */
    456 	struct	if_data14 ifm_data; /* statistics and other data about if */
    457 };
    458 #endif /* _KERNEL && COMPAT_14 */
    459 
    460 /*
    461  * Message format for use in obtaining information about interface addresses
    462  * from sysctl and the routing socket.
    463  */
    464 struct ifa_msghdr {
    465 	u_short	ifam_msglen;	/* to skip over non-understood messages */
    466 	u_char	ifam_version;	/* future binary compatibility */
    467 	u_char	ifam_type;	/* message type */
    468 	int	ifam_addrs;	/* like rtm_addrs */
    469 	int	ifam_flags;	/* value of ifa_flags */
    470 	u_short	ifam_index;	/* index for associated ifp */
    471 	int	ifam_metric;	/* value of ifa_metric */
    472 };
    473 
    474 /*
    475  * Message format announcing the arrival or departure of a network interface.
    476  */
    477 struct if_announcemsghdr {
    478 	u_short	ifan_msglen;	/* to skip over non-understood messages */
    479 	u_char	ifan_version;	/* future binary compatibility */
    480 	u_char	ifan_type;	/* message type */
    481 	u_short	ifan_index;	/* index for associated ifp */
    482 	char	ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
    483 	u_short	ifan_what;	/* what type of announcement */
    484 };
    485 
    486 #define	IFAN_ARRIVAL	0	/* interface arrival */
    487 #define	IFAN_DEPARTURE	1	/* interface departure */
    488 
    489 /*
    490  * Interface request structure used for socket
    491  * ioctl's.  All interface ioctl's must have parameter
    492  * definitions which begin with ifr_name.  The
    493  * remainder may be interface specific.
    494  */
    495 struct	ifreq {
    496 	char	ifr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
    497 	union {
    498 		struct	sockaddr ifru_addr;
    499 		struct	sockaddr ifru_dstaddr;
    500 		struct	sockaddr ifru_broadaddr;
    501 		short	ifru_flags;
    502 		int	ifru_metric;
    503 		int	ifru_mtu;
    504 		int	ifru_dlt;
    505 		u_int	ifru_value;
    506 		caddr_t	ifru_data;
    507 	} ifr_ifru;
    508 #define	ifr_addr	ifr_ifru.ifru_addr	/* address */
    509 #define	ifr_dstaddr	ifr_ifru.ifru_dstaddr	/* other end of p-to-p link */
    510 #define	ifr_broadaddr	ifr_ifru.ifru_broadaddr	/* broadcast address */
    511 #define	ifr_flags	ifr_ifru.ifru_flags	/* flags */
    512 #define	ifr_metric	ifr_ifru.ifru_metric	/* metric */
    513 #define	ifr_mtu		ifr_ifru.ifru_mtu	/* mtu */
    514 #define	ifr_dlt		ifr_ifru.ifru_dlt	/* data link type (DLT_*) */
    515 #define	ifr_value	ifr_ifru.ifru_value	/* generic value */
    516 #define	ifr_media	ifr_ifru.ifru_metric	/* media options (overload) */
    517 #define	ifr_data	ifr_ifru.ifru_data	/* for use by interface */
    518 };
    519 
    520 struct ifcapreq {
    521 	char		ifcr_name[IFNAMSIZ];	/* if name, e.g. "en0" */
    522 	uint64_t	ifcr_capabilities;	/* supported capabiliites */
    523 	uint64_t	ifcr_capenable;		/* capabilities enabled */
    524 };
    525 
    526 struct ifaliasreq {
    527 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
    528 	struct	sockaddr ifra_addr;
    529 	struct	sockaddr ifra_dstaddr;
    530 #define	ifra_broadaddr	ifra_dstaddr
    531 	struct	sockaddr ifra_mask;
    532 };
    533 
    534 struct ifdatareq {
    535 	char	ifdr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
    536 	struct	if_data ifdr_data;
    537 };
    538 
    539 struct ifmediareq {
    540 	char	ifm_name[IFNAMSIZ];		/* if name, e.g. "en0" */
    541 	int	ifm_current;			/* current media options */
    542 	int	ifm_mask;			/* don't care mask */
    543 	int	ifm_status;			/* media status */
    544 	int	ifm_active;			/* active options */
    545 	int	ifm_count;			/* # entries in ifm_ulist
    546 						   array */
    547 	int	*ifm_ulist;			/* media words */
    548 };
    549 
    550 
    551 struct  ifdrv {
    552 	char		ifd_name[IFNAMSIZ];	/* if name, e.g. "en0" */
    553 	unsigned long	ifd_cmd;
    554 	size_t		ifd_len;
    555 	void		*ifd_data;
    556 };
    557 
    558 /*
    559  * Structure used in SIOCGIFCONF request.
    560  * Used to retrieve interface configuration
    561  * for machine (useful for programs which
    562  * must know all networks accessible).
    563  */
    564 struct	ifconf {
    565 	int	ifc_len;		/* size of associated buffer */
    566 	union {
    567 		caddr_t	ifcu_buf;
    568 		struct	ifreq *ifcu_req;
    569 	} ifc_ifcu;
    570 #define	ifc_buf	ifc_ifcu.ifcu_buf	/* buffer address */
    571 #define	ifc_req	ifc_ifcu.ifcu_req	/* array of structures returned */
    572 };
    573 
    574 /*
    575  * Structure for SIOC[AGD]LIFADDR
    576  */
    577 struct if_laddrreq {
    578 	char iflr_name[IFNAMSIZ];
    579 	unsigned int flags;
    580 #define IFLR_PREFIX	0x8000	/* in: prefix given  out: kernel fills id */
    581 	unsigned int prefixlen;		/* in/out */
    582 	struct sockaddr_storage addr;	/* in/out */
    583 	struct sockaddr_storage dstaddr; /* out */
    584 };
    585 
    586 #include <net/if_arp.h>
    587 
    588 #endif /* !_XOPEN_SOURCE */
    589 
    590 #ifdef _KERNEL
    591 #ifdef IFAREF_DEBUG
    592 #define	IFAREF(ifa)							\
    593 do {									\
    594 	printf("IFAREF: %s:%d %p -> %d\n", __FILE__, __LINE__,		\
    595 	    (ifa), ++(ifa)->ifa_refcnt);				\
    596 } while (/*CONSTCOND*/ 0)
    597 
    598 #define	IFAFREE(ifa)							\
    599 do {									\
    600 	if ((ifa)->ifa_refcnt <= 0)					\
    601 		panic("%s:%d: %p ifa_refcnt <= 0", __FILE__,		\
    602 		    __LINE__, (ifa));					\
    603 	printf("IFAFREE: %s:%d %p -> %d\n", __FILE__, __LINE__,		\
    604 	    (ifa), --(ifa)->ifa_refcnt);				\
    605 	if ((ifa)->ifa_refcnt == 0)					\
    606 		ifafree(ifa);						\
    607 } while (/*CONSTCOND*/ 0)
    608 #else
    609 #define	IFAREF(ifa)	(ifa)->ifa_refcnt++
    610 
    611 #ifdef DIAGNOSTIC
    612 #define	IFAFREE(ifa)							\
    613 do {									\
    614 	if ((ifa)->ifa_refcnt <= 0)					\
    615 		panic("%s:%d: %p ifa_refcnt <= 0", __FILE__,		\
    616 		    __LINE__, (ifa));					\
    617 	if (--(ifa)->ifa_refcnt == 0)					\
    618 		ifafree(ifa);						\
    619 } while (/*CONSTCOND*/ 0)
    620 #else
    621 #define	IFAFREE(ifa)							\
    622 do {									\
    623 	if (--(ifa)->ifa_refcnt == 0)					\
    624 		ifafree(ifa);						\
    625 } while (/*CONSTCOND*/ 0)
    626 #endif /* DIAGNOSTIC */
    627 #endif /* IFAREF_DEBUG */
    628 
    629 #ifdef ALTQ
    630 #define	ALTQ_DECL(x)		x
    631 
    632 #define IFQ_ENQUEUE(ifq, m, pattr, err)					\
    633 do {									\
    634 	if (ALTQ_IS_ENABLED((ifq)))					\
    635 		ALTQ_ENQUEUE((ifq), (m), (pattr), (err));		\
    636 	else {								\
    637 		if (IF_QFULL((ifq))) {					\
    638 			m_freem((m));					\
    639 			(err) = ENOBUFS;				\
    640 		} else {						\
    641 			IF_ENQUEUE((ifq), (m));				\
    642 			(err) = 0;					\
    643 		}							\
    644 	}								\
    645 	if ((err))							\
    646 		(ifq)->ifq_drops++;					\
    647 } while (/*CONSTCOND*/ 0)
    648 
    649 #define IFQ_DEQUEUE(ifq, m)						\
    650 do {									\
    651 	if (TBR_IS_ENABLED((ifq)))					\
    652 		(m) = tbr_dequeue((ifq), ALTDQ_REMOVE);			\
    653 	else if (ALTQ_IS_ENABLED((ifq)))				\
    654 		ALTQ_DEQUEUE((ifq), (m));				\
    655 	else								\
    656 		IF_DEQUEUE((ifq), (m));					\
    657 } while (/*CONSTCOND*/ 0)
    658 
    659 #define	IFQ_POLL(ifq, m)						\
    660 do {									\
    661 	if (TBR_IS_ENABLED((ifq)))					\
    662 		(m) = tbr_dequeue((ifq), ALTDQ_POLL);			\
    663 	else if (ALTQ_IS_ENABLED((ifq)))				\
    664 		ALTQ_POLL((ifq), (m));					\
    665 	else								\
    666 		IF_POLL((ifq), (m));					\
    667 } while (/*CONSTCOND*/ 0)
    668 
    669 #define	IFQ_PURGE(ifq)							\
    670 do {									\
    671 	if (ALTQ_IS_ENABLED((ifq)))					\
    672 		ALTQ_PURGE((ifq));					\
    673 	else								\
    674 		IF_PURGE((ifq));					\
    675 } while (/*CONSTCOND*/ 0)
    676 
    677 #define	IFQ_SET_READY(ifq)						\
    678 do {									\
    679 	(ifq)->altq_flags |= ALTQF_READY;				\
    680 } while (/*CONSTCOND*/ 0)
    681 
    682 #define	IFQ_CLASSIFY(ifq, m, af, pa)					\
    683 do {									\
    684 	if (ALTQ_IS_ENABLED((ifq))) {					\
    685 		if (ALTQ_NEEDS_CLASSIFY((ifq)))				\
    686 			(pa)->pattr_class = (*(ifq)->altq_classify)	\
    687 				((ifq)->altq_clfier, (m), (af));	\
    688 		(pa)->pattr_af = (af);					\
    689 		(pa)->pattr_hdr = mtod((m), caddr_t);			\
    690 	}								\
    691 } while (/*CONSTCOND*/ 0)
    692 #else /* ! ALTQ */
    693 #define	ALTQ_DECL(x)		/* nothing */
    694 
    695 #define	IFQ_ENQUEUE(ifq, m, pattr, err)					\
    696 do {									\
    697 	if (IF_QFULL((ifq))) {						\
    698 		m_freem((m));						\
    699 		(err) = ENOBUFS;					\
    700 	} else {							\
    701 		IF_ENQUEUE((ifq), (m));					\
    702 		(err) = 0;						\
    703 	}								\
    704 	if ((err))							\
    705 		(ifq)->ifq_drops++;					\
    706 } while (/*CONSTCOND*/ 0)
    707 
    708 #define	IFQ_DEQUEUE(ifq, m)	IF_DEQUEUE((ifq), (m))
    709 
    710 #define	IFQ_POLL(ifq, m)	IF_POLL((ifq), (m))
    711 
    712 #define	IFQ_PURGE(ifq)		IF_PURGE((ifq))
    713 
    714 #define	IFQ_SET_READY(ifq)	/* nothing */
    715 
    716 #define	IFQ_CLASSIFY(ifq, m, af, pa) /* nothing */
    717 
    718 #endif /* ALTQ */
    719 
    720 #define	IFQ_IS_EMPTY(ifq)		IF_IS_EMPTY((ifq))
    721 #define	IFQ_INC_LEN(ifq)		((ifq)->ifq_len++)
    722 #define	IFQ_DEC_LEN(ifq)		(--(ifq)->ifq_len)
    723 #define	IFQ_INC_DROPS(ifq)		((ifq)->ifq_drops++)
    724 #define	IFQ_SET_MAXLEN(ifq, len)	((ifq)->ifq_maxlen = (len))
    725 
    726 #include <sys/mallocvar.h>
    727 MALLOC_DECLARE(M_IFADDR);
    728 MALLOC_DECLARE(M_IFMADDR);
    729 
    730 extern struct ifnet_head ifnet;
    731 extern struct ifnet **ifindex2ifnet;
    732 #if 0
    733 struct ifnet loif[];
    734 #endif
    735 extern u_int if_index;
    736 
    737 char	*ether_sprintf __P((const u_char *));
    738 
    739 void	if_alloc_sadl __P((struct ifnet *));
    740 void	if_free_sadl __P((struct ifnet *));
    741 void	if_attach __P((struct ifnet *));
    742 void	if_attachdomain __P((void));
    743 void	if_attachdomain1 __P((struct ifnet *));
    744 void	if_deactivate __P((struct ifnet *));
    745 void	if_detach __P((struct ifnet *));
    746 void	if_down __P((struct ifnet *));
    747 void	if_slowtimo __P((void *));
    748 void	if_up __P((struct ifnet *));
    749 int	ifconf __P((u_long, caddr_t));
    750 void	ifinit __P((void));
    751 int	ifioctl __P((struct socket *, u_long, caddr_t, struct proc *));
    752 int	ifpromisc __P((struct ifnet *, int));
    753 struct	ifnet *ifunit __P((const char *));
    754 
    755 struct	ifaddr *ifa_ifwithaddr __P((struct sockaddr *));
    756 struct	ifaddr *ifa_ifwithaf __P((int));
    757 struct	ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *));
    758 struct	ifaddr *ifa_ifwithnet __P((struct sockaddr *));
    759 struct	ifaddr *ifa_ifwithladdr __P((struct sockaddr *));
    760 struct	ifaddr *ifa_ifwithroute __P((int, struct sockaddr *,
    761 					struct sockaddr *));
    762 struct	ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *));
    763 void	ifafree __P((struct ifaddr *));
    764 void	link_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *));
    765 
    766 void	if_clone_attach __P((struct if_clone *));
    767 void	if_clone_detach __P((struct if_clone *));
    768 
    769 int	if_clone_create __P((const char *));
    770 int	if_clone_destroy __P((const char *));
    771 
    772 int	loioctl __P((struct ifnet *, u_long, caddr_t));
    773 void	loopattach __P((int));
    774 int	looutput __P((struct ifnet *,
    775 	   struct mbuf *, struct sockaddr *, struct rtentry *));
    776 void	lortrequest __P((int, struct rtentry *, struct rt_addrinfo *));
    777 
    778 /*
    779  * These are exported because they're an easy way to tell if
    780  * an interface is going away without having to burn a flag.
    781  */
    782 int	if_nulloutput __P((struct ifnet *, struct mbuf *,
    783 	    struct sockaddr *, struct rtentry *));
    784 void	if_nullinput __P((struct ifnet *, struct mbuf *));
    785 void	if_nullstart __P((struct ifnet *));
    786 int	if_nullioctl __P((struct ifnet *, u_long, caddr_t));
    787 int	if_nullinit __P((struct ifnet *));
    788 void	if_nullstop __P((struct ifnet *, int));
    789 void	if_nullwatchdog __P((struct ifnet *));
    790 void	if_nulldrain __P((struct ifnet *));
    791 #else
    792 struct if_nameindex {
    793 	unsigned int	if_index;	/* 1, 2, ... */
    794 	char		*if_name;	/* null terminated name: "le0", ... */
    795 };
    796 
    797 #include <sys/cdefs.h>
    798 __BEGIN_DECLS
    799 unsigned int if_nametoindex __P((const char *));
    800 char *	if_indextoname __P((unsigned int, char *));
    801 struct	if_nameindex * if_nameindex __P((void));
    802 void	if_freenameindex __P((struct if_nameindex *));
    803 __END_DECLS
    804 #endif /* _KERNEL */
    805 #endif /* !_NET_IF_H_ */
    806