Home | History | Annotate | Line # | Download | only in net
if.h revision 1.55
      1 /*	$NetBSD: if.h,v 1.55 2000/12/13 22:05:12 thorpej Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1999, 2000 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/queue.h>
     80 
     81 /*
     82  * Structures defining a network interface, providing a packet
     83  * transport mechanism (ala level 0 of the PUP protocols).
     84  *
     85  * Each interface accepts output datagrams of a specified maximum
     86  * length, and provides higher level routines with input datagrams
     87  * received from its medium.
     88  *
     89  * Output occurs when the routine if_output is called, with four parameters:
     90  *	(*ifp->if_output)(ifp, m, dst, rt)
     91  * Here m is the mbuf chain to be sent and dst is the destination address.
     92  * The output routine encapsulates the supplied datagram if necessary,
     93  * and then transmits it on its medium.
     94  *
     95  * On input, each interface unwraps the data received by it, and either
     96  * places it on the input queue of a internetwork datagram routine
     97  * and posts the associated software interrupt, or passes the datagram to a raw
     98  * packet input routine.
     99  *
    100  * Routines exist for locating interfaces by their addresses
    101  * or for locating a interface on a certain network, as well as more general
    102  * routing and gateway routines maintaining information used to locate
    103  * interfaces.  These routines live in the files if.c and route.c
    104  */
    105 /*  XXX fast fix for SNMP, going away soon */
    106 #include <sys/time.h>
    107 
    108 #if defined(_KERNEL) && !defined(_LKM)
    109 #include "opt_compat_netbsd.h"
    110 #endif
    111 
    112 struct mbuf;
    113 struct proc;
    114 struct rtentry;
    115 struct socket;
    116 struct ether_header;
    117 struct ifnet;
    118 
    119 /*
    120  * Length of interface external name, including terminating '\0'.
    121  * Note: this is the same size as a generic device's external name.
    122  */
    123 #define	IFNAMSIZ	16
    124 #define	IF_NAMESIZE	IFNAMSIZ
    125 
    126 /*
    127  * Structure describing a `cloning' interface.
    128  */
    129 struct if_clone {
    130 	LIST_ENTRY(if_clone) ifc_list;	/* on list of cloners */
    131 	const char *ifc_name;		/* name of device, e.g. `gif' */
    132 	size_t ifc_namelen;		/* length of name */
    133 
    134 	int	(*ifc_create)(struct if_clone *, int);
    135 	void	(*ifc_destroy)(struct ifnet *);
    136 };
    137 
    138 #define	IF_CLONE_INITIALIZER(name, create, destroy)			\
    139 	{ { 0 }, name, sizeof(name) - 1, create, destroy }
    140 
    141 /*
    142  * Structure used to query names of interface cloners.
    143  */
    144 struct if_clonereq {
    145 	int	ifcr_total;		/* total cloners (out) */
    146 	int	ifcr_count;		/* room for this many in user buffer */
    147 	char	*ifcr_buffer;		/* buffer for cloner names */
    148 };
    149 
    150 /*
    151  * Structure defining statistics and other data kept regarding a network
    152  * interface.
    153  */
    154 struct if_data {
    155 	/* generic interface information */
    156 	u_char	ifi_type;		/* ethernet, tokenring, etc. */
    157 	u_char	ifi_addrlen;		/* media address length */
    158 	u_char	ifi_hdrlen;		/* media header length */
    159 	int	ifi_link_state;		/* current link state */
    160 	u_quad_t ifi_mtu;		/* maximum transmission unit */
    161 	u_quad_t ifi_metric;		/* routing metric (external only) */
    162 	u_quad_t ifi_baudrate;		/* linespeed */
    163 	/* volatile statistics */
    164 	u_quad_t ifi_ipackets;		/* packets received on interface */
    165 	u_quad_t ifi_ierrors;		/* input errors on interface */
    166 	u_quad_t ifi_opackets;		/* packets sent on interface */
    167 	u_quad_t ifi_oerrors;		/* output errors on interface */
    168 	u_quad_t ifi_collisions;	/* collisions on csma interfaces */
    169 	u_quad_t ifi_ibytes;		/* total number of octets received */
    170 	u_quad_t ifi_obytes;		/* total number of octets sent */
    171 	u_quad_t ifi_imcasts;		/* packets received via multicast */
    172 	u_quad_t ifi_omcasts;		/* packets sent via multicast */
    173 	u_quad_t ifi_iqdrops;		/* dropped on input, this interface */
    174 	u_quad_t ifi_noproto;		/* destined for unsupported protocol */
    175 	struct	timeval ifi_lastchange;	/* last updated */
    176 };
    177 
    178 /*
    179  * Values for if_link_state.
    180  */
    181 #define	LINK_STATE_UNKNOWN	0	/* link invalid/unknown */
    182 #define	LINK_STATE_DOWN		1	/* link is down */
    183 #define	LINK_STATE_UP		2	/* link is up */
    184 
    185 #if defined(_KERNEL) && defined(COMPAT_14)
    186 /* Pre-1.5 if_data struct */
    187 struct if_data14 {
    188 	/* generic interface information */
    189 	u_char	ifi_type;		/* ethernet, tokenring, etc. */
    190 	u_char	ifi_addrlen;		/* media address length */
    191 	u_char	ifi_hdrlen;		/* media header length */
    192 	u_long	ifi_mtu;		/* maximum transmission unit */
    193 	u_long	ifi_metric;		/* routing metric (external only) */
    194 	u_long	ifi_baudrate;		/* linespeed */
    195 	/* volatile statistics */
    196 	u_long	ifi_ipackets;		/* packets received on interface */
    197 	u_long	ifi_ierrors;		/* input errors on interface */
    198 	u_long	ifi_opackets;		/* packets sent on interface */
    199 	u_long	ifi_oerrors;		/* output errors on interface */
    200 	u_long	ifi_collisions;		/* collisions on csma interfaces */
    201 	u_long	ifi_ibytes;		/* total number of octets received */
    202 	u_long	ifi_obytes;		/* total number of octets sent */
    203 	u_long	ifi_imcasts;		/* packets received via multicast */
    204 	u_long	ifi_omcasts;		/* packets sent via multicast */
    205 	u_long	ifi_iqdrops;		/* dropped on input, this interface */
    206 	u_long	ifi_noproto;		/* destined for unsupported protocol */
    207 	struct	timeval ifi_lastchange;	/* last updated */
    208 };
    209 #endif /* _KERNEL && COMPAT_14 */
    210 
    211 /*
    212  * Structure defining a queue for a network interface.
    213  */
    214 struct ifqueue {
    215 	struct	mbuf *ifq_head;
    216 	struct	mbuf *ifq_tail;
    217 	int	ifq_len;
    218 	int	ifq_maxlen;
    219 	int	ifq_drops;
    220 };
    221 
    222 /*
    223  * Structure defining a queue for a network interface.
    224  *
    225  * (Would like to call this struct ``if'', but C isn't PL/1.)
    226  */
    227 TAILQ_HEAD(ifnet_head, ifnet);		/* the actual queue head */
    228 
    229 struct ifnet {				/* and the entries */
    230 	void	*if_softc;		/* lower-level data for this if */
    231 	TAILQ_ENTRY(ifnet) if_list;	/* all struct ifnets are chained */
    232 	TAILQ_HEAD(, ifaddr) if_addrlist; /* linked list of addresses per if */
    233 	char	if_xname[IFNAMSIZ];	/* external name (name + unit) */
    234 	int	if_pcount;		/* number of promiscuous listeners */
    235 	caddr_t	if_bpf;			/* packet filter structure */
    236 	u_short	if_index;		/* numeric abbreviation for this if */
    237 	short	if_timer;		/* time 'til if_watchdog called */
    238 	short	if_flags;		/* up/down, broadcast, etc. */
    239 	short	if__pad1;		/* be nice to m68k ports */
    240 	struct	if_data if_data;	/* statistics and other data about if */
    241 	/*
    242 	 * Procedure handles.  If you add more of these, don't forget the
    243 	 * corresponding NULL stub in if.c.
    244 	 */
    245 	int	(*if_output)		/* output routine (enqueue) */
    246 		__P((struct ifnet *, struct mbuf *, struct sockaddr *,
    247 		     struct rtentry *));
    248 	void	(*if_input)		/* input routine (from h/w driver) */
    249 		__P((struct ifnet *, struct mbuf *));
    250 	void	(*if_start)		/* initiate output routine */
    251 		__P((struct ifnet *));
    252 	int	(*if_ioctl)		/* ioctl routine */
    253 		__P((struct ifnet *, u_long, caddr_t));
    254 	int	(*if_init)		/* init routine */
    255 		__P((struct ifnet *));
    256 	void	(*if_stop)		/* stop routine */
    257 		__P((struct ifnet *, int));
    258 	void	(*if_watchdog)		/* timer routine */
    259 		__P((struct ifnet *));
    260 	void	(*if_drain)		/* routine to release resources */
    261 		__P((struct ifnet *));
    262 #if 0 /* ALTQ */
    263 	struct ifaltq if_snd;		/* output queue (includes altq) */
    264 #else
    265 	struct ifqueue if_snd;		/* output queue */
    266 #endif
    267 	struct	sockaddr_dl *if_sadl;	/* pointer to our sockaddr_dl */
    268 	u_int8_t *if_broadcastaddr;	/* linklevel broadcast bytestring */
    269 	struct ifprefix *if_prefixlist; /* linked list of prefixes per if */
    270 #if 0
    271 	void	*if_bridge;		/* bridge glue */
    272 #endif
    273 };
    274 #define	if_mtu		if_data.ifi_mtu
    275 #define	if_type		if_data.ifi_type
    276 #define	if_addrlen	if_data.ifi_addrlen
    277 #define	if_hdrlen	if_data.ifi_hdrlen
    278 #define	if_metric	if_data.ifi_metric
    279 #define	if_link_state	if_data.ifi_link_state
    280 #define	if_baudrate	if_data.ifi_baudrate
    281 #define	if_ipackets	if_data.ifi_ipackets
    282 #define	if_ierrors	if_data.ifi_ierrors
    283 #define	if_opackets	if_data.ifi_opackets
    284 #define	if_oerrors	if_data.ifi_oerrors
    285 #define	if_collisions	if_data.ifi_collisions
    286 #define	if_ibytes	if_data.ifi_ibytes
    287 #define	if_obytes	if_data.ifi_obytes
    288 #define	if_imcasts	if_data.ifi_imcasts
    289 #define	if_omcasts	if_data.ifi_omcasts
    290 #define	if_iqdrops	if_data.ifi_iqdrops
    291 #define	if_noproto	if_data.ifi_noproto
    292 #define	if_lastchange	if_data.ifi_lastchange
    293 
    294 #define	IFF_UP		0x1		/* interface is up */
    295 #define	IFF_BROADCAST	0x2		/* broadcast address valid */
    296 #define	IFF_DEBUG	0x4		/* turn on debugging */
    297 #define	IFF_LOOPBACK	0x8		/* is a loopback net */
    298 #define	IFF_POINTOPOINT	0x10		/* interface is point-to-point link */
    299 #define	IFF_NOTRAILERS	0x20		/* avoid use of trailers */
    300 #define	IFF_RUNNING	0x40		/* resources allocated */
    301 #define	IFF_NOARP	0x80		/* no address resolution protocol */
    302 #define	IFF_PROMISC	0x100		/* receive all packets */
    303 #define	IFF_ALLMULTI	0x200		/* receive all multicast packets */
    304 #define	IFF_OACTIVE	0x400		/* transmission in progress */
    305 #define	IFF_SIMPLEX	0x800		/* can't hear own transmissions */
    306 #define	IFF_LINK0	0x1000		/* per link layer defined bit */
    307 #define	IFF_LINK1	0x2000		/* per link layer defined bit */
    308 #define	IFF_LINK2	0x4000		/* per link layer defined bit */
    309 #define	IFF_MULTICAST	0x8000		/* supports multicast */
    310 
    311 /* flags set internally only: */
    312 #define	IFF_CANTCHANGE \
    313 	(IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
    314 	    IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC)
    315 
    316 /*
    317  * Some convenience macros used for setting ifi_baudrate.
    318  * XXX 1000 vs. 1024? --thorpej (at) netbsd.org
    319  */
    320 #define	IF_Kbps(x)	((x) * 1000)		/* kilobits/sec. */
    321 #define	IF_Mbps(x)	(IF_Kbps((x) * 1000))	/* megabits/sec. */
    322 #define	IF_Gbps(x)	(IF_Mbps((x) * 1000))	/* gigabits/sec. */
    323 
    324 /*
    325  * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
    326  * input routines have queues of messages stored on ifqueue structures
    327  * (defined above).  Entries are added to and deleted from these structures
    328  * by these macros, which should be called with ipl raised to splimp().
    329  */
    330 #define	IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
    331 #define	IF_DROP(ifq)		((ifq)->ifq_drops++)
    332 #define	IF_ENQUEUE(ifq, m) { \
    333 	(m)->m_nextpkt = 0; \
    334 	if ((ifq)->ifq_tail == 0) \
    335 		(ifq)->ifq_head = m; \
    336 	else \
    337 		(ifq)->ifq_tail->m_nextpkt = m; \
    338 	(ifq)->ifq_tail = m; \
    339 	(ifq)->ifq_len++; \
    340 }
    341 #define	IF_PREPEND(ifq, m) { \
    342 	(m)->m_nextpkt = (ifq)->ifq_head; \
    343 	if ((ifq)->ifq_tail == 0) \
    344 		(ifq)->ifq_tail = (m); \
    345 	(ifq)->ifq_head = (m); \
    346 	(ifq)->ifq_len++; \
    347 }
    348 #define	IF_DEQUEUE(ifq, m) { \
    349 	(m) = (ifq)->ifq_head; \
    350 	if (m) { \
    351 		if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
    352 			(ifq)->ifq_tail = 0; \
    353 		(m)->m_nextpkt = 0; \
    354 		(ifq)->ifq_len--; \
    355 	} \
    356 }
    357 #define	IF_POLL(ifq, m)		((m) = (ifq)->ifq_head)
    358 #define	IF_PURGE(ifq)							\
    359 do {									\
    360 	struct mbuf *__m0;						\
    361 	IF_DEQUEUE((ifq), __m0);					\
    362 	if (__m0 == NULL)						\
    363 		break;							\
    364 	else								\
    365 		m_freem(__m0);						\
    366 } while (0)
    367 #define	IF_IS_EMPTY(ifq)	((ifq)->ifq_len == 0)
    368 
    369 #define	IFQ_MAXLEN	50
    370 #define	IFNET_SLOWHZ	1		/* granularity is 1 second */
    371 
    372 /*
    373  * Structure defining statistics and other data kept regarding an address
    374  * on a network interface.
    375  */
    376 struct ifaddr_data {
    377 	int64_t	ifad_inbytes;
    378 	int64_t	ifad_outbytes;
    379 };
    380 
    381 /*
    382  * The ifaddr structure contains information about one address
    383  * of an interface.  They are maintained by the different address families,
    384  * are allocated and attached when an address is set, and are linked
    385  * together so all addresses for an interface can be located.
    386  */
    387 struct ifaddr {
    388 	struct	sockaddr *ifa_addr;	/* address of interface */
    389 	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
    390 #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
    391 	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
    392 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
    393 	TAILQ_ENTRY(ifaddr) ifa_list;	/* list of addresses for interface */
    394 	struct	ifaddr_data	ifa_data;	/* statistics on the address */
    395 	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
    396 		    __P((int, struct rtentry *, struct sockaddr *));
    397 	u_int	ifa_flags;		/* mostly rt_flags for cloning */
    398 	int	ifa_refcnt;		/* count of references */
    399 	int	ifa_metric;		/* cost of going out this interface */
    400 };
    401 #define	IFA_ROUTE	RTF_UP		/* route installed */
    402 
    403 /*
    404  * The prefix structure contains information about one prefix
    405  * of an interface.  They are maintained by the different address families,
    406  * are allocated and attached when an prefix or an address is set,
    407  * and are linked together so all prfefixes for an interface can be located.
    408  */
    409 struct ifprefix {
    410 	struct	sockaddr *ifpr_prefix;	/* prefix of interface */
    411 	struct	ifnet *ifpr_ifp;	/* back-pointer to interface */
    412 	struct ifprefix *ifpr_next;
    413 	u_char	ifpr_plen;		/* prefix length in bits */
    414 	u_char	ifpr_type;		/* protocol dependent prefix type */
    415 };
    416 
    417 /*
    418  * Message format for use in obtaining information about interfaces
    419  * from sysctl and the routing socket.
    420  */
    421 struct if_msghdr {
    422 	u_short	ifm_msglen;	/* to skip over non-understood messages */
    423 	u_char	ifm_version;	/* future binary compatability */
    424 	u_char	ifm_type;	/* message type */
    425 	int	ifm_addrs;	/* like rtm_addrs */
    426 	int	ifm_flags;	/* value of if_flags */
    427 	u_short	ifm_index;	/* index for associated ifp */
    428 	struct	if_data ifm_data;/* statistics and other data about if */
    429 };
    430 
    431 #if defined(_KERNEL) && defined(COMPAT_14)
    432 /* pre-1.5 if_msghdr (ifm_data changed) */
    433 struct if_msghdr14 {
    434 	u_short	ifm_msglen;	/* to skip over non-understood messages */
    435 	u_char	ifm_version;	/* future binary compatability */
    436 	u_char	ifm_type;	/* message type */
    437 	int	ifm_addrs;	/* like rtm_addrs */
    438 	int	ifm_flags;	/* value of if_flags */
    439 	u_short	ifm_index;	/* index for associated ifp */
    440 	struct	if_data14 ifm_data; /* statistics and other data about if */
    441 };
    442 #endif /* _KERNEL && COMPAT_14 */
    443 
    444 /*
    445  * Message format for use in obtaining information about interface addresses
    446  * from sysctl and the routing socket.
    447  */
    448 struct ifa_msghdr {
    449 	u_short	ifam_msglen;	/* to skip over non-understood messages */
    450 	u_char	ifam_version;	/* future binary compatability */
    451 	u_char	ifam_type;	/* message type */
    452 	int	ifam_addrs;	/* like rtm_addrs */
    453 	int	ifam_flags;	/* value of ifa_flags */
    454 	u_short	ifam_index;	/* index for associated ifp */
    455 	int	ifam_metric;	/* value of ifa_metric */
    456 };
    457 
    458 /*
    459  * Message format announcing the arrival or departure of a network interface.
    460  */
    461 struct if_announcemsghdr {
    462 	u_short	ifan_msglen;	/* to skip over non-understood messages */
    463 	u_char	ifan_version;	/* future binary compatibility */
    464 	u_char	ifan_type;	/* message type */
    465 	u_short	ifan_index;	/* index for associated ifp */
    466 	char	ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
    467 	u_short	ifan_what;	/* what type of announcement */
    468 };
    469 
    470 #define	IFAN_ARRIVAL	0	/* interface arrival */
    471 #define	IFAN_DEPARTURE	1	/* interface departure */
    472 
    473 /*
    474  * Interface request structure used for socket
    475  * ioctl's.  All interface ioctl's must have parameter
    476  * definitions which begin with ifr_name.  The
    477  * remainder may be interface specific.
    478  */
    479 struct	ifreq {
    480 	char	ifr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
    481 	union {
    482 		struct	sockaddr ifru_addr;
    483 		struct	sockaddr ifru_dstaddr;
    484 		struct	sockaddr ifru_broadaddr;
    485 		short	ifru_flags;
    486 		int	ifru_metric;
    487 		int	ifru_mtu;
    488 		u_int	ifru_value;
    489 		caddr_t	ifru_data;
    490 	} ifr_ifru;
    491 #define	ifr_addr	ifr_ifru.ifru_addr	/* address */
    492 #define	ifr_dstaddr	ifr_ifru.ifru_dstaddr	/* other end of p-to-p link */
    493 #define	ifr_broadaddr	ifr_ifru.ifru_broadaddr	/* broadcast address */
    494 #define	ifr_flags	ifr_ifru.ifru_flags	/* flags */
    495 #define	ifr_metric	ifr_ifru.ifru_metric	/* metric */
    496 #define	ifr_mtu		ifr_ifru.ifru_mtu	/* mtu */
    497 #define	ifr_value	ifr_ifru.ifru_value	/* generic value */
    498 #define	ifr_media	ifr_ifru.ifru_metric	/* media options (overload) */
    499 #define	ifr_data	ifr_ifru.ifru_data	/* for use by interface */
    500 };
    501 
    502 struct ifaliasreq {
    503 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
    504 	struct	sockaddr ifra_addr;
    505 	struct	sockaddr ifra_dstaddr;
    506 #define	ifra_broadaddr	ifra_dstaddr
    507 	struct	sockaddr ifra_mask;
    508 };
    509 
    510 struct ifmediareq {
    511 	char	ifm_name[IFNAMSIZ];		/* if name, e.g. "en0" */
    512 	int	ifm_current;			/* current media options */
    513 	int	ifm_mask;			/* don't care mask */
    514 	int	ifm_status;			/* media status */
    515 	int	ifm_active;			/* active options */
    516 	int	ifm_count;			/* # entries in ifm_ulist
    517 						   array */
    518 	int	*ifm_ulist;			/* media words */
    519 };
    520 
    521 
    522 struct  ifdrv {
    523 	char		ifd_name[IFNAMSIZ];	/* if name, e.g. "en0" */
    524 	unsigned long	ifd_cmd;
    525 	size_t		ifd_len;
    526 	void		*ifd_data;
    527 };
    528 
    529 /*
    530  * Structure used in SIOCGIFCONF request.
    531  * Used to retrieve interface configuration
    532  * for machine (useful for programs which
    533  * must know all networks accessible).
    534  */
    535 struct	ifconf {
    536 	int	ifc_len;		/* size of associated buffer */
    537 	union {
    538 		caddr_t	ifcu_buf;
    539 		struct	ifreq *ifcu_req;
    540 	} ifc_ifcu;
    541 #define	ifc_buf	ifc_ifcu.ifcu_buf	/* buffer address */
    542 #define	ifc_req	ifc_ifcu.ifcu_req	/* array of structures returned */
    543 };
    544 
    545 /*
    546  * Structure for SIOC[AGD]LIFADDR
    547  */
    548 struct if_laddrreq {
    549 	char iflr_name[IFNAMSIZ];
    550 	unsigned int flags;
    551 #define IFLR_PREFIX	0x8000	/* in: prefix given  out: kernel fills id */
    552 	unsigned int prefixlen;		/* in/out */
    553 	struct sockaddr_storage addr;	/* in/out */
    554 	struct sockaddr_storage dstaddr; /* out */
    555 };
    556 
    557 #include <net/if_arp.h>
    558 
    559 #endif /* !_XOPEN_SOURCE */
    560 
    561 #ifdef _KERNEL
    562 #ifdef IFAREF_DEBUG
    563 #define	IFAREF(ifa)							\
    564 do {									\
    565 	printf("IFAREF: %s:%d %p -> %d\n", __FILE__, __LINE__,		\
    566 	    (ifa), ++(ifa)->ifa_refcnt);				\
    567 } while (0)
    568 
    569 #define	IFAFREE(ifa)							\
    570 do {									\
    571 	if ((ifa)->ifa_refcnt <= 0)					\
    572 		panic("%s:%d: %p ifa_refcnt <= 0", __FILE__,		\
    573 		    __LINE__, (ifa));					\
    574 	printf("IFAFREE: %s:%d %p -> %d\n", __FILE__, __LINE__,		\
    575 	    (ifa), --(ifa)->ifa_refcnt);				\
    576 	if ((ifa)->ifa_refcnt == 0)					\
    577 		ifafree(ifa);						\
    578 } while (0)
    579 #else
    580 #define	IFAREF(ifa)	(ifa)->ifa_refcnt++
    581 
    582 #ifdef DIAGNOSTIC
    583 #define	IFAFREE(ifa)							\
    584 do {									\
    585 	if ((ifa)->ifa_refcnt <= 0)					\
    586 		panic("%s:%d: %p ifa_refcnt <= 0", __FILE__,		\
    587 		    __LINE__, (ifa));					\
    588 	if (--(ifa)->ifa_refcnt == 0)					\
    589 		ifafree(ifa);						\
    590 } while (0)
    591 #else
    592 #define	IFAFREE(ifa)							\
    593 do {									\
    594 	if (--(ifa)->ifa_refcnt == 0)					\
    595 		ifafree(ifa);						\
    596 } while (0)
    597 #endif /* DIAGNOSTIC */
    598 #endif /* IFAREF_DEBUG */
    599 
    600 #ifdef ALTQ
    601 #define	ALTQ_DECL(x)		x
    602 
    603 #define IFQ_ENQUEUE(ifq, m, pattr, err)					\
    604 do {									\
    605 	if (ALTQ_IS_ENABLED((ifq)))					\
    606 		ALTQ_ENQUEUE((ifq), (m), (pattr), (err));		\
    607 	else {								\
    608 		if (IF_QFULL((ifq))) {					\
    609 			m_freem((m));					\
    610 			(err) = ENOBUFS;				\
    611 		} else {						\
    612 			IF_ENQUEUE((ifq), (m));				\
    613 			(err) = 0;					\
    614 		}							\
    615 	}								\
    616 	if ((err))							\
    617 		(ifq)->ifq_drops++;					\
    618 } while (0)
    619 
    620 #define IFQ_DEQUEUE(ifq, m)						\
    621 do {									\
    622 	if (TBR_IS_ENABLED((ifq)))					\
    623 		(m) = tbr_dequeue((ifq), ALTDQ_REMOVE);			\
    624 	else if (ALTQ_IS_ENABLED((ifq)))				\
    625 		ALTQ_DEQUEUE((ifq), (m));				\
    626 	else								\
    627 		IF_POLL((ifq), (m));					\
    628 } while (0)
    629 
    630 #define	IFQ_PURGE(ifq)							\
    631 do {									\
    632 	if (ALTQ_IS_ENABLED((ifq)))					\
    633 		ALTQ_PURGE((ifq));					\
    634 	else								\
    635 		IF_PURGE((ifq));					\
    636 } while (0)
    637 
    638 #define	IFQ_SET_READY(ifq)						\
    639 do {									\
    640 	(ifq)->altq_flags |= ALTQF_READY;				\
    641 } while (0)
    642 
    643 #define	IFQ_CLASSIFY(ifq, m, af, pa)					\
    644 do {									\
    645 	if (ALTQ_IS_ENABLED((ifq))) {					\
    646 		if (ALTQ_NEEDS_CLASSIFY((ifq)))				\
    647 			(pa)->pattr_class = (*(ifq)->altq_classify)	\
    648 				((ifq)->altq_clfier, (m), (af));	\
    649 		(pa)->pattr_af = (af);					\
    650 		(pa)->pattr_hdr = mtod((m), caddr_t);			\
    651 	}								\
    652 } while (0)
    653 #else /* ! ALTQ */
    654 #define	ALTQ_DECL(x)		/* nothing */
    655 
    656 #define	IFQ_ENQUEUE(ifq, m, pattr, err)					\
    657 do {									\
    658 	if (IF_QFULL((ifq))) {						\
    659 		m_freem((m));						\
    660 		(err) = ENOBUFS;					\
    661 	} else {							\
    662 		IF_ENQUEUE((ifq), (m));					\
    663 		(err) = 0;						\
    664 	}								\
    665 	if ((err))							\
    666 		(ifq)->ifq_drops++;					\
    667 } while (0)
    668 
    669 #define	IFQ_DEQUEUE(ifq, m)	IF_DEQUEUE((ifq), (m))
    670 
    671 #define	IFQ_POLL(ifq, m)	IF_POLL((ifq), (m))
    672 
    673 #define	IFQ_PURGE(ifq)		IF_PURGE((ifq))
    674 
    675 #define	IFQ_SET_READY(ifq)	/* nothing */
    676 
    677 #define	IFQ_CLASSIFY(ifq, m, af, pa) /* nothing */
    678 
    679 #endif /* ALTQ */
    680 
    681 #define	IFQ_IS_EMPTY(ifq)		IF_IS_EMPTY((ifq))
    682 #define	IFQ_INC_LEN(ifq)		((ifq)->ifq_len++)
    683 #define	IFQ_DEC_LEN(ifq)		(--(ifq)->ifq_len)
    684 #define	IFQ_INC_DROPS(ifq)		((ifq)->ifq_drops++)
    685 #define	IFQ_SET_MAXLEN(ifq, len)	((ifq)->ifq_maxlen = (len))
    686 
    687 struct ifnet_head ifnet;
    688 extern struct ifnet **ifindex2ifnet;
    689 #if 0
    690 struct ifnet loif[];
    691 #endif
    692 extern int if_index;
    693 
    694 void	ether_ifattach __P((struct ifnet *, const u_int8_t *));
    695 void	ether_ifdetach __P((struct ifnet *));
    696 char	*ether_sprintf __P((const u_char *));
    697 
    698 void	if_attach __P((struct ifnet *));
    699 void	if_deactivate __P((struct ifnet *));
    700 void	if_detach __P((struct ifnet *));
    701 void	if_down __P((struct ifnet *));
    702 void	if_qflush __P((struct ifqueue *));
    703 void	if_slowtimo __P((void *));
    704 void	if_up __P((struct ifnet *));
    705 int	ifconf __P((u_long, caddr_t));
    706 void	ifinit __P((void));
    707 int	ifioctl __P((struct socket *, u_long, caddr_t, struct proc *));
    708 int	ifpromisc __P((struct ifnet *, int));
    709 struct	ifnet *ifunit __P((const char *));
    710 
    711 struct	ifaddr *ifa_ifwithaddr __P((struct sockaddr *));
    712 struct	ifaddr *ifa_ifwithaf __P((int));
    713 struct	ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *));
    714 struct	ifaddr *ifa_ifwithnet __P((struct sockaddr *));
    715 struct	ifaddr *ifa_ifwithladdr __P((struct sockaddr *));
    716 struct	ifaddr *ifa_ifwithroute __P((int, struct sockaddr *,
    717 					struct sockaddr *));
    718 struct	ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *));
    719 void	ifafree __P((struct ifaddr *));
    720 void	link_rtrequest __P((int, struct rtentry *, struct sockaddr *));
    721 
    722 void	if_clone_attach __P((struct if_clone *));
    723 void	if_clone_detach __P((struct if_clone *));
    724 
    725 int	if_clone_create __P((const char *));
    726 int	if_clone_destroy __P((const char *));
    727 
    728 int	loioctl __P((struct ifnet *, u_long, caddr_t));
    729 void	loopattach __P((int));
    730 int	looutput __P((struct ifnet *,
    731 	   struct mbuf *, struct sockaddr *, struct rtentry *));
    732 void	lortrequest __P((int, struct rtentry *, struct sockaddr *));
    733 
    734 /*
    735  * These are exported because they're an easy way to tell if
    736  * an interface is going away without having to burn a flag.
    737  */
    738 int	if_nulloutput __P((struct ifnet *, struct mbuf *,
    739 	    struct sockaddr *, struct rtentry *));
    740 void	if_nullinput __P((struct ifnet *, struct mbuf *));
    741 void	if_nullstart __P((struct ifnet *));
    742 int	if_nullioctl __P((struct ifnet *, u_long, caddr_t));
    743 int	if_nullinit __P((struct ifnet *));
    744 void	if_nullstop __P((struct ifnet *, int));
    745 void	if_nullwatchdog __P((struct ifnet *));
    746 void	if_nulldrain __P((struct ifnet *));
    747 #else
    748 struct if_nameindex {
    749 	unsigned int	if_index;	/* 1, 2, ... */
    750 	char		*if_name;	/* null terminated name: "le0", ... */
    751 };
    752 
    753 #include <sys/cdefs.h>
    754 __BEGIN_DECLS
    755 unsigned int if_nametoindex __P((const char *));
    756 char *	if_indextoname __P((unsigned int, char *));
    757 struct	if_nameindex * if_nameindex __P((void));
    758 void	if_freenameindex __P((struct if_nameindex *));
    759 __END_DECLS
    760 #endif /* _KERNEL */
    761 #endif /* !_NET_IF_H_ */
    762