xref: /netbsd/sys/net/if.h (revision bf9ec67e)
1 /*	$NetBSD: if.h,v 1.78 2002/05/27 13:46:45 itojun 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/queue.h>
80 #include <net/dlt.h>
81 #include <net/pfil.h>
82 
83 /*
84  * Always include ALTQ glue here -- we use the ALTQ interface queue
85  * structure even when ALTQ is not configured into the kernel so that
86  * the size of struct ifnet does not changed based on the option.  The
87  * ALTQ queue structure is API-compatible with the legacy ifqueue.
88  */
89 #include <altq/if_altq.h>
90 
91 /*
92  * Structures defining a network interface, providing a packet
93  * transport mechanism (ala level 0 of the PUP protocols).
94  *
95  * Each interface accepts output datagrams of a specified maximum
96  * length, and provides higher level routines with input datagrams
97  * received from its medium.
98  *
99  * Output occurs when the routine if_output is called, with four parameters:
100  *	(*ifp->if_output)(ifp, m, dst, rt)
101  * Here m is the mbuf chain to be sent and dst is the destination address.
102  * The output routine encapsulates the supplied datagram if necessary,
103  * and then transmits it on its medium.
104  *
105  * On input, each interface unwraps the data received by it, and either
106  * places it on the input queue of a internetwork datagram routine
107  * and posts the associated software interrupt, or passes the datagram to a raw
108  * packet input routine.
109  *
110  * Routines exist for locating interfaces by their addresses
111  * or for locating a interface on a certain network, as well as more general
112  * routing and gateway routines maintaining information used to locate
113  * interfaces.  These routines live in the files if.c and route.c
114  */
115 /*  XXX fast fix for SNMP, going away soon */
116 #include <sys/time.h>
117 
118 #if defined(_KERNEL_OPT)
119 #include "opt_compat_netbsd.h"
120 #endif
121 
122 struct mbuf;
123 struct proc;
124 struct rtentry;
125 struct socket;
126 struct ether_header;
127 struct ifnet;
128 struct rt_addrinfo;
129 
130 /*
131  * Length of interface external name, including terminating '\0'.
132  * Note: this is the same size as a generic device's external name.
133  */
134 #define	IFNAMSIZ	16
135 #define	IF_NAMESIZE	IFNAMSIZ
136 
137 /*
138  * Structure describing a `cloning' interface.
139  */
140 struct if_clone {
141 	LIST_ENTRY(if_clone) ifc_list;	/* on list of cloners */
142 	const char *ifc_name;		/* name of device, e.g. `gif' */
143 	size_t ifc_namelen;		/* length of name */
144 
145 	int	(*ifc_create)(struct if_clone *, int);
146 	void	(*ifc_destroy)(struct ifnet *);
147 };
148 
149 #define	IF_CLONE_INITIALIZER(name, create, destroy)			\
150 	{ { 0 }, name, sizeof(name) - 1, create, destroy }
151 
152 /*
153  * Structure used to query names of interface cloners.
154  */
155 struct if_clonereq {
156 	int	ifcr_total;		/* total cloners (out) */
157 	int	ifcr_count;		/* room for this many in user buffer */
158 	char	*ifcr_buffer;		/* buffer for cloner names */
159 };
160 
161 /*
162  * Structure defining statistics and other data kept regarding a network
163  * interface.
164  */
165 struct if_data {
166 	/* generic interface information */
167 	u_char	ifi_type;		/* ethernet, tokenring, etc. */
168 	u_char	ifi_addrlen;		/* media address length */
169 	u_char	ifi_hdrlen;		/* media header length */
170 	int	ifi_link_state;		/* current link state */
171 	u_quad_t ifi_mtu;		/* maximum transmission unit */
172 	u_quad_t ifi_metric;		/* routing metric (external only) */
173 	u_quad_t ifi_baudrate;		/* linespeed */
174 	/* volatile statistics */
175 	u_quad_t ifi_ipackets;		/* packets received on interface */
176 	u_quad_t ifi_ierrors;		/* input errors on interface */
177 	u_quad_t ifi_opackets;		/* packets sent on interface */
178 	u_quad_t ifi_oerrors;		/* output errors on interface */
179 	u_quad_t ifi_collisions;	/* collisions on csma interfaces */
180 	u_quad_t ifi_ibytes;		/* total number of octets received */
181 	u_quad_t ifi_obytes;		/* total number of octets sent */
182 	u_quad_t ifi_imcasts;		/* packets received via multicast */
183 	u_quad_t ifi_omcasts;		/* packets sent via multicast */
184 	u_quad_t ifi_iqdrops;		/* dropped on input, this interface */
185 	u_quad_t ifi_noproto;		/* destined for unsupported protocol */
186 	struct	timeval ifi_lastchange;	/* last operational state change */
187 };
188 
189 /*
190  * Values for if_link_state.
191  */
192 #define	LINK_STATE_UNKNOWN	0	/* link invalid/unknown */
193 #define	LINK_STATE_DOWN		1	/* link is down */
194 #define	LINK_STATE_UP		2	/* link is up */
195 
196 #if defined(_KERNEL) && defined(COMPAT_14)
197 /* Pre-1.5 if_data struct */
198 struct if_data14 {
199 	/* generic interface information */
200 	u_char	ifi_type;		/* ethernet, tokenring, etc. */
201 	u_char	ifi_addrlen;		/* media address length */
202 	u_char	ifi_hdrlen;		/* media header length */
203 	u_long	ifi_mtu;		/* maximum transmission unit */
204 	u_long	ifi_metric;		/* routing metric (external only) */
205 	u_long	ifi_baudrate;		/* linespeed */
206 	/* volatile statistics */
207 	u_long	ifi_ipackets;		/* packets received on interface */
208 	u_long	ifi_ierrors;		/* input errors on interface */
209 	u_long	ifi_opackets;		/* packets sent on interface */
210 	u_long	ifi_oerrors;		/* output errors on interface */
211 	u_long	ifi_collisions;		/* collisions on csma interfaces */
212 	u_long	ifi_ibytes;		/* total number of octets received */
213 	u_long	ifi_obytes;		/* total number of octets sent */
214 	u_long	ifi_imcasts;		/* packets received via multicast */
215 	u_long	ifi_omcasts;		/* packets sent via multicast */
216 	u_long	ifi_iqdrops;		/* dropped on input, this interface */
217 	u_long	ifi_noproto;		/* destined for unsupported protocol */
218 	struct	timeval ifi_lastchange;	/* last operational state change */
219 };
220 #endif /* _KERNEL && COMPAT_14 */
221 
222 /*
223  * Structure defining a queue for a network interface.
224  */
225 struct ifqueue {
226 	struct	mbuf *ifq_head;
227 	struct	mbuf *ifq_tail;
228 	int	ifq_len;
229 	int	ifq_maxlen;
230 	int	ifq_drops;
231 };
232 
233 /*
234  * Structure defining a queue for a network interface.
235  *
236  * (Would like to call this struct ``if'', but C isn't PL/1.)
237  */
238 TAILQ_HEAD(ifnet_head, ifnet);		/* the actual queue head */
239 
240 struct ifnet {				/* and the entries */
241 	void	*if_softc;		/* lower-level data for this if */
242 	TAILQ_ENTRY(ifnet) if_list;	/* all struct ifnets are chained */
243 	TAILQ_HEAD(, ifaddr) if_addrlist; /* linked list of addresses per if */
244 	char	if_xname[IFNAMSIZ];	/* external name (name + unit) */
245 	int	if_pcount;		/* number of promiscuous listeners */
246 	caddr_t	if_bpf;			/* packet filter structure */
247 	u_short	if_index;		/* numeric abbreviation for this if */
248 	short	if_timer;		/* time 'til if_watchdog called */
249 	short	if_flags;		/* up/down, broadcast, etc. */
250 	short	if__pad1;		/* be nice to m68k ports */
251 	struct	if_data if_data;	/* statistics and other data about if */
252 	/*
253 	 * Procedure handles.  If you add more of these, don't forget the
254 	 * corresponding NULL stub in if.c.
255 	 */
256 	int	(*if_output)		/* output routine (enqueue) */
257 		__P((struct ifnet *, struct mbuf *, struct sockaddr *,
258 		     struct rtentry *));
259 	void	(*if_input)		/* input routine (from h/w driver) */
260 		__P((struct ifnet *, struct mbuf *));
261 	void	(*if_start)		/* initiate output routine */
262 		__P((struct ifnet *));
263 	int	(*if_ioctl)		/* ioctl routine */
264 		__P((struct ifnet *, u_long, caddr_t));
265 	int	(*if_init)		/* init routine */
266 		__P((struct ifnet *));
267 	void	(*if_stop)		/* stop routine */
268 		__P((struct ifnet *, int));
269 	void	(*if_watchdog)		/* timer routine */
270 		__P((struct ifnet *));
271 	void	(*if_drain)		/* routine to release resources */
272 		__P((struct ifnet *));
273 	struct ifaltq if_snd;		/* output queue (includes altq) */
274 	struct	sockaddr_dl *if_sadl;	/* pointer to our sockaddr_dl */
275 	u_int8_t *if_broadcastaddr;	/* linklevel broadcast bytestring */
276 	struct ifprefix *if_prefixlist; /* linked list of prefixes per if */
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@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 splimp().
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 (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  * The prefix structure contains information about one prefix
435  * of an interface.  They are maintained by the different address families,
436  * are allocated and attached when an prefix or an address is set,
437  * and are linked together so all prfefixes for an interface can be located.
438  */
439 struct ifprefix {
440 	struct	sockaddr *ifpr_prefix;	/* prefix of interface */
441 	struct	ifnet *ifpr_ifp;	/* back-pointer to interface */
442 	struct ifprefix *ifpr_next;
443 	u_char	ifpr_plen;		/* prefix length in bits */
444 	u_char	ifpr_type;		/* protocol dependent prefix type */
445 };
446 
447 /*
448  * Message format for use in obtaining information about interfaces
449  * from sysctl and the routing socket.
450  */
451 struct if_msghdr {
452 	u_short	ifm_msglen;	/* to skip over non-understood messages */
453 	u_char	ifm_version;	/* future binary compatibility */
454 	u_char	ifm_type;	/* message type */
455 	int	ifm_addrs;	/* like rtm_addrs */
456 	int	ifm_flags;	/* value of if_flags */
457 	u_short	ifm_index;	/* index for associated ifp */
458 	struct	if_data ifm_data;/* statistics and other data about if */
459 };
460 
461 #if defined(_KERNEL) && defined(COMPAT_14)
462 /* pre-1.5 if_msghdr (ifm_data changed) */
463 struct if_msghdr14 {
464 	u_short	ifm_msglen;	/* to skip over non-understood messages */
465 	u_char	ifm_version;	/* future binary compatibility */
466 	u_char	ifm_type;	/* message type */
467 	int	ifm_addrs;	/* like rtm_addrs */
468 	int	ifm_flags;	/* value of if_flags */
469 	u_short	ifm_index;	/* index for associated ifp */
470 	struct	if_data14 ifm_data; /* statistics and other data about if */
471 };
472 #endif /* _KERNEL && COMPAT_14 */
473 
474 /*
475  * Message format for use in obtaining information about interface addresses
476  * from sysctl and the routing socket.
477  */
478 struct ifa_msghdr {
479 	u_short	ifam_msglen;	/* to skip over non-understood messages */
480 	u_char	ifam_version;	/* future binary compatibility */
481 	u_char	ifam_type;	/* message type */
482 	int	ifam_addrs;	/* like rtm_addrs */
483 	int	ifam_flags;	/* value of ifa_flags */
484 	u_short	ifam_index;	/* index for associated ifp */
485 	int	ifam_metric;	/* value of ifa_metric */
486 };
487 
488 /*
489  * Message format announcing the arrival or departure of a network interface.
490  */
491 struct if_announcemsghdr {
492 	u_short	ifan_msglen;	/* to skip over non-understood messages */
493 	u_char	ifan_version;	/* future binary compatibility */
494 	u_char	ifan_type;	/* message type */
495 	u_short	ifan_index;	/* index for associated ifp */
496 	char	ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
497 	u_short	ifan_what;	/* what type of announcement */
498 };
499 
500 #define	IFAN_ARRIVAL	0	/* interface arrival */
501 #define	IFAN_DEPARTURE	1	/* interface departure */
502 
503 /*
504  * Interface request structure used for socket
505  * ioctl's.  All interface ioctl's must have parameter
506  * definitions which begin with ifr_name.  The
507  * remainder may be interface specific.
508  */
509 struct	ifreq {
510 	char	ifr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
511 	union {
512 		struct	sockaddr ifru_addr;
513 		struct	sockaddr ifru_dstaddr;
514 		struct	sockaddr ifru_broadaddr;
515 		short	ifru_flags;
516 		int	ifru_metric;
517 		int	ifru_mtu;
518 		int	ifru_dlt;
519 		u_int	ifru_value;
520 		caddr_t	ifru_data;
521 	} ifr_ifru;
522 #define	ifr_addr	ifr_ifru.ifru_addr	/* address */
523 #define	ifr_dstaddr	ifr_ifru.ifru_dstaddr	/* other end of p-to-p link */
524 #define	ifr_broadaddr	ifr_ifru.ifru_broadaddr	/* broadcast address */
525 #define	ifr_flags	ifr_ifru.ifru_flags	/* flags */
526 #define	ifr_metric	ifr_ifru.ifru_metric	/* metric */
527 #define	ifr_mtu		ifr_ifru.ifru_mtu	/* mtu */
528 #define	ifr_dlt		ifr_ifru.ifru_dlt	/* data link type (DLT_*) */
529 #define	ifr_value	ifr_ifru.ifru_value	/* generic value */
530 #define	ifr_media	ifr_ifru.ifru_metric	/* media options (overload) */
531 #define	ifr_data	ifr_ifru.ifru_data	/* for use by interface */
532 };
533 
534 struct ifcapreq {
535 	char		ifcr_name[IFNAMSIZ];	/* if name, e.g. "en0" */
536 	uint64_t	ifcr_capabilities;	/* supported capabiliites */
537 	uint64_t	ifcr_capenable;		/* capabilities enabled */
538 };
539 
540 struct ifaliasreq {
541 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
542 	struct	sockaddr ifra_addr;
543 	struct	sockaddr ifra_dstaddr;
544 #define	ifra_broadaddr	ifra_dstaddr
545 	struct	sockaddr ifra_mask;
546 };
547 
548 struct ifdatareq {
549 	char	ifdr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
550 	struct	if_data ifdr_data;
551 };
552 
553 struct ifmediareq {
554 	char	ifm_name[IFNAMSIZ];		/* if name, e.g. "en0" */
555 	int	ifm_current;			/* current media options */
556 	int	ifm_mask;			/* don't care mask */
557 	int	ifm_status;			/* media status */
558 	int	ifm_active;			/* active options */
559 	int	ifm_count;			/* # entries in ifm_ulist
560 						   array */
561 	int	*ifm_ulist;			/* media words */
562 };
563 
564 
565 struct  ifdrv {
566 	char		ifd_name[IFNAMSIZ];	/* if name, e.g. "en0" */
567 	unsigned long	ifd_cmd;
568 	size_t		ifd_len;
569 	void		*ifd_data;
570 };
571 
572 /*
573  * Structure used in SIOCGIFCONF request.
574  * Used to retrieve interface configuration
575  * for machine (useful for programs which
576  * must know all networks accessible).
577  */
578 struct	ifconf {
579 	int	ifc_len;		/* size of associated buffer */
580 	union {
581 		caddr_t	ifcu_buf;
582 		struct	ifreq *ifcu_req;
583 	} ifc_ifcu;
584 #define	ifc_buf	ifc_ifcu.ifcu_buf	/* buffer address */
585 #define	ifc_req	ifc_ifcu.ifcu_req	/* array of structures returned */
586 };
587 
588 /*
589  * Structure for SIOC[AGD]LIFADDR
590  */
591 struct if_laddrreq {
592 	char iflr_name[IFNAMSIZ];
593 	unsigned int flags;
594 #define IFLR_PREFIX	0x8000	/* in: prefix given  out: kernel fills id */
595 	unsigned int prefixlen;		/* in/out */
596 	struct sockaddr_storage addr;	/* in/out */
597 	struct sockaddr_storage dstaddr; /* out */
598 };
599 
600 #include <net/if_arp.h>
601 
602 #endif /* !_XOPEN_SOURCE */
603 
604 #ifdef _KERNEL
605 #ifdef IFAREF_DEBUG
606 #define	IFAREF(ifa)							\
607 do {									\
608 	printf("IFAREF: %s:%d %p -> %d\n", __FILE__, __LINE__,		\
609 	    (ifa), ++(ifa)->ifa_refcnt);				\
610 } while (0)
611 
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 	printf("IFAFREE: %s:%d %p -> %d\n", __FILE__, __LINE__,		\
618 	    (ifa), --(ifa)->ifa_refcnt);				\
619 	if ((ifa)->ifa_refcnt == 0)					\
620 		ifafree(ifa);						\
621 } while (0)
622 #else
623 #define	IFAREF(ifa)	(ifa)->ifa_refcnt++
624 
625 #ifdef DIAGNOSTIC
626 #define	IFAFREE(ifa)							\
627 do {									\
628 	if ((ifa)->ifa_refcnt <= 0)					\
629 		panic("%s:%d: %p ifa_refcnt <= 0", __FILE__,		\
630 		    __LINE__, (ifa));					\
631 	if (--(ifa)->ifa_refcnt == 0)					\
632 		ifafree(ifa);						\
633 } while (0)
634 #else
635 #define	IFAFREE(ifa)							\
636 do {									\
637 	if (--(ifa)->ifa_refcnt == 0)					\
638 		ifafree(ifa);						\
639 } while (0)
640 #endif /* DIAGNOSTIC */
641 #endif /* IFAREF_DEBUG */
642 
643 #ifdef ALTQ
644 #define	ALTQ_DECL(x)		x
645 
646 #define IFQ_ENQUEUE(ifq, m, pattr, err)					\
647 do {									\
648 	if (ALTQ_IS_ENABLED((ifq)))					\
649 		ALTQ_ENQUEUE((ifq), (m), (pattr), (err));		\
650 	else {								\
651 		if (IF_QFULL((ifq))) {					\
652 			m_freem((m));					\
653 			(err) = ENOBUFS;				\
654 		} else {						\
655 			IF_ENQUEUE((ifq), (m));				\
656 			(err) = 0;					\
657 		}							\
658 	}								\
659 	if ((err))							\
660 		(ifq)->ifq_drops++;					\
661 } while (0)
662 
663 #define IFQ_DEQUEUE(ifq, m)						\
664 do {									\
665 	if (TBR_IS_ENABLED((ifq)))					\
666 		(m) = tbr_dequeue((ifq), ALTDQ_REMOVE);			\
667 	else if (ALTQ_IS_ENABLED((ifq)))				\
668 		ALTQ_DEQUEUE((ifq), (m));				\
669 	else								\
670 		IF_DEQUEUE((ifq), (m));					\
671 } while (0)
672 
673 #define	IFQ_POLL(ifq, m)						\
674 do {									\
675 	if (TBR_IS_ENABLED((ifq)))					\
676 		(m) = tbr_dequeue((ifq), ALTDQ_POLL);			\
677 	else if (ALTQ_IS_ENABLED((ifq)))				\
678 		ALTQ_POLL((ifq), (m));					\
679 	else								\
680 		IF_POLL((ifq), (m));					\
681 } while (0)
682 
683 #define	IFQ_PURGE(ifq)							\
684 do {									\
685 	if (ALTQ_IS_ENABLED((ifq)))					\
686 		ALTQ_PURGE((ifq));					\
687 	else								\
688 		IF_PURGE((ifq));					\
689 } while (0)
690 
691 #define	IFQ_SET_READY(ifq)						\
692 do {									\
693 	(ifq)->altq_flags |= ALTQF_READY;				\
694 } while (0)
695 
696 #define	IFQ_CLASSIFY(ifq, m, af, pa)					\
697 do {									\
698 	if (ALTQ_IS_ENABLED((ifq))) {					\
699 		if (ALTQ_NEEDS_CLASSIFY((ifq)))				\
700 			(pa)->pattr_class = (*(ifq)->altq_classify)	\
701 				((ifq)->altq_clfier, (m), (af));	\
702 		(pa)->pattr_af = (af);					\
703 		(pa)->pattr_hdr = mtod((m), caddr_t);			\
704 	}								\
705 } while (0)
706 #else /* ! ALTQ */
707 #define	ALTQ_DECL(x)		/* nothing */
708 
709 #define	IFQ_ENQUEUE(ifq, m, pattr, err)					\
710 do {									\
711 	if (IF_QFULL((ifq))) {						\
712 		m_freem((m));						\
713 		(err) = ENOBUFS;					\
714 	} else {							\
715 		IF_ENQUEUE((ifq), (m));					\
716 		(err) = 0;						\
717 	}								\
718 	if ((err))							\
719 		(ifq)->ifq_drops++;					\
720 } while (0)
721 
722 #define	IFQ_DEQUEUE(ifq, m)	IF_DEQUEUE((ifq), (m))
723 
724 #define	IFQ_POLL(ifq, m)	IF_POLL((ifq), (m))
725 
726 #define	IFQ_PURGE(ifq)		IF_PURGE((ifq))
727 
728 #define	IFQ_SET_READY(ifq)	/* nothing */
729 
730 #define	IFQ_CLASSIFY(ifq, m, af, pa) /* nothing */
731 
732 #endif /* ALTQ */
733 
734 #define	IFQ_IS_EMPTY(ifq)		IF_IS_EMPTY((ifq))
735 #define	IFQ_INC_LEN(ifq)		((ifq)->ifq_len++)
736 #define	IFQ_DEC_LEN(ifq)		(--(ifq)->ifq_len)
737 #define	IFQ_INC_DROPS(ifq)		((ifq)->ifq_drops++)
738 #define	IFQ_SET_MAXLEN(ifq, len)	((ifq)->ifq_maxlen = (len))
739 
740 extern struct ifnet_head ifnet;
741 extern struct ifnet **ifindex2ifnet;
742 #if 0
743 struct ifnet loif[];
744 #endif
745 extern int if_index;
746 
747 char	*ether_sprintf __P((const u_char *));
748 
749 void	if_alloc_sadl __P((struct ifnet *));
750 void	if_free_sadl __P((struct ifnet *));
751 void	if_attach __P((struct ifnet *));
752 void	if_attachdomain __P((void));
753 void	if_attachdomain1 __P((struct ifnet *));
754 void	if_deactivate __P((struct ifnet *));
755 void	if_detach __P((struct ifnet *));
756 void	if_down __P((struct ifnet *));
757 void	if_slowtimo __P((void *));
758 void	if_up __P((struct ifnet *));
759 int	ifconf __P((u_long, caddr_t));
760 void	ifinit __P((void));
761 int	ifioctl __P((struct socket *, u_long, caddr_t, struct proc *));
762 int	ifpromisc __P((struct ifnet *, int));
763 struct	ifnet *ifunit __P((const char *));
764 
765 struct	ifaddr *ifa_ifwithaddr __P((struct sockaddr *));
766 struct	ifaddr *ifa_ifwithaf __P((int));
767 struct	ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *));
768 struct	ifaddr *ifa_ifwithnet __P((struct sockaddr *));
769 struct	ifaddr *ifa_ifwithladdr __P((struct sockaddr *));
770 struct	ifaddr *ifa_ifwithroute __P((int, struct sockaddr *,
771 					struct sockaddr *));
772 struct	ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *));
773 void	ifafree __P((struct ifaddr *));
774 void	link_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *));
775 
776 void	if_clone_attach __P((struct if_clone *));
777 void	if_clone_detach __P((struct if_clone *));
778 
779 int	if_clone_create __P((const char *));
780 int	if_clone_destroy __P((const char *));
781 
782 int	loioctl __P((struct ifnet *, u_long, caddr_t));
783 void	loopattach __P((int));
784 int	looutput __P((struct ifnet *,
785 	   struct mbuf *, struct sockaddr *, struct rtentry *));
786 void	lortrequest __P((int, struct rtentry *, struct rt_addrinfo *));
787 
788 /*
789  * These are exported because they're an easy way to tell if
790  * an interface is going away without having to burn a flag.
791  */
792 int	if_nulloutput __P((struct ifnet *, struct mbuf *,
793 	    struct sockaddr *, struct rtentry *));
794 void	if_nullinput __P((struct ifnet *, struct mbuf *));
795 void	if_nullstart __P((struct ifnet *));
796 int	if_nullioctl __P((struct ifnet *, u_long, caddr_t));
797 int	if_nullinit __P((struct ifnet *));
798 void	if_nullstop __P((struct ifnet *, int));
799 void	if_nullwatchdog __P((struct ifnet *));
800 void	if_nulldrain __P((struct ifnet *));
801 #else
802 struct if_nameindex {
803 	unsigned int	if_index;	/* 1, 2, ... */
804 	char		*if_name;	/* null terminated name: "le0", ... */
805 };
806 
807 #include <sys/cdefs.h>
808 __BEGIN_DECLS
809 unsigned int if_nametoindex __P((const char *));
810 char *	if_indextoname __P((unsigned int, char *));
811 struct	if_nameindex * if_nameindex __P((void));
812 void	if_freenameindex __P((struct if_nameindex *));
813 __END_DECLS
814 #endif /* _KERNEL */
815 #endif /* !_NET_IF_H_ */
816