xref: /dflybsd-src/sys/net/if_var.h (revision 70e491c09b1cb18f96facdbc91052080f2a455c3)
1 /*
2  * Copyright (c) 1982, 1986, 1989, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	From: @(#)if.h	8.1 (Berkeley) 6/10/93
34  * $FreeBSD: src/sys/net/if_var.h,v 1.18.2.16 2003/04/15 18:11:19 fjoe Exp $
35  * $DragonFly: src/sys/net/if_var.h,v 1.71 2008/11/22 04:00:53 sephe Exp $
36  */
37 
38 #ifndef	_NET_IF_VAR_H_
39 #define	_NET_IF_VAR_H_
40 
41 #ifndef _SYS_SERIALIZE_H_
42 #include <sys/serialize.h>
43 #endif
44 #ifndef _NET_IF_H_
45 #include <net/if.h>
46 #endif
47 
48 /*
49  * Structures defining a network interface, providing a packet
50  * transport mechanism (ala level 0 of the PUP protocols).
51  *
52  * Each interface accepts output datagrams of a specified maximum
53  * length, and provides higher level routines with input datagrams
54  * received from its medium.
55  *
56  * Output occurs when the routine if_output is called, with four parameters:
57  *	ifp->if_output(ifp, m, dst, rt)
58  * Here m is the mbuf chain to be sent and dst is the destination address.
59  * The output routine encapsulates the supplied datagram if necessary,
60  * and then transmits it on its medium.
61  *
62  * On input, each interface unwraps the data received by it, and either
63  * places it on the input queue of a internetwork datagram routine
64  * and posts the associated software interrupt, or passes the datagram to
65  * the routine if_input. It is called with the mbuf chain as parameter:
66  *	ifp->if_input(ifp, m)
67  * The input routine removes the protocol dependent header if necessary.
68  *
69  * Routines exist for locating interfaces by their addresses
70  * or for locating a interface on a certain network, as well as more general
71  * routing and gateway routines maintaining information used to locate
72  * interfaces.  These routines live in the files if.c and route.c
73  */
74 
75 /*
76  * Forward structure declarations for function prototypes [sic].
77  */
78 struct	mbuf;
79 struct	mbuf_chain;
80 struct	proc;
81 struct	rtentry;
82 struct	rt_addrinfo;
83 struct	socket;
84 struct	ether_header;
85 struct	ucred;
86 struct	lwkt_serialize;
87 struct	ifaddr_container;
88 struct	ifaddr;
89 struct	lwkt_port;
90 struct	lwkt_msg;
91 struct	netmsg;
92 struct	pktinfo;
93 struct	ifpoll_info;
94 
95 #include <sys/queue.h>		/* get TAILQ macros */
96 
97 #include <net/altq/if_altq.h>
98 
99 #ifdef _KERNEL
100 #include <sys/eventhandler.h>
101 #include <sys/mbuf.h>
102 #include <sys/systm.h>		/* XXX */
103 #include <sys/thread2.h>
104 #endif /* _KERNEL */
105 
106 #define IF_DUNIT_NONE   -1
107 
108 TAILQ_HEAD(ifnethead, ifnet);	/* we use TAILQs so that the order of */
109 TAILQ_HEAD(ifaddrhead, ifaddr_container); /* instantiation is preserved in the list */
110 TAILQ_HEAD(ifprefixhead, ifprefix);
111 TAILQ_HEAD(ifmultihead, ifmultiaddr);
112 
113 /*
114  * Structure defining a queue for a network interface.
115  */
116 struct	ifqueue {
117 	struct	mbuf *ifq_head;
118 	struct	mbuf *ifq_tail;
119 	int	ifq_len;
120 	int	ifq_maxlen;
121 	int	ifq_drops;
122 };
123 
124 /*
125  * Note of DEVICE_POLLING
126  * 1) Any file(*.c) that depends on DEVICE_POLLING supports in this
127  *    file should include opt_polling.h at its beginning.
128  * 2) When struct changes, which are conditioned by DEVICE_POLLING,
129  *    are to be introduced, please keep the struct's size and layout
130  *    same, no matter whether DEVICE_POLLING is defined or not.
131  *    See ifnet.if_poll and ifnet.if_poll_unused for example.
132  */
133 
134 #ifdef DEVICE_POLLING
135 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER,
136 		POLL_REGISTER };
137 #endif
138 
139 enum ifnet_serialize {
140 	IFNET_SERIALIZE_ALL,
141 	IFNET_SERIALIZE_MAIN,
142 	IFNET_SERIALIZE_TX_BASE = 0x10000000,
143 	IFNET_SERIALIZE_RX_BASE = 0x20000000
144 };
145 #define IFNET_SERIALIZE_TX	IFNET_SERIALIZE_TX_BASE
146 #define IFNET_SERIALIZE_RX(i)	(IFNET_SERIALIZE_RX_BASE + (i))
147 
148 /*
149  * Structure defining a network interface.
150  *
151  * (Would like to call this struct ``if'', but C isn't PL/1.)
152  */
153 
154 /*
155  * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with
156  * one of these structures, typically held within an arpcom structure.
157  *
158  *	struct <foo>_softc {
159  *		struct arpcom {
160  *			struct  ifnet ac_if;
161  *			...
162  *		} <arpcom> ;
163  *		...
164  *	};
165  *
166  * The assumption is used in a number of places, including many
167  * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
168  *
169  * Unfortunately devices' softc are opaque, so we depend on this layout
170  * to locate the struct ifnet from the softc in the generic code.
171  *
172  * MPSAFE NOTES:
173  *
174  * ifnet is protected by calling if_serialize, if_tryserialize and
175  * if_deserialize serialize functions with the ifnet_serialize parameter.
176  * ifnet.if_snd is protected by its own spinlock.  Callers of if_ioctl,
177  * if_watchdog, if_init, if_resolvemulti, and if_poll should call the
178  * ifnet serialize functions with IFNET_SERIALIZE_ALL.  Callers of if_start
179  * sould call the ifnet serialize functions with IFNET_SERIALIZE_TX.
180  *
181  * FIXME: Device drivers usually use the same serializer for their interrupt
182  * FIXME: but this is not required.
183  *
184  * Caller of if_output must not serialize ifnet by calling ifnet serialize
185  * functions; if_output will call the ifnet serialize functions based on
186  * its own needs.  Caller of if_input does not necessarily hold the related
187  * serializer.
188  *
189  * If a device driver installs the same serializer for its interrupt
190  * as for ifnet, then the driver only really needs to worry about further
191  * serialization in timeout based entry points.  All other entry points
192  * will already be serialized.  Older ISA drivers still using the old
193  * interrupt infrastructure will have to obtain and release the serializer
194  * in their interrupt routine themselves.
195  */
196 struct ifnet {
197 	void	*if_softc;		/* pointer to driver state */
198 	void	*if_l2com;		/* pointer to protocol bits */
199 	TAILQ_ENTRY(ifnet) if_link;	/* all struct ifnets are chained */
200 	char	if_xname[IFNAMSIZ];	/* external name (name + unit) */
201 	const char *if_dname;		/* driver name */
202 	int	if_dunit;		/* unit or IF_DUNIT_NONE */
203 	void	*if_vlantrunks;		/* vlan trunks */
204 	struct	ifaddrhead *if_addrheads; /* array[NCPU] of TAILQs of addresses per if */
205 	int	if_pcount;		/* number of promiscuous listeners */
206 	void	*if_carp;		/* carp interfaces */
207 	struct	bpf_if *if_bpf;		/* packet filter structure */
208 	u_short	if_index;		/* numeric abbreviation for this if  */
209 	short	if_timer;		/* time 'til if_watchdog called */
210 	int	if_flags;		/* up/down, broadcast, etc. */
211 	int	if_capabilities;	/* interface capabilities */
212 	int	if_capenable;		/* enabled features */
213 	void	*if_linkmib;		/* link-type-specific MIB data */
214 	size_t	if_linkmiblen;		/* length of above data */
215 	struct	if_data if_data;
216 	struct	ifmultihead if_multiaddrs; /* multicast addresses configured */
217 	int	if_amcount;		/* number of all-multicast requests */
218 /* procedure handles */
219 	int	(*if_output)		/* output routine (enqueue) */
220 		(struct ifnet *, struct mbuf *, struct sockaddr *,
221 		     struct rtentry *);
222 	void	(*if_input)		/* input routine from hardware driver */
223 		(struct ifnet *, struct mbuf *);
224 	void	(*if_start)		/* initiate output routine */
225 		(struct ifnet *);
226 	int	(*if_ioctl)		/* ioctl routine */
227 		(struct ifnet *, u_long, caddr_t, struct ucred *);
228 	void	(*if_watchdog)		/* timer routine */
229 		(struct ifnet *);
230 	void	(*if_init)		/* Init routine */
231 		(void *);
232 	int	(*if_resolvemulti)	/* validate/resolve multicast */
233 		(struct ifnet *, struct sockaddr **, struct sockaddr *);
234 	int	(*if_start_cpuid)	/* cpuid to run if_start */
235 		(struct ifnet *);
236 #ifdef DEVICE_POLLING
237 	void	(*if_poll)		/* IFF_POLLING support */
238 		(struct ifnet *, enum poll_cmd, int);
239 	int	if_poll_cpuid;
240 #else
241 	/* Place holders */
242 	void	(*if_poll_unused)(void);
243 	int	if_poll_cpuid_used;
244 #endif
245 	void	(*if_serialize)
246 		(struct ifnet *, enum ifnet_serialize);
247 	void	(*if_deserialize)
248 		(struct ifnet *, enum ifnet_serialize);
249 	int	(*if_tryserialize)
250 		(struct ifnet *, enum ifnet_serialize);
251 #ifdef INVARIANTS
252 	void	(*if_serialize_assert)
253 		(struct ifnet *, enum ifnet_serialize, boolean_t);
254 #else
255 	/* Place holders */
256 	void	(*if_serialize_unused)(void);
257 #endif
258 #ifdef IFPOLL_ENABLE
259 	void	(*if_qpoll)
260 		(struct ifnet *, struct ifpoll_info *);
261 #else
262 	/* Place holders */
263 	void	(*if_qpoll_unused)(void);
264 #endif
265 	struct	ifaltq if_snd;		/* output queue (includes altq) */
266 	struct	ifprefixhead if_prefixhead; /* list of prefixes per if */
267 	const uint8_t	*if_broadcastaddr;
268 	void	*if_bridge;		/* bridge glue */
269 	void	*if_afdata[AF_MAX];
270 	struct ifaddr	*if_lladdr;
271 	struct lwkt_serialize *if_serializer;	/* serializer or MP lock */
272 	struct lwkt_serialize if_default_serializer; /* if not supplied */
273 	int	if_cpuid;
274 	struct netmsg *if_start_nmsg; /* percpu messages to schedule if_start */
275 };
276 typedef void if_init_f_t (void *);
277 
278 #define	if_mtu		if_data.ifi_mtu
279 #define	if_type		if_data.ifi_type
280 #define if_physical	if_data.ifi_physical
281 #define	if_addrlen	if_data.ifi_addrlen
282 #define	if_hdrlen	if_data.ifi_hdrlen
283 #define	if_metric	if_data.ifi_metric
284 #define	if_link_state	if_data.ifi_link_state
285 #define	if_baudrate	if_data.ifi_baudrate
286 #define	if_hwassist	if_data.ifi_hwassist
287 #define	if_ipackets	if_data.ifi_ipackets
288 #define	if_ierrors	if_data.ifi_ierrors
289 #define	if_opackets	if_data.ifi_opackets
290 #define	if_oerrors	if_data.ifi_oerrors
291 #define	if_collisions	if_data.ifi_collisions
292 #define	if_ibytes	if_data.ifi_ibytes
293 #define	if_obytes	if_data.ifi_obytes
294 #define	if_imcasts	if_data.ifi_imcasts
295 #define	if_omcasts	if_data.ifi_omcasts
296 #define	if_iqdrops	if_data.ifi_iqdrops
297 #define	if_noproto	if_data.ifi_noproto
298 #define	if_lastchange	if_data.ifi_lastchange
299 #define if_recvquota	if_data.ifi_recvquota
300 #define	if_xmitquota	if_data.ifi_xmitquota
301 #define if_rawoutput(if, m, sa) if_output(if, m, sa, NULL)
302 
303 /* for compatibility with other BSDs */
304 #define	if_list		if_link
305 
306 
307 /*
308  * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
309  * are queues of messages stored on ifqueue structures
310  * (defined above).  Entries are added to and deleted from these structures
311  * by these macros, which should be called with ipl raised to splimp().
312  */
313 #define	IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
314 #define	IF_DROP(ifq)		((ifq)->ifq_drops++)
315 #define	IF_QLEN(ifq)		((ifq)->ifq_len)
316 #define	IF_QEMPTY(ifq)		(IF_QLEN(ifq) == 0)
317 #define	IF_ENQUEUE(ifq, m) do {						\
318 	(m)->m_nextpkt = 0;						\
319 	if ((ifq)->ifq_tail == 0)					\
320 		(ifq)->ifq_head = m;					\
321 	else								\
322 		(ifq)->ifq_tail->m_nextpkt = m;				\
323 	(ifq)->ifq_tail = m;						\
324 	(ifq)->ifq_len++;						\
325 } while (0)
326 #define	IF_PREPEND(ifq, m) do {						\
327 	(m)->m_nextpkt = (ifq)->ifq_head;				\
328 	if ((ifq)->ifq_tail == 0)					\
329 		(ifq)->ifq_tail = (m);					\
330 	(ifq)->ifq_head = (m);						\
331 	(ifq)->ifq_len++;						\
332 } while (0)
333 #define	IF_DEQUEUE(ifq, m) do {						\
334 	(m) = (ifq)->ifq_head;						\
335 	if (m) {							\
336 		if (((ifq)->ifq_head = (m)->m_nextpkt) == 0)		\
337 			(ifq)->ifq_tail = 0;				\
338 		(m)->m_nextpkt = 0;					\
339 		(ifq)->ifq_len--;					\
340 	}								\
341 } while (0)
342 
343 #define	IF_POLL(ifq, m)		((m) = (ifq)->ifq_head)
344 
345 #define IF_DRAIN(ifq) do {						\
346 	struct mbuf *m;							\
347 	while (1) {							\
348 		IF_DEQUEUE(ifq, m);					\
349 		if (m == NULL)						\
350 			break;						\
351 		m_freem(m);						\
352 	}								\
353 } while (0)
354 
355 #ifdef _KERNEL
356 
357 /* interface link layer address change event */
358 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
359 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
360 
361 #ifdef INVARIANTS
362 #define ASSERT_IFNET_SERIALIZED_ALL(ifp) \
363 	(ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, TRUE)
364 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp) \
365 	(ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, FALSE)
366 
367 #define ASSERT_IFNET_SERIALIZED_TX(ifp) \
368 	(ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_TX, TRUE)
369 #define ASSERT_IFNET_NOT_SERIALIZED_TX(ifp) \
370 	(ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_TX, FALSE)
371 
372 #define ASSERT_IFNET_SERIALIZED_MAIN(ifp) \
373 	(ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_MAIN, TRUE)
374 #define ASSERT_IFNET_NOT_SERIALIZED_MAIN(ifp) \
375 	(ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_MAIN, FALSE)
376 #else
377 #define ASSERT_IFNET_SERIALIZED_ALL(ifp)	((void)0)
378 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp)	((void)0)
379 #define ASSERT_IFNET_SERIALIZED_TX(ifp)		((void)0)
380 #define ASSERT_IFNET_NOT_SERIALIZED_TX(ifp)	((void)0)
381 #define ASSERT_IFNET_SERIALIZED_MAIN(ifp)	((void)0)
382 #define ASSERT_IFNET_NOT_SERIALIZED_MAIN(ifp)	((void)0)
383 #endif
384 
385 static __inline void
386 ifnet_serialize_all(struct ifnet *_ifp)
387 {
388 	_ifp->if_serialize(_ifp, IFNET_SERIALIZE_ALL);
389 }
390 
391 static __inline void
392 ifnet_deserialize_all(struct ifnet *_ifp)
393 {
394 	_ifp->if_deserialize(_ifp, IFNET_SERIALIZE_ALL);
395 }
396 
397 static __inline int
398 ifnet_tryserialize_all(struct ifnet *_ifp)
399 {
400 	return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_ALL);
401 }
402 
403 static __inline void
404 ifnet_serialize_tx(struct ifnet *_ifp)
405 {
406 	_ifp->if_serialize(_ifp, IFNET_SERIALIZE_TX);
407 }
408 
409 static __inline void
410 ifnet_deserialize_tx(struct ifnet *_ifp)
411 {
412 	_ifp->if_deserialize(_ifp, IFNET_SERIALIZE_TX);
413 }
414 
415 static __inline int
416 ifnet_tryserialize_tx(struct ifnet *_ifp)
417 {
418 	return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_TX);
419 }
420 
421 static __inline void
422 ifnet_serialize_main(struct ifnet *_ifp)
423 {
424 	_ifp->if_serialize(_ifp, IFNET_SERIALIZE_MAIN);
425 }
426 
427 static __inline void
428 ifnet_deserialize_main(struct ifnet *_ifp)
429 {
430 	_ifp->if_deserialize(_ifp, IFNET_SERIALIZE_MAIN);
431 }
432 
433 static __inline int
434 ifnet_tryserialize_main(struct ifnet *_ifp)
435 {
436 	return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_MAIN);
437 }
438 
439 /*
440  * DEPRECATED - should not be used by any new driver.  This code uses the
441  * old queueing interface and if_start ABI and does not use the ifp's
442  * serializer.
443  */
444 #define IF_HANDOFF(ifq, m, ifp)			if_handoff(ifq, m, ifp, 0)
445 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj)	if_handoff(ifq, m, ifp, adj)
446 
447 static __inline int
448 if_handoff(struct ifqueue *_ifq, struct mbuf *_m, struct ifnet *_ifp,
449 	   int _adjust)
450 {
451 	int _need_if_start = 0;
452 
453 	crit_enter();
454 
455 	if (IF_QFULL(_ifq)) {
456 		IF_DROP(_ifq);
457 		crit_exit();
458 		m_freem(_m);
459 		return (0);
460 	}
461 	if (_ifp != NULL) {
462 		_ifp->if_obytes += _m->m_pkthdr.len + _adjust;
463 		if (_m->m_flags & M_MCAST)
464 			_ifp->if_omcasts++;
465 		_need_if_start = !(_ifp->if_flags & IFF_OACTIVE);
466 	}
467 	IF_ENQUEUE(_ifq, _m);
468 	if (_need_if_start) {
469 		(*_ifp->if_start)(_ifp);
470 	}
471 	crit_exit();
472 	return (1);
473 }
474 
475 /*
476  * 72 was chosen below because it is the size of a TCP/IP
477  * header (40) + the minimum mss (32).
478  */
479 #define	IF_MINMTU	72
480 #define	IF_MAXMTU	65535
481 
482 #endif /* _KERNEL */
483 
484 struct in_ifaddr;
485 
486 struct in_ifaddr_container {
487 	struct in_ifaddr	*ia;
488 	LIST_ENTRY(in_ifaddr_container) ia_hash;
489 				/* entry in bucket of inet addresses */
490 	TAILQ_ENTRY(in_ifaddr_container) ia_link;
491 				/* list of internet addresses */
492 	struct ifaddr_container	*ia_ifac; /* parent ifaddr_container */
493 };
494 
495 struct ifaddr_container {
496 #define IFA_CONTAINER_MAGIC	0x19810219
497 #define IFA_CONTAINER_DEAD	0xc0dedead
498 	uint32_t		ifa_magic;  /* IFA_CONTAINER_MAGIC */
499 	struct ifaddr		*ifa;
500 	TAILQ_ENTRY(ifaddr_container)	ifa_link;   /* queue macro glue */
501 	u_int			ifa_refcnt; /* references to this structure */
502 	uint16_t		ifa_listmask;	/* IFA_LIST_ */
503 	uint16_t		ifa_prflags;	/* protocol specific flags */
504 
505 	/*
506 	 * Protocol specific states
507 	 */
508 	union {
509 		struct in_ifaddr_container u_in_ifac;
510 	} ifa_proto_u;
511 };
512 
513 #define IFA_LIST_IFADDRHEAD	0x01	/* on ifnet.if_addrheads[cpuid] */
514 #define IFA_LIST_IN_IFADDRHEAD	0x02	/* on in_ifaddrheads[cpuid] */
515 #define IFA_LIST_IN_IFADDRHASH	0x04	/* on in_ifaddrhashtbls[cpuid] */
516 
517 #define IFA_PRF_FLAG0		0x01
518 #define IFA_PRF_FLAG1		0x02
519 #define IFA_PRF_FLAG2		0x04
520 #define IFA_PRF_FLAG3		0x08
521 
522 /*
523  * The ifaddr structure contains information about one address
524  * of an interface.  They are maintained by the different address families,
525  * are allocated and attached when an address is set, and are linked
526  * together so all addresses for an interface can be located.
527  */
528 struct ifaddr {
529 	struct	sockaddr *ifa_addr;	/* address of interface */
530 	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
531 #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
532 	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
533 	struct	if_data if_data;	/* not all members are meaningful */
534 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
535 	void	*ifa_link_pad;
536 	struct ifaddr_container *ifa_containers;
537 	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
538 		(int, struct rtentry *, struct rt_addrinfo *);
539 	u_short	ifa_flags;		/* mostly rt_flags for cloning */
540 	int	ifa_ncnt;		/* # of valid ifaddr_container */
541 	int	ifa_metric;		/* cost of going out this interface */
542 #ifdef notdef
543 	struct	rtentry *ifa_rt;	/* XXXX for ROUTETOIF ????? */
544 #endif
545 	int (*ifa_claim_addr)		/* check if an addr goes to this if */
546 		(struct ifaddr *, struct sockaddr *);
547 
548 };
549 #define	IFA_ROUTE	RTF_UP		/* route installed */
550 
551 /* for compatibility with other BSDs */
552 #define	ifa_list	ifa_link
553 
554 /*
555  * The prefix structure contains information about one prefix
556  * of an interface.  They are maintained by the different address families,
557  * are allocated and attached when an prefix or an address is set,
558  * and are linked together so all prefixes for an interface can be located.
559  */
560 struct ifprefix {
561 	struct	sockaddr *ifpr_prefix;	/* prefix of interface */
562 	struct	ifnet *ifpr_ifp;	/* back-pointer to interface */
563 	TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
564 	u_char	ifpr_plen;		/* prefix length in bits */
565 	u_char	ifpr_type;		/* protocol dependent prefix type */
566 };
567 
568 /*
569  * Multicast address structure.  This is analogous to the ifaddr
570  * structure except that it keeps track of multicast addresses.
571  * Also, the reference count here is a count of requests for this
572  * address, not a count of pointers to this structure.
573  */
574 struct ifmultiaddr {
575 	TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
576 	struct	sockaddr *ifma_addr;	/* address this membership is for */
577 	struct	sockaddr *ifma_lladdr;	/* link-layer translation, if any */
578 	struct	ifnet *ifma_ifp;	/* back-pointer to interface */
579 	u_int	ifma_refcount;		/* reference count */
580 	void	*ifma_protospec;	/* protocol-specific state, if any */
581 };
582 
583 #ifdef _KERNEL
584 
585 enum ifaddr_event {
586 	IFADDR_EVENT_ADD,
587 	IFADDR_EVENT_DELETE,
588 	IFADDR_EVENT_CHANGE
589 };
590 
591 /* interface address change event */
592 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *,
593 	enum ifaddr_event, struct ifaddr *);
594 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
595 /* new interface attach event */
596 typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *);
597 EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t);
598 /* interface detach event */
599 typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *);
600 EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t);
601 
602 #ifdef INVARIANTS
603 #define ASSERT_IFAC_VALID(ifac)	do { \
604 	KKASSERT((ifac)->ifa_magic == IFA_CONTAINER_MAGIC); \
605 	KKASSERT((ifac)->ifa_refcnt > 0); \
606 } while (0)
607 #else
608 #define ASSERT_IFAC_VALID(ifac)	((void)0)
609 #endif
610 
611 static __inline void
612 _IFAREF(struct ifaddr *_ifa, int _cpu_id)
613 {
614 	struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
615 
616 	crit_enter();
617 	ASSERT_IFAC_VALID(_ifac);
618 	++_ifac->ifa_refcnt;
619 	crit_exit();
620 }
621 
622 static __inline void
623 IFAREF(struct ifaddr *_ifa)
624 {
625 	_IFAREF(_ifa, mycpuid);
626 }
627 
628 #include <sys/malloc.h>
629 
630 MALLOC_DECLARE(M_IFADDR);
631 MALLOC_DECLARE(M_IFMADDR);
632 MALLOC_DECLARE(M_IFNET);
633 
634 void	ifac_free(struct ifaddr_container *, int);
635 
636 static __inline void
637 _IFAFREE(struct ifaddr *_ifa, int _cpu_id)
638 {
639 	struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
640 
641 	crit_enter();
642 	ASSERT_IFAC_VALID(_ifac);
643 	if (--_ifac->ifa_refcnt == 0)
644 		ifac_free(_ifac, _cpu_id);
645 	crit_exit();
646 }
647 
648 static __inline void
649 IFAFREE(struct ifaddr *_ifa)
650 {
651 	_IFAFREE(_ifa, mycpuid);
652 }
653 
654 struct lwkt_port *ifnet_portfn(int);
655 int	ifnet_domsg(struct lwkt_msg *, int);
656 void	ifnet_sendmsg(struct lwkt_msg *, int);
657 void	ifnet_forwardmsg(struct lwkt_msg *, int);
658 struct ifnet *ifnet_byindex(unsigned short);
659 
660 static __inline int
661 ifa_domsg(struct lwkt_msg *_lmsg, int _cpu)
662 {
663 	return ifnet_domsg(_lmsg, _cpu);
664 }
665 
666 static __inline void
667 ifa_sendmsg(struct lwkt_msg *_lmsg, int _cpu)
668 {
669 	ifnet_sendmsg(_lmsg, _cpu);
670 }
671 
672 static __inline void
673 ifa_forwardmsg(struct lwkt_msg *_lmsg, int _nextcpu)
674 {
675 	ifnet_forwardmsg(_lmsg, _nextcpu);
676 }
677 
678 extern	struct ifnethead ifnet;
679 extern struct	ifnet	**ifindex2ifnet;
680 extern	int ifqmaxlen;
681 extern	struct ifnet loif[];
682 extern	int if_index;
683 
684 void	ether_ifattach(struct ifnet *, uint8_t *, struct lwkt_serialize *);
685 void	ether_ifattach_bpf(struct ifnet *, uint8_t *, u_int, u_int,
686 			struct lwkt_serialize *);
687 void	ether_ifdetach(struct ifnet *);
688 void	ether_demux_oncpu(struct ifnet *, struct mbuf *);
689 void	ether_input_oncpu(struct ifnet *, struct mbuf *);
690 void	ether_reinput_oncpu(struct ifnet *, struct mbuf *, int);
691 void	ether_input_chain(struct ifnet *, struct mbuf *,
692 			  const struct pktinfo *, struct mbuf_chain *);
693 void	ether_input_chain_init(struct mbuf_chain *);
694 void	ether_input_dispatch(struct mbuf_chain *);
695 int	ether_output_frame(struct ifnet *, struct mbuf *);
696 int	ether_ioctl(struct ifnet *, int, caddr_t);
697 uint32_t	ether_crc32_le(const uint8_t *, size_t);
698 uint32_t	ether_crc32_be(const uint8_t *, size_t);
699 
700 int	if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
701 int	if_allmulti(struct ifnet *, int);
702 void	if_attach(struct ifnet *, struct lwkt_serialize *);
703 int	if_delmulti(struct ifnet *, struct sockaddr *);
704 void	if_delallmulti(struct ifnet *ifp);
705 void	if_purgeaddrs_nolink(struct ifnet *);
706 void	if_detach(struct ifnet *);
707 void	if_down(struct ifnet *);
708 void	if_link_state_change(struct ifnet *);
709 void	if_initname(struct ifnet *, const char *, int);
710 int	if_getanyethermac(uint16_t *, int);
711 int	if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
712 struct ifnet *if_alloc(uint8_t);
713 void	if_free(struct ifnet *);
714 void	if_route(struct ifnet *, int flag, int fam);
715 int	if_setlladdr(struct ifnet *, const u_char *, int);
716 void	if_unroute(struct ifnet *, int flag, int fam);
717 void	if_up(struct ifnet *);
718 /*void	ifinit(void);*/ /* declared in systm.h for main() */
719 int	ifioctl(struct socket *, u_long, caddr_t, struct ucred *);
720 int	ifpromisc(struct ifnet *, int);
721 struct	ifnet *ifunit(const char *);
722 struct	ifnet *if_withname(struct sockaddr *);
723 
724 struct	ifaddr *ifa_ifwithaddr(struct sockaddr *);
725 struct	ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
726 struct	ifaddr *ifa_ifwithnet(struct sockaddr *);
727 struct	ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
728 struct	ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
729 
730 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
731 typedef void if_com_free_t(void *com, u_char type);
732 void    if_register_com_alloc(u_char, if_com_alloc_t *a, if_com_free_t *);
733 void    if_deregister_com_alloc(u_char);
734 
735 void	*ifa_create(int, int);
736 void	ifa_destroy(struct ifaddr *);
737 void	ifa_iflink(struct ifaddr *, struct ifnet *, int);
738 void	ifa_ifunlink(struct ifaddr *, struct ifnet *);
739 
740 struct ifaddr *ifaddr_byindex(unsigned short);
741 
742 struct	ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
743 int	if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
744 void	if_devstart(struct ifnet *ifp);
745 
746 #define IF_LLSOCKADDR(ifp)						\
747     ((struct sockaddr_dl *)(ifp)->if_lladdr->ifa_addr)
748 #define IF_LLADDR(ifp)	LLADDR(IF_LLSOCKADDR(ifp))
749 
750 #ifdef DEVICE_POLLING
751 typedef	void poll_handler_t (struct ifnet *ifp, enum poll_cmd cmd, int count);
752 int	ether_poll_register(struct ifnet *);
753 int	ether_poll_deregister(struct ifnet *);
754 int	ether_pollcpu_register(struct ifnet *, int);
755 #endif /* DEVICE_POLLING */
756 
757 #ifdef IFPOLL_ENABLE
758 int	ifpoll_register(struct ifnet *);
759 int	ifpoll_deregister(struct ifnet *);
760 #endif	/* IFPOLL_ENABLE */
761 
762 #endif /* _KERNEL */
763 
764 #endif /* !_NET_IF_VAR_H_ */
765