xref: /netbsd-src/sys/net/if.h (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1 /*	$NetBSD: if.h,v 1.96 2004/04/21 04:17:28 matt 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. Neither the name of the University nor the names of its contributors
52  *    may be used to endorse or promote products derived from this software
53  *    without specific prior written permission.
54  *
55  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
56  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
57  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
58  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
59  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
60  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
61  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
62  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
63  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
64  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
65  * SUCH DAMAGE.
66  *
67  *	@(#)if.h	8.3 (Berkeley) 2/9/95
68  */
69 
70 #ifndef _NET_IF_H_
71 #define _NET_IF_H_
72 
73 #include <sys/featuretest.h>
74 
75 /*
76  * Length of interface external name, including terminating '\0'.
77  * Note: this is the same size as a generic device's external name.
78  */
79 #define IF_NAMESIZE 16
80 
81 #if defined(_NETBSD_SOURCE)
82 
83 #include <sys/socket.h>
84 #include <sys/queue.h>
85 #include <net/dlt.h>
86 #include <net/pfil.h>
87 
88 /*
89  * Always include ALTQ glue here -- we use the ALTQ interface queue
90  * structure even when ALTQ is not configured into the kernel so that
91  * the size of struct ifnet does not changed based on the option.  The
92  * ALTQ queue structure is API-compatible with the legacy ifqueue.
93  */
94 #include <altq/if_altq.h>
95 
96 /*
97  * Structures defining a network interface, providing a packet
98  * transport mechanism (ala level 0 of the PUP protocols).
99  *
100  * Each interface accepts output datagrams of a specified maximum
101  * length, and provides higher level routines with input datagrams
102  * received from its medium.
103  *
104  * Output occurs when the routine if_output is called, with four parameters:
105  *	(*ifp->if_output)(ifp, m, dst, rt)
106  * Here m is the mbuf chain to be sent and dst is the destination address.
107  * The output routine encapsulates the supplied datagram if necessary,
108  * and then transmits it on its medium.
109  *
110  * On input, each interface unwraps the data received by it, and either
111  * places it on the input queue of a internetwork datagram routine
112  * and posts the associated software interrupt, or passes the datagram to a raw
113  * packet input routine.
114  *
115  * Routines exist for locating interfaces by their addresses
116  * or for locating a interface on a certain network, as well as more general
117  * routing and gateway routines maintaining information used to locate
118  * interfaces.  These routines live in the files if.c and route.c
119  */
120 /*  XXX fast fix for SNMP, going away soon */
121 #include <sys/time.h>
122 
123 #if defined(_KERNEL_OPT)
124 #include "opt_compat_netbsd.h"
125 #endif
126 
127 struct mbuf;
128 struct proc;
129 struct rtentry;
130 struct socket;
131 struct ether_header;
132 struct ifnet;
133 struct rt_addrinfo;
134 
135 #define	IFNAMSIZ	IF_NAMESIZE
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 	void	*if_bridge;		/* bridge glue */
277 	int	if_dlt;			/* data link type (<net/dlt.h>) */
278 	struct pfil_head if_pfil;	/* filtering point */
279 	uint64_t if_capabilities;	/* interface capabilities */
280 	uint64_t if_capenable;		/* capabilities enabled */
281 
282 	/*
283 	 * These are pre-computed based on an interfaces enabled
284 	 * capabilities, for speed elsewhere.
285 	 */
286 	int	if_csum_flags_tx;	/* M_CSUM_* flags for Tx */
287 	int	if_csum_flags_rx;	/* M_CSUM_* flags for Rx */
288 
289 	void	*if_afdata[AF_MAX];
290 	struct	mowner *if_mowner;	/* who owns mbufs for this interface */
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 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 #ifndef IFQ_MAXLEN
400 #define	IFQ_MAXLEN	50
401 #endif
402 #define	IFNET_SLOWHZ	1		/* granularity is 1 second */
403 
404 /*
405  * Structure defining statistics and other data kept regarding an address
406  * on a network interface.
407  */
408 struct ifaddr_data {
409 	int64_t	ifad_inbytes;
410 	int64_t	ifad_outbytes;
411 };
412 
413 /*
414  * The ifaddr structure contains information about one address
415  * of an interface.  They are maintained by the different address families,
416  * are allocated and attached when an address is set, and are linked
417  * together so all addresses for an interface can be located.
418  */
419 struct ifaddr {
420 	struct	sockaddr *ifa_addr;	/* address of interface */
421 	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
422 #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
423 	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
424 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
425 	TAILQ_ENTRY(ifaddr) ifa_list;	/* list of addresses for interface */
426 	struct	ifaddr_data	ifa_data;	/* statistics on the address */
427 	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
428 		    __P((int, struct rtentry *, struct rt_addrinfo *));
429 	u_int	ifa_flags;		/* mostly rt_flags for cloning */
430 	int	ifa_refcnt;		/* count of references */
431 	int	ifa_metric;		/* cost of going out this interface */
432 };
433 #define	IFA_ROUTE	RTF_UP /* 0x01 *//* route installed */
434 
435 /*
436  * Message format for use in obtaining information about interfaces
437  * from sysctl and the routing socket.
438  */
439 struct if_msghdr {
440 	u_short	ifm_msglen;	/* to skip over non-understood messages */
441 	u_char	ifm_version;	/* future binary compatibility */
442 	u_char	ifm_type;	/* message type */
443 	int	ifm_addrs;	/* like rtm_addrs */
444 	int	ifm_flags;	/* value of if_flags */
445 	u_short	ifm_index;	/* index for associated ifp */
446 	struct	if_data ifm_data;/* statistics and other data about if */
447 };
448 
449 #if defined(_KERNEL) && defined(COMPAT_14)
450 /* pre-1.5 if_msghdr (ifm_data changed) */
451 struct if_msghdr14 {
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_data14 ifm_data; /* statistics and other data about if */
459 };
460 #endif /* _KERNEL && COMPAT_14 */
461 
462 /*
463  * Message format for use in obtaining information about interface addresses
464  * from sysctl and the routing socket.
465  */
466 struct ifa_msghdr {
467 	u_short	ifam_msglen;	/* to skip over non-understood messages */
468 	u_char	ifam_version;	/* future binary compatibility */
469 	u_char	ifam_type;	/* message type */
470 	int	ifam_addrs;	/* like rtm_addrs */
471 	int	ifam_flags;	/* value of ifa_flags */
472 	u_short	ifam_index;	/* index for associated ifp */
473 	int	ifam_metric;	/* value of ifa_metric */
474 };
475 
476 /*
477  * Message format announcing the arrival or departure of a network interface.
478  */
479 struct if_announcemsghdr {
480 	u_short	ifan_msglen;	/* to skip over non-understood messages */
481 	u_char	ifan_version;	/* future binary compatibility */
482 	u_char	ifan_type;	/* message type */
483 	u_short	ifan_index;	/* index for associated ifp */
484 	char	ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
485 	u_short	ifan_what;	/* what type of announcement */
486 };
487 
488 #define	IFAN_ARRIVAL	0	/* interface arrival */
489 #define	IFAN_DEPARTURE	1	/* interface departure */
490 
491 /*
492  * Interface request structure used for socket
493  * ioctl's.  All interface ioctl's must have parameter
494  * definitions which begin with ifr_name.  The
495  * remainder may be interface specific.
496  */
497 struct	ifreq {
498 	char	ifr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
499 	union {
500 		struct	sockaddr ifru_addr;
501 		struct	sockaddr ifru_dstaddr;
502 		struct	sockaddr ifru_broadaddr;
503 		short	ifru_flags;
504 		int	ifru_metric;
505 		int	ifru_mtu;
506 		int	ifru_dlt;
507 		u_int	ifru_value;
508 		caddr_t	ifru_data;
509 	} ifr_ifru;
510 #define	ifr_addr	ifr_ifru.ifru_addr	/* address */
511 #define	ifr_dstaddr	ifr_ifru.ifru_dstaddr	/* other end of p-to-p link */
512 #define	ifr_broadaddr	ifr_ifru.ifru_broadaddr	/* broadcast address */
513 #define	ifr_flags	ifr_ifru.ifru_flags	/* flags */
514 #define	ifr_metric	ifr_ifru.ifru_metric	/* metric */
515 #define	ifr_mtu		ifr_ifru.ifru_mtu	/* mtu */
516 #define	ifr_dlt		ifr_ifru.ifru_dlt	/* data link type (DLT_*) */
517 #define	ifr_value	ifr_ifru.ifru_value	/* generic value */
518 #define	ifr_media	ifr_ifru.ifru_metric	/* media options (overload) */
519 #define	ifr_data	ifr_ifru.ifru_data	/* for use by interface */
520 };
521 
522 struct ifcapreq {
523 	char		ifcr_name[IFNAMSIZ];	/* if name, e.g. "en0" */
524 	uint64_t	ifcr_capabilities;	/* supported capabiliites */
525 	uint64_t	ifcr_capenable;		/* capabilities enabled */
526 };
527 
528 struct ifaliasreq {
529 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
530 	struct	sockaddr ifra_addr;
531 	struct	sockaddr ifra_dstaddr;
532 #define	ifra_broadaddr	ifra_dstaddr
533 	struct	sockaddr ifra_mask;
534 };
535 
536 struct ifdatareq {
537 	char	ifdr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
538 	struct	if_data ifdr_data;
539 };
540 
541 struct ifmediareq {
542 	char	ifm_name[IFNAMSIZ];		/* if name, e.g. "en0" */
543 	int	ifm_current;			/* current media options */
544 	int	ifm_mask;			/* don't care mask */
545 	int	ifm_status;			/* media status */
546 	int	ifm_active;			/* active options */
547 	int	ifm_count;			/* # entries in ifm_ulist
548 						   array */
549 	int	*ifm_ulist;			/* media words */
550 };
551 
552 
553 struct  ifdrv {
554 	char		ifd_name[IFNAMSIZ];	/* if name, e.g. "en0" */
555 	unsigned long	ifd_cmd;
556 	size_t		ifd_len;
557 	void		*ifd_data;
558 };
559 
560 /*
561  * Structure used in SIOCGIFCONF request.
562  * Used to retrieve interface configuration
563  * for machine (useful for programs which
564  * must know all networks accessible).
565  */
566 struct	ifconf {
567 	int	ifc_len;		/* size of associated buffer */
568 	union {
569 		caddr_t	ifcu_buf;
570 		struct	ifreq *ifcu_req;
571 	} ifc_ifcu;
572 #define	ifc_buf	ifc_ifcu.ifcu_buf	/* buffer address */
573 #define	ifc_req	ifc_ifcu.ifcu_req	/* array of structures returned */
574 };
575 
576 /*
577  * Structure for SIOC[AGD]LIFADDR
578  */
579 struct if_laddrreq {
580 	char iflr_name[IFNAMSIZ];
581 	unsigned int flags;
582 #define IFLR_PREFIX	0x8000	/* in: prefix given  out: kernel fills id */
583 	unsigned int prefixlen;		/* in/out */
584 	struct sockaddr_storage addr;	/* in/out */
585 	struct sockaddr_storage dstaddr; /* out */
586 };
587 
588 #include <net/if_arp.h>
589 
590 #endif /* _NETBSD_SOURCE */
591 
592 #ifdef _KERNEL
593 #ifdef IFAREF_DEBUG
594 #define	IFAREF(ifa)							\
595 do {									\
596 	printf("IFAREF: %s:%d %p -> %d\n", __FILE__, __LINE__,		\
597 	    (ifa), ++(ifa)->ifa_refcnt);				\
598 } while (/*CONSTCOND*/ 0)
599 
600 #define	IFAFREE(ifa)							\
601 do {									\
602 	if ((ifa)->ifa_refcnt <= 0)					\
603 		panic("%s:%d: %p ifa_refcnt <= 0", __FILE__,		\
604 		    __LINE__, (ifa));					\
605 	printf("IFAFREE: %s:%d %p -> %d\n", __FILE__, __LINE__,		\
606 	    (ifa), --(ifa)->ifa_refcnt);				\
607 	if ((ifa)->ifa_refcnt == 0)					\
608 		ifafree(ifa);						\
609 } while (/*CONSTCOND*/ 0)
610 #else
611 #define	IFAREF(ifa)	(ifa)->ifa_refcnt++
612 
613 #ifdef DIAGNOSTIC
614 #define	IFAFREE(ifa)							\
615 do {									\
616 	if ((ifa)->ifa_refcnt <= 0)					\
617 		panic("%s:%d: %p ifa_refcnt <= 0", __FILE__,		\
618 		    __LINE__, (ifa));					\
619 	if (--(ifa)->ifa_refcnt == 0)					\
620 		ifafree(ifa);						\
621 } while (/*CONSTCOND*/ 0)
622 #else
623 #define	IFAFREE(ifa)							\
624 do {									\
625 	if (--(ifa)->ifa_refcnt == 0)					\
626 		ifafree(ifa);						\
627 } while (/*CONSTCOND*/ 0)
628 #endif /* DIAGNOSTIC */
629 #endif /* IFAREF_DEBUG */
630 
631 #ifdef ALTQ
632 #define	ALTQ_DECL(x)		x
633 
634 #define IFQ_ENQUEUE(ifq, m, pattr, err)					\
635 do {									\
636 	if (ALTQ_IS_ENABLED((ifq)))					\
637 		ALTQ_ENQUEUE((ifq), (m), (pattr), (err));		\
638 	else {								\
639 		if (IF_QFULL((ifq))) {					\
640 			m_freem((m));					\
641 			(err) = ENOBUFS;				\
642 		} else {						\
643 			IF_ENQUEUE((ifq), (m));				\
644 			(err) = 0;					\
645 		}							\
646 	}								\
647 	if ((err))							\
648 		(ifq)->ifq_drops++;					\
649 } while (/*CONSTCOND*/ 0)
650 
651 #define IFQ_DEQUEUE(ifq, m)						\
652 do {									\
653 	if (TBR_IS_ENABLED((ifq)))					\
654 		(m) = tbr_dequeue((ifq), ALTDQ_REMOVE);			\
655 	else if (ALTQ_IS_ENABLED((ifq)))				\
656 		ALTQ_DEQUEUE((ifq), (m));				\
657 	else								\
658 		IF_DEQUEUE((ifq), (m));					\
659 } while (/*CONSTCOND*/ 0)
660 
661 #define	IFQ_POLL(ifq, m)						\
662 do {									\
663 	if (TBR_IS_ENABLED((ifq)))					\
664 		(m) = tbr_dequeue((ifq), ALTDQ_POLL);			\
665 	else if (ALTQ_IS_ENABLED((ifq)))				\
666 		ALTQ_POLL((ifq), (m));					\
667 	else								\
668 		IF_POLL((ifq), (m));					\
669 } while (/*CONSTCOND*/ 0)
670 
671 #define	IFQ_PURGE(ifq)							\
672 do {									\
673 	if (ALTQ_IS_ENABLED((ifq)))					\
674 		ALTQ_PURGE((ifq));					\
675 	else								\
676 		IF_PURGE((ifq));					\
677 } while (/*CONSTCOND*/ 0)
678 
679 #define	IFQ_SET_READY(ifq)						\
680 do {									\
681 	(ifq)->altq_flags |= ALTQF_READY;				\
682 } while (/*CONSTCOND*/ 0)
683 
684 #define	IFQ_CLASSIFY(ifq, m, af, pa)					\
685 do {									\
686 	if (ALTQ_IS_ENABLED((ifq))) {					\
687 		if (ALTQ_NEEDS_CLASSIFY((ifq)))				\
688 			(pa)->pattr_class = (*(ifq)->altq_classify)	\
689 				((ifq)->altq_clfier, (m), (af));	\
690 		(pa)->pattr_af = (af);					\
691 		(pa)->pattr_hdr = mtod((m), caddr_t);			\
692 	}								\
693 } while (/*CONSTCOND*/ 0)
694 #else /* ! ALTQ */
695 #define	ALTQ_DECL(x)		/* nothing */
696 
697 #define	IFQ_ENQUEUE(ifq, m, pattr, err)					\
698 do {									\
699 	if (IF_QFULL((ifq))) {						\
700 		m_freem((m));						\
701 		(err) = ENOBUFS;					\
702 	} else {							\
703 		IF_ENQUEUE((ifq), (m));					\
704 		(err) = 0;						\
705 	}								\
706 	if ((err))							\
707 		(ifq)->ifq_drops++;					\
708 } while (/*CONSTCOND*/ 0)
709 
710 #define	IFQ_DEQUEUE(ifq, m)	IF_DEQUEUE((ifq), (m))
711 
712 #define	IFQ_POLL(ifq, m)	IF_POLL((ifq), (m))
713 
714 #define	IFQ_PURGE(ifq)		IF_PURGE((ifq))
715 
716 #define	IFQ_SET_READY(ifq)	/* nothing */
717 
718 #define	IFQ_CLASSIFY(ifq, m, af, pa) /* nothing */
719 
720 #endif /* ALTQ */
721 
722 #define	IFQ_IS_EMPTY(ifq)		IF_IS_EMPTY((ifq))
723 #define	IFQ_INC_LEN(ifq)		((ifq)->ifq_len++)
724 #define	IFQ_DEC_LEN(ifq)		(--(ifq)->ifq_len)
725 #define	IFQ_INC_DROPS(ifq)		((ifq)->ifq_drops++)
726 #define	IFQ_SET_MAXLEN(ifq, len)	((ifq)->ifq_maxlen = (len))
727 
728 #ifdef _KERNEL
729 #include <sys/mallocvar.h>
730 MALLOC_DECLARE(M_IFADDR);
731 MALLOC_DECLARE(M_IFMADDR);
732 #endif
733 
734 extern struct ifnet_head ifnet;
735 extern struct ifnet **ifindex2ifnet;
736 #if 0
737 struct ifnet loif[];
738 #endif
739 extern size_t if_indexlim;
740 
741 char	*ether_sprintf __P((const u_char *));
742 
743 void	if_alloc_sadl __P((struct ifnet *));
744 void	if_free_sadl __P((struct ifnet *));
745 void	if_attach __P((struct ifnet *));
746 void	if_attachdomain __P((void));
747 void	if_attachdomain1 __P((struct ifnet *));
748 void	if_deactivate __P((struct ifnet *));
749 void	if_detach __P((struct ifnet *));
750 void	if_down __P((struct ifnet *));
751 void	if_slowtimo __P((void *));
752 void	if_up __P((struct ifnet *));
753 int	ifconf __P((u_long, caddr_t));
754 void	ifinit __P((void));
755 int	ifioctl __P((struct socket *, u_long, caddr_t, struct proc *));
756 int	ifpromisc __P((struct ifnet *, int));
757 struct	ifnet *ifunit __P((const char *));
758 
759 struct	ifaddr *ifa_ifwithaddr __P((const struct sockaddr *));
760 struct	ifaddr *ifa_ifwithaf __P((int));
761 struct	ifaddr *ifa_ifwithdstaddr __P((const struct sockaddr *));
762 struct	ifaddr *ifa_ifwithnet __P((const struct sockaddr *));
763 struct	ifaddr *ifa_ifwithladdr __P((const struct sockaddr *));
764 struct	ifaddr *ifa_ifwithroute __P((int, const struct sockaddr *,
765 					const struct sockaddr *));
766 struct	ifaddr *ifaof_ifpforaddr __P((const struct sockaddr *, struct ifnet *));
767 void	ifafree __P((struct ifaddr *));
768 void	link_rtrequest __P((int, struct rtentry *, struct rt_addrinfo *));
769 
770 void	if_clone_attach __P((struct if_clone *));
771 void	if_clone_detach __P((struct if_clone *));
772 
773 int	if_clone_create __P((const char *));
774 int	if_clone_destroy __P((const char *));
775 
776 int	loioctl __P((struct ifnet *, u_long, caddr_t));
777 void	loopattach __P((int));
778 int	looutput __P((struct ifnet *,
779 	   struct mbuf *, struct sockaddr *, struct rtentry *));
780 void	lortrequest __P((int, struct rtentry *, struct rt_addrinfo *));
781 
782 /*
783  * These are exported because they're an easy way to tell if
784  * an interface is going away without having to burn a flag.
785  */
786 int	if_nulloutput __P((struct ifnet *, struct mbuf *,
787 	    struct sockaddr *, struct rtentry *));
788 void	if_nullinput __P((struct ifnet *, struct mbuf *));
789 void	if_nullstart __P((struct ifnet *));
790 int	if_nullioctl __P((struct ifnet *, u_long, caddr_t));
791 int	if_nullinit __P((struct ifnet *));
792 void	if_nullstop __P((struct ifnet *, int));
793 void	if_nullwatchdog __P((struct ifnet *));
794 void	if_nulldrain __P((struct ifnet *));
795 #else
796 struct if_nameindex {
797 	unsigned int	if_index;	/* 1, 2, ... */
798 	char		*if_name;	/* null terminated name: "le0", ... */
799 };
800 
801 #include <sys/cdefs.h>
802 __BEGIN_DECLS
803 unsigned int if_nametoindex __P((const char *));
804 char *	if_indextoname __P((unsigned int, char *));
805 struct	if_nameindex * if_nameindex __P((void));
806 void	if_freenameindex __P((struct if_nameindex *));
807 __END_DECLS
808 #endif /* _KERNEL */ /* XXX really ALTQ? */
809 
810 #ifdef _KERNEL
811 /*
812  * ifq sysctl support
813  */
814 int	sysctl_ifq __P((int *name, u_int namelen, void *oldp,
815 		       size_t *oldlenp, void *newp, size_t newlen,
816 		       struct ifqueue *ifq));
817 /* symbolic names for terminal (per-protocol) CTL_IFQ_ nodes */
818 #define IFQCTL_LEN 1
819 #define IFQCTL_MAXLEN 2
820 #define IFQCTL_PEAK 3
821 #define IFQCTL_DROPS 4
822 #define IFQCTL_MAXID 5
823 
824 #endif /* _KERNEL */
825 
826 #ifdef _NETBSD_SOURCE
827 /*
828  * sysctl for ifq (per-protocol packet input queue variant of ifqueue)
829  */
830 #define CTL_IFQ_NAMES  { \
831 	{ 0, 0 }, \
832 	{ "len", CTLTYPE_INT }, \
833 	{ "maxlen", CTLTYPE_INT }, \
834 	{ "peak", CTLTYPE_INT }, \
835 	{ "drops", CTLTYPE_INT }, \
836 }
837 #endif /* _NETBSD_SOURCE */
838 #endif /* !_NET_IF_H_ */
839