xref: /dflybsd-src/sys/net/if_var.h (revision 858d36ec0da1c070488660b7c0121e6f70100ae9)
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  */
36 
37 #ifndef	_NET_IF_VAR_H_
38 #define	_NET_IF_VAR_H_
39 
40 #ifndef _SYS_SERIALIZE_H_
41 #include <sys/serialize.h>
42 #endif
43 #ifndef _NET_IF_H_
44 #include <net/if.h>
45 #endif
46 #ifndef _SYS_MUTEX_H_
47 #include <sys/mutex.h>
48 #endif
49 
50 /*
51  * Structures defining a network interface, providing a packet
52  * transport mechanism (ala level 0 of the PUP protocols).
53  *
54  * Each interface accepts output datagrams of a specified maximum
55  * length, and provides higher level routines with input datagrams
56  * received from its medium.
57  *
58  * Output occurs when the routine if_output is called, with four parameters:
59  *	ifp->if_output(ifp, m, dst, rt)
60  * Here m is the mbuf chain to be sent and dst is the destination address.
61  * The output routine encapsulates the supplied datagram if necessary,
62  * and then transmits it on its medium.
63  *
64  * On input, each interface unwraps the data received by it, and either
65  * places it on the input queue of a internetwork datagram routine
66  * and posts the associated software interrupt, or passes the datagram to
67  * the routine if_input. It is called with the mbuf chain as parameter:
68  *	ifp->if_input(ifp, m)
69  * The input routine removes the protocol dependent header if necessary.
70  *
71  * Routines exist for locating interfaces by their addresses
72  * or for locating a interface on a certain network, as well as more general
73  * routing and gateway routines maintaining information used to locate
74  * interfaces.  These routines live in the files if.c and route.c
75  */
76 
77 /*
78  * Forward structure declarations for function prototypes [sic].
79  */
80 struct	mbuf;
81 struct	proc;
82 struct	rtentry;
83 struct	rt_addrinfo;
84 struct	socket;
85 struct	ether_header;
86 struct	ucred;
87 struct	lwkt_serialize;
88 struct	ifaddr_container;
89 struct	ifaddr;
90 struct	lwkt_port;
91 struct	lwkt_msg;
92 union	netmsg;
93 struct	pktinfo;
94 struct	ifpoll_info;
95 struct	ifdata_pcpu;
96 
97 #include <sys/queue.h>		/* get TAILQ macros */
98 
99 #include <net/altq/if_altq.h>
100 
101 #ifdef _KERNEL
102 #include <sys/eventhandler.h>
103 #include <sys/mbuf.h>
104 #include <sys/systm.h>		/* XXX */
105 #include <sys/thread2.h>
106 #endif /* _KERNEL */
107 
108 #define IF_DUNIT_NONE   -1
109 
110 TAILQ_HEAD(ifnethead, ifnet);	/* we use TAILQs so that the order of */
111 TAILQ_HEAD(ifaddrhead, ifaddr_container); /* instantiation is preserved in the list */
112 TAILQ_HEAD(ifprefixhead, ifprefix);
113 TAILQ_HEAD(ifmultihead, ifmultiaddr);
114 
115 /*
116  * Structure defining a queue for a network interface.
117  */
118 struct	ifqueue {
119 	struct	mbuf *ifq_head;
120 	struct	mbuf *ifq_tail;
121 	int	ifq_len;
122 	int	ifq_maxlen;
123 	int	ifq_drops;
124 };
125 
126 /*
127  * Note of IFPOLL_ENABLE
128  * 1) Any file(*.c) that depends on IFPOLL_ENABLE supports in this
129  *    file should include opt_ifpoll.h at its beginning.
130  * 2) When struct changes, which are conditioned by IFPOLL_ENABLE,
131  *    are to be introduced, please keep the struct's size and layout
132  *    same, no matter whether IFPOLL_ENABLE is defined or not.
133  *    See ifnet.if_npoll and ifnet.if_npoll_unused for example.
134  */
135 
136 enum ifnet_serialize {
137 	IFNET_SERIALIZE_ALL,
138 	IFNET_SERIALIZE_TX_BASE = 0x10000000,
139 };
140 #define IFNET_SERIALIZE_TX(i)	(IFNET_SERIALIZE_TX_BASE + (i))
141 
142 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
143 
144 /*
145  * Structure defining a network interface.
146  *
147  * (Would like to call this struct ``if'', but C isn't PL/1.)
148  */
149 
150 /*
151  * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with
152  * one of these structures, typically held within an arpcom structure.
153  *
154  *	struct <foo>_softc {
155  *		struct arpcom {
156  *			struct  ifnet ac_if;
157  *			...
158  *		} <arpcom> ;
159  *		...
160  *	};
161  *
162  * The assumption is used in a number of places, including many
163  * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
164  *
165  * Unfortunately devices' softc are opaque, so we depend on this layout
166  * to locate the struct ifnet from the softc in the generic code.
167  *
168  * MPSAFE NOTES:
169  *
170  * ifnet is protected by calling if_serialize, if_tryserialize and
171  * if_deserialize serialize functions with the ifnet_serialize parameter.
172  * ifnet.if_snd is protected by its own spinlock.  Callers of if_ioctl,
173  * if_watchdog, if_init, if_resolvemulti, and if_poll should call the
174  * ifnet serialize functions with IFNET_SERIALIZE_ALL.  Callers of if_start
175  * sould call the ifnet serialize functions with IFNET_SERIALIZE_TX.
176  *
177  * FIXME: Device drivers usually use the same serializer for their interrupt
178  * FIXME: but this is not required.
179  *
180  * Caller of if_output must not serialize ifnet by calling ifnet serialize
181  * functions; if_output will call the ifnet serialize functions based on
182  * its own needs.  Caller of if_input does not necessarily hold the related
183  * serializer.
184  *
185  * If a device driver installs the same serializer for its interrupt
186  * as for ifnet, then the driver only really needs to worry about further
187  * serialization in timeout based entry points.  All other entry points
188  * will already be serialized.  Older ISA drivers still using the old
189  * interrupt infrastructure will have to obtain and release the serializer
190  * in their interrupt routine themselves.
191  */
192 struct ifnet {
193 	void	*if_softc;		/* pointer to driver state */
194 	void	*if_l2com;		/* pointer to protocol bits */
195 	TAILQ_ENTRY(ifnet) if_link;	/* all struct ifnets are chained */
196 	char	if_xname[IFNAMSIZ];	/* external name (name + unit) */
197 	const char *if_dname;		/* driver name */
198 	int	if_dunit;		/* unit or IF_DUNIT_NONE */
199 	void	*if_vlantrunks;		/* vlan trunks */
200 	struct	ifaddrhead *if_addrheads; /* array[NCPU] of TAILQs of addresses per if */
201 	int	if_pcount;		/* number of promiscuous listeners */
202 	void	*if_carp;		/* carp interfaces */
203 	struct	bpf_if *if_bpf;		/* packet filter structure */
204 	u_short	if_index;		/* numeric abbreviation for this if  */
205 	short	if_timer;		/* time 'til if_watchdog called */
206 	int	if_flags;		/* up/down, broadcast, etc. */
207 	int	if_capabilities;	/* interface capabilities */
208 	int	if_capenable;		/* enabled features */
209 	void	*if_linkmib;		/* link-type-specific MIB data */
210 	size_t	if_linkmiblen;		/* length of above data */
211 	struct	if_data if_data;
212 	struct	ifmultihead if_multiaddrs; /* multicast addresses configured */
213 	int	if_amcount;		/* number of all-multicast requests */
214 /* procedure handles */
215 	int	(*if_output)		/* output routine (enqueue) */
216 		(struct ifnet *, struct mbuf *, struct sockaddr *,
217 		     struct rtentry *);
218 	void	(*if_input)		/* input routine from hardware driver */
219 		(struct ifnet *, struct mbuf *);
220 	void	(*if_start)		/* initiate output routine */
221 		(struct ifnet *, struct ifaltq_subque *);
222 	int	(*if_ioctl)		/* ioctl routine */
223 		(struct ifnet *, u_long, caddr_t, struct ucred *);
224 	void	(*if_watchdog)		/* timer routine */
225 		(struct ifnet *);
226 	void	(*if_init)		/* Init routine */
227 		(void *);
228 	int	(*if_resolvemulti)	/* validate/resolve multicast */
229 		(struct ifnet *, struct sockaddr **, struct sockaddr *);
230 	void	*if_unused5;
231 	TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
232 	int	(*if_mapsubq)
233 		(struct ifaltq *, int);
234 	int	if_unused2;
235 	void	(*if_serialize)
236 		(struct ifnet *, enum ifnet_serialize);
237 	void	(*if_deserialize)
238 		(struct ifnet *, enum ifnet_serialize);
239 	int	(*if_tryserialize)
240 		(struct ifnet *, enum ifnet_serialize);
241 #ifdef INVARIANTS
242 	void	(*if_serialize_assert)
243 		(struct ifnet *, enum ifnet_serialize, boolean_t);
244 #else
245 	/* Place holder */
246 	void	(*if_serialize_unused)(void);
247 #endif
248 #ifdef IFPOLL_ENABLE
249 	void	(*if_npoll)
250 		(struct ifnet *, struct ifpoll_info *);
251 #else
252 	/* Place holder */
253 	void	(*if_npoll_unused)(void);
254 #endif
255 	int	if_tsolen;		/* max TSO length */
256 	struct	ifaltq if_snd;		/* output queue (includes altq) */
257 	struct	ifprefixhead if_prefixhead; /* list of prefixes per if */
258 	const uint8_t	*if_broadcastaddr;
259 	void	*if_bridge;		/* bridge glue */
260 	void	*if_afdata[AF_MAX];
261 	struct ifaddr	*if_lladdr;
262 	struct lwkt_serialize *if_serializer;	/* serializer or MP lock */
263 	struct lwkt_serialize if_default_serializer; /* if not supplied */
264 	struct mtx	if_ioctl_mtx;	/* high-level ioctl serializing mutex */
265 	int	if_unused4;
266 	struct ifdata_pcpu *if_data_pcpu;
267 	void	*if_pf_kif; /* pf interface abstraction */
268 	void	*if_unused7;
269 };
270 typedef void if_init_f_t (void *);
271 
272 #define	if_mtu		if_data.ifi_mtu
273 #define	if_type		if_data.ifi_type
274 #define if_physical	if_data.ifi_physical
275 #define	if_addrlen	if_data.ifi_addrlen
276 #define	if_hdrlen	if_data.ifi_hdrlen
277 #define	if_metric	if_data.ifi_metric
278 #define	if_link_state	if_data.ifi_link_state
279 #define	if_baudrate	if_data.ifi_baudrate
280 #define	if_hwassist	if_data.ifi_hwassist
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 #define if_recvquota	if_data.ifi_recvquota
294 #define	if_xmitquota	if_data.ifi_xmitquota
295 #define if_rawoutput(if, m, sa) if_output(if, m, sa, NULL)
296 
297 /* for compatibility with other BSDs */
298 #define	if_list		if_link
299 
300 struct ifdata_pcpu {
301 	u_long	ifd_ipackets;		/* packets received on interface */
302 	u_long	ifd_ierrors;		/* input errors on interface */
303 	u_long	ifd_opackets;		/* packets sent on interface */
304 	u_long	ifd_oerrors;		/* output errors on interface */
305 	u_long	ifd_collisions;		/* collisions on csma interfaces */
306 	u_long	ifd_ibytes;		/* total number of octets received */
307 	u_long	ifd_obytes;		/* total number of octets sent */
308 	u_long	ifd_imcasts;		/* packets received via multicast */
309 	u_long	ifd_omcasts;		/* packets sent via multicast */
310 	u_long	ifd_iqdrops;		/* dropped on input, this interface */
311 	u_long	ifd_noproto;		/* destined for unsupported protocol */
312 } __cachealign;
313 
314 #endif
315 
316 /*
317  * Device private output queues and input queues are queues of messages
318  * stored on ifqueue structures (defined above).  Entries are added to
319  * and deleted from these structures by these macros.
320  */
321 #define	IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
322 #define	IF_DROP(ifq)		((ifq)->ifq_drops++)
323 #define	IF_QLEN(ifq)		((ifq)->ifq_len)
324 #define	IF_QEMPTY(ifq)		(IF_QLEN(ifq) == 0)
325 
326 #define	IF_ENQUEUE(ifq, m) do {						\
327 	(m)->m_nextpkt = NULL;						\
328 	if ((ifq)->ifq_tail == NULL)					\
329 		(ifq)->ifq_head = m;					\
330 	else								\
331 		(ifq)->ifq_tail->m_nextpkt = m;				\
332 	(ifq)->ifq_tail = m;						\
333 	(ifq)->ifq_len++;						\
334 } while (0)
335 
336 #define	IF_PREPEND(ifq, m) do {						\
337 	(m)->m_nextpkt = (ifq)->ifq_head;				\
338 	if ((ifq)->ifq_tail == NULL)					\
339 		(ifq)->ifq_tail = (m);					\
340 	(ifq)->ifq_head = (m);						\
341 	(ifq)->ifq_len++;						\
342 } while (0)
343 
344 #define	IF_DEQUEUE(ifq, m) do {						\
345 	(m) = (ifq)->ifq_head;						\
346 	if (m) {							\
347 		if (((ifq)->ifq_head = (m)->m_nextpkt) == NULL)		\
348 			(ifq)->ifq_tail = NULL;				\
349 		(m)->m_nextpkt = NULL;					\
350 		(ifq)->ifq_len--;					\
351 	}								\
352 } while (0)
353 
354 #define	IF_POLL(ifq, m)		((m) = (ifq)->ifq_head)
355 
356 #define IF_DRAIN(ifq) do {						\
357 	struct mbuf *m;							\
358 	while (1) {							\
359 		IF_DEQUEUE(ifq, m);					\
360 		if (m == NULL)						\
361 			break;						\
362 		m_freem(m);						\
363 	}								\
364 } while (0)
365 
366 #ifdef _KERNEL
367 
368 /* interface link layer address change event */
369 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
370 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
371 
372 #ifdef INVARIANTS
373 #define ASSERT_IFNET_SERIALIZED_ALL(ifp) \
374 	(ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, TRUE)
375 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp) \
376 	(ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, FALSE)
377 
378 #define ASSERT_IFNET_SERIALIZED_TX(ifp, ifsq) \
379 	(ifp)->if_serialize_assert((ifp), \
380 	    IFNET_SERIALIZE_TX((ifsq)->ifsq_index), TRUE)
381 #define ASSERT_IFNET_NOT_SERIALIZED_TX(ifp, ifsq) \
382 	(ifp)->if_serialize_assert((ifp), \
383 	    IFNET_SERIALIZE_TX((ifsq)->ifsq_index), FALSE)
384 #else
385 #define ASSERT_IFNET_SERIALIZED_ALL(ifp)	((void)0)
386 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp)	((void)0)
387 #define ASSERT_IFNET_SERIALIZED_TX(ifp, ifsq)	((void)0)
388 #define ASSERT_IFNET_NOT_SERIALIZED_TX(ifp, ifsq) ((void)0)
389 #endif
390 
391 static __inline void
392 ifnet_serialize_all(struct ifnet *_ifp)
393 {
394 	_ifp->if_serialize(_ifp, IFNET_SERIALIZE_ALL);
395 }
396 
397 static __inline void
398 ifnet_deserialize_all(struct ifnet *_ifp)
399 {
400 	_ifp->if_deserialize(_ifp, IFNET_SERIALIZE_ALL);
401 }
402 
403 static __inline int
404 ifnet_tryserialize_all(struct ifnet *_ifp)
405 {
406 	return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_ALL);
407 }
408 
409 static __inline void
410 ifnet_serialize_tx(struct ifnet *_ifp, const struct ifaltq_subque *_ifsq)
411 {
412 	_ifp->if_serialize(_ifp, IFNET_SERIALIZE_TX(_ifsq->ifsq_index));
413 }
414 
415 static __inline void
416 ifnet_deserialize_tx(struct ifnet *_ifp, const struct ifaltq_subque *_ifsq)
417 {
418 	_ifp->if_deserialize(_ifp, IFNET_SERIALIZE_TX(_ifsq->ifsq_index));
419 }
420 
421 static __inline int
422 ifnet_tryserialize_tx(struct ifnet *_ifp, const struct ifaltq_subque *_ifsq)
423 {
424 	return _ifp->if_tryserialize(_ifp,
425 	    IFNET_SERIALIZE_TX(_ifsq->ifsq_index));
426 }
427 
428 /*
429  * 72 was chosen below because it is the size of a TCP/IP
430  * header (40) + the minimum mss (32).
431  */
432 #define	IF_MINMTU	72
433 #define	IF_MAXMTU	65535
434 
435 #endif /* _KERNEL */
436 
437 struct in_ifaddr;
438 
439 struct in_ifaddr_container {
440 	struct in_ifaddr	*ia;
441 	LIST_ENTRY(in_ifaddr_container) ia_hash;
442 				/* entry in bucket of inet addresses */
443 	TAILQ_ENTRY(in_ifaddr_container) ia_link;
444 				/* list of internet addresses */
445 	struct ifaddr_container	*ia_ifac; /* parent ifaddr_container */
446 };
447 
448 struct ifaddr_container {
449 #define IFA_CONTAINER_MAGIC	0x19810219
450 #define IFA_CONTAINER_DEAD	0xc0dedead
451 	uint32_t		ifa_magic;  /* IFA_CONTAINER_MAGIC */
452 	struct ifaddr		*ifa;
453 	TAILQ_ENTRY(ifaddr_container)	ifa_link;   /* queue macro glue */
454 	u_int			ifa_refcnt; /* references to this structure */
455 	uint16_t		ifa_listmask;	/* IFA_LIST_ */
456 	uint16_t		ifa_prflags;	/* protocol specific flags */
457 
458 	u_long			ifa_ipackets;	/* packets received on addr */
459 	u_long			ifa_ibytes;	/* bytes received on addr */
460 	u_long			ifa_opackets;	/* packets sent on addr */
461 	u_long			ifa_obytes;	/* bytes sent on addr */
462 
463 	/*
464 	 * Protocol specific states
465 	 */
466 	union {
467 		struct in_ifaddr_container u_in_ifac;
468 	} ifa_proto_u;
469 } __cachealign;
470 
471 #define IFA_LIST_IFADDRHEAD	0x01	/* on ifnet.if_addrheads[cpuid] */
472 #define IFA_LIST_IN_IFADDRHEAD	0x02	/* on in_ifaddrheads[cpuid] */
473 #define IFA_LIST_IN_IFADDRHASH	0x04	/* on in_ifaddrhashtbls[cpuid] */
474 
475 #define IFA_PRF_FLAG0		0x01
476 #define IFA_PRF_FLAG1		0x02
477 #define IFA_PRF_FLAG2		0x04
478 #define IFA_PRF_FLAG3		0x08
479 
480 /*
481  * The ifaddr structure contains information about one address
482  * of an interface.  They are maintained by the different address families,
483  * are allocated and attached when an address is set, and are linked
484  * together so all addresses for an interface can be located.
485  */
486 struct ifaddr {
487 	struct	sockaddr *ifa_addr;	/* address of interface */
488 	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
489 #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
490 	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
491 	struct	if_data if_data;	/* not all members are meaningful */
492 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
493 	void	*ifa_link_pad;
494 	struct ifaddr_container *ifa_containers;
495 	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
496 		(int, struct rtentry *, struct rt_addrinfo *);
497 	u_short	ifa_flags;		/* mostly rt_flags for cloning */
498 	int	ifa_ncnt;		/* # of valid ifaddr_container */
499 	int	ifa_metric;		/* cost of going out this interface */
500 #ifdef notdef
501 	struct	rtentry *ifa_rt;	/* XXXX for ROUTETOIF ????? */
502 #endif
503 	int (*ifa_claim_addr)		/* check if an addr goes to this if */
504 		(struct ifaddr *, struct sockaddr *);
505 
506 };
507 #define	IFA_ROUTE	RTF_UP		/* route installed */
508 
509 /* for compatibility with other BSDs */
510 #define	ifa_list	ifa_link
511 
512 /*
513  * The prefix structure contains information about one prefix
514  * of an interface.  They are maintained by the different address families,
515  * are allocated and attached when an prefix or an address is set,
516  * and are linked together so all prefixes for an interface can be located.
517  */
518 struct ifprefix {
519 	struct	sockaddr *ifpr_prefix;	/* prefix of interface */
520 	struct	ifnet *ifpr_ifp;	/* back-pointer to interface */
521 	TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
522 	u_char	ifpr_plen;		/* prefix length in bits */
523 	u_char	ifpr_type;		/* protocol dependent prefix type */
524 };
525 
526 /*
527  * Multicast address structure.  This is analogous to the ifaddr
528  * structure except that it keeps track of multicast addresses.
529  * Also, the reference count here is a count of requests for this
530  * address, not a count of pointers to this structure.
531  */
532 struct ifmultiaddr {
533 	TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
534 	struct	sockaddr *ifma_addr;	/* address this membership is for */
535 	struct	sockaddr *ifma_lladdr;	/* link-layer translation, if any */
536 	struct	ifnet *ifma_ifp;	/* back-pointer to interface */
537 	u_int	ifma_refcount;		/* reference count */
538 	void	*ifma_protospec;	/* protocol-specific state, if any */
539 };
540 
541 #ifdef _KERNEL
542 
543 #define IFA_STAT_INC(ifa, name, v) \
544 do { \
545 	(ifa)->ifa_containers[mycpuid].ifa_##name += (v); \
546 } while (0)
547 
548 #define IFNET_STAT_INC(ifp, name, v) \
549 do { \
550 	(ifp)->if_data_pcpu[mycpuid].ifd_##name += (v); \
551 } while (0)
552 
553 #define IFNET_STAT_SET(ifp, name, v) \
554 do { \
555 	int _cpu; \
556 	(ifp)->if_data_pcpu[0].ifd_##name = (v); \
557 	for (_cpu = 1; _cpu < ncpus; ++_cpu) \
558 		(ifp)->if_data_pcpu[_cpu].ifd_##name = 0; \
559 } while (0)
560 
561 #define IFNET_STAT_GET(ifp, name, v) \
562 do { \
563 	int _cpu; \
564 	(v) = (ifp)->if_data_pcpu[0].ifd_##name; \
565 	for (_cpu = 1; _cpu < ncpus; ++_cpu) \
566 		(v) += (ifp)->if_data_pcpu[_cpu].ifd_##name; \
567 } while (0)
568 
569 #ifndef _SYS_SERIALIZE2_H_
570 #include <sys/serialize2.h>
571 #endif
572 
573 enum ifaddr_event {
574 	IFADDR_EVENT_ADD,
575 	IFADDR_EVENT_DELETE,
576 	IFADDR_EVENT_CHANGE
577 };
578 
579 /* interface address change event */
580 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *,
581 	enum ifaddr_event, struct ifaddr *);
582 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
583 /* new interface attach event */
584 typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *);
585 EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t);
586 /* interface detach event */
587 typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *);
588 EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t);
589 
590 /*
591  * interface groups
592  */
593 struct ifg_group {
594 	char				 ifg_group[IFNAMSIZ];
595 	u_int				 ifg_refcnt;
596 	void				*ifg_pf_kif;
597 	int				 ifg_carp_demoted;
598 	TAILQ_HEAD(, ifg_member)	 ifg_members;
599 	TAILQ_ENTRY(ifg_group)		 ifg_next;
600 };
601 
602 struct ifg_member {
603 	TAILQ_ENTRY(ifg_member)	 ifgm_next;
604 	struct ifnet		*ifgm_ifp;
605 };
606 
607 struct ifg_list {
608 	struct ifg_group	*ifgl_group;
609 	TAILQ_ENTRY(ifg_list)	 ifgl_next;
610 };
611 
612 /* group attach event */
613 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
614 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
615 /* group detach event */
616 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
617 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
618 /* group change event */
619 typedef void (*group_change_event_handler_t)(void *, const char *);
620 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
621 
622 
623 #ifdef INVARIANTS
624 #define ASSERT_IFAC_VALID(ifac)	do { \
625 	KKASSERT((ifac)->ifa_magic == IFA_CONTAINER_MAGIC); \
626 	KKASSERT((ifac)->ifa_refcnt > 0); \
627 } while (0)
628 #else
629 #define ASSERT_IFAC_VALID(ifac)	((void)0)
630 #endif
631 
632 static __inline void
633 _IFAREF(struct ifaddr *_ifa, int _cpu_id)
634 {
635 	struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
636 
637 	crit_enter();
638 	ASSERT_IFAC_VALID(_ifac);
639 	++_ifac->ifa_refcnt;
640 	crit_exit();
641 }
642 
643 static __inline void
644 IFAREF(struct ifaddr *_ifa)
645 {
646 	_IFAREF(_ifa, mycpuid);
647 }
648 
649 #include <sys/malloc.h>
650 
651 MALLOC_DECLARE(M_IFADDR);
652 MALLOC_DECLARE(M_IFMADDR);
653 MALLOC_DECLARE(M_IFNET);
654 
655 void	ifac_free(struct ifaddr_container *, int);
656 
657 static __inline void
658 _IFAFREE(struct ifaddr *_ifa, int _cpu_id)
659 {
660 	struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
661 
662 	crit_enter();
663 	ASSERT_IFAC_VALID(_ifac);
664 	if (--_ifac->ifa_refcnt == 0)
665 		ifac_free(_ifac, _cpu_id);
666 	crit_exit();
667 }
668 
669 static __inline void
670 IFAFREE(struct ifaddr *_ifa)
671 {
672 	_IFAFREE(_ifa, mycpuid);
673 }
674 
675 struct lwkt_port *ifnet_portfn(int);
676 int	ifnet_domsg(struct lwkt_msg *, int);
677 void	ifnet_sendmsg(struct lwkt_msg *, int);
678 void	ifnet_forwardmsg(struct lwkt_msg *, int);
679 struct ifnet *ifnet_byindex(unsigned short);
680 
681 static __inline int
682 ifa_domsg(struct lwkt_msg *_lmsg, int _cpu)
683 {
684 	return ifnet_domsg(_lmsg, _cpu);
685 }
686 
687 static __inline void
688 ifa_sendmsg(struct lwkt_msg *_lmsg, int _cpu)
689 {
690 	ifnet_sendmsg(_lmsg, _cpu);
691 }
692 
693 static __inline void
694 ifa_forwardmsg(struct lwkt_msg *_lmsg, int _nextcpu)
695 {
696 	ifnet_forwardmsg(_lmsg, _nextcpu);
697 }
698 
699 static __inline int
700 ifnet_serialize_array_index(int _arrcnt, int _txoff, int _rxoff,
701     enum ifnet_serialize _slz)
702 {
703 	int _off;
704 
705 	KASSERT(_slz & IFNET_SERIALIZE_TX_BASE,
706 	    ("unknown serializer %#x", _slz));
707 	_off = (_slz & ~IFNET_SERIALIZE_TX_BASE) + _txoff;
708 	KASSERT(_off < _arrcnt, ("invalid TX serializer %#x", _slz));
709 
710 	return _off;
711 }
712 
713 static __inline void
714 ifnet_serialize_array_enter(lwkt_serialize_t *_arr, int _arrcnt,
715     int _txoff, int _rxoff, enum ifnet_serialize _slz)
716 {
717 	int _off;
718 
719 	if (__predict_false(_slz == IFNET_SERIALIZE_ALL)) {
720 		lwkt_serialize_array_enter(_arr, _arrcnt, 0);
721 		return;
722 	}
723 
724 	_off = ifnet_serialize_array_index(_arrcnt, _txoff, _rxoff, _slz);
725 	lwkt_serialize_enter(_arr[_off]);
726 }
727 
728 static __inline void
729 ifnet_serialize_array_exit(lwkt_serialize_t *_arr, int _arrcnt,
730     int _txoff, int _rxoff, enum ifnet_serialize _slz)
731 {
732 	int _off;
733 
734 	if (__predict_false(_slz == IFNET_SERIALIZE_ALL)) {
735 		lwkt_serialize_array_exit(_arr, _arrcnt, 0);
736 		return;
737 	}
738 
739 	_off = ifnet_serialize_array_index(_arrcnt, _txoff, _rxoff, _slz);
740 	lwkt_serialize_exit(_arr[_off]);
741 }
742 
743 static __inline int
744 ifnet_serialize_array_try(lwkt_serialize_t *_arr, int _arrcnt,
745     int _txoff, int _rxoff, enum ifnet_serialize _slz)
746 {
747 	int _off;
748 
749 	if (__predict_false(_slz == IFNET_SERIALIZE_ALL))
750 		return lwkt_serialize_array_try(_arr, _arrcnt, 0);
751 
752 	_off = ifnet_serialize_array_index(_arrcnt, _txoff, _rxoff, _slz);
753 	return lwkt_serialize_try(_arr[_off]);
754 }
755 
756 #ifdef INVARIANTS
757 
758 static __inline void
759 ifnet_serialize_array_assert(lwkt_serialize_t *_arr, int _arrcnt,
760     int _txoff, int _rxoff, enum ifnet_serialize _slz, boolean_t _serialized)
761 {
762 	int _off;
763 
764 	if (__predict_false(_slz == IFNET_SERIALIZE_ALL)) {
765 		int _i;
766 
767 		if (_serialized) {
768 			for (_i = 0; _i < _arrcnt; ++_i)
769 				ASSERT_SERIALIZED(_arr[_i]);
770 		} else {
771 			for (_i = 0; _i < _arrcnt; ++_i)
772 				ASSERT_NOT_SERIALIZED(_arr[_i]);
773 		}
774 		return;
775 	}
776 
777 	_off = ifnet_serialize_array_index(_arrcnt, _txoff, _rxoff, _slz);
778 	if (_serialized)
779 		ASSERT_SERIALIZED(_arr[_off]);
780 	else
781 		ASSERT_NOT_SERIALIZED(_arr[_off]);
782 }
783 
784 #endif	/* INVARIANTS */
785 
786 #define REINPUT_KEEPRCVIF	0x0001	/* ether_reinput_oncpu() */
787 #define REINPUT_RUNBPF 		0x0002	/* ether_reinput_oncpu() */
788 
789 extern	struct ifnethead ifnet;
790 extern struct	ifnet	**ifindex2ifnet;
791 extern	int ifqmaxlen;
792 extern	struct ifnet loif[];
793 extern	int if_index;
794 
795 struct ip;
796 struct tcphdr;
797 
798 void	ether_ifattach(struct ifnet *, uint8_t *, struct lwkt_serialize *);
799 void	ether_ifattach_bpf(struct ifnet *, uint8_t *, u_int, u_int,
800 			struct lwkt_serialize *);
801 void	ether_ifdetach(struct ifnet *);
802 void	ether_demux(struct mbuf *);
803 void	ether_demux_oncpu(struct ifnet *, struct mbuf *);
804 void	ether_reinput_oncpu(struct ifnet *, struct mbuf *, int);
805 void	ether_input_pkt(struct ifnet *, struct mbuf *, const struct pktinfo *);
806 int	ether_output_frame(struct ifnet *, struct mbuf *);
807 int	ether_ioctl(struct ifnet *, u_long, caddr_t);
808 u_char	*kether_aton(const char *, u_char *);
809 char	*kether_ntoa(const u_char *, char *);
810 boolean_t ether_tso_pullup(struct mbuf **, int *, struct ip **, int *,
811 	    struct tcphdr **, int *);
812 struct ifnet *ether_bridge_interface(struct ifnet *ifp);
813 uint32_t	ether_crc32_le(const uint8_t *, size_t);
814 uint32_t	ether_crc32_be(const uint8_t *, size_t);
815 
816 int	if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
817 int	if_allmulti(struct ifnet *, int);
818 void	if_attach(struct ifnet *, struct lwkt_serialize *);
819 int	if_delmulti(struct ifnet *, struct sockaddr *);
820 void	if_delallmulti(struct ifnet *ifp);
821 void	if_purgeaddrs_nolink(struct ifnet *);
822 void	if_detach(struct ifnet *);
823 void	if_down(struct ifnet *);
824 void	if_link_state_change(struct ifnet *);
825 void	if_initname(struct ifnet *, const char *, int);
826 int	if_getanyethermac(uint16_t *, int);
827 int	if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
828 struct ifnet *if_alloc(uint8_t);
829 void	if_free(struct ifnet *);
830 void	if_route(struct ifnet *, int flag, int fam);
831 int	if_setlladdr(struct ifnet *, const u_char *, int);
832 void	if_unroute(struct ifnet *, int flag, int fam);
833 void	if_up(struct ifnet *);
834 /*void	ifinit(void);*/ /* declared in systm.h for main() */
835 int	ifioctl(struct socket *, u_long, caddr_t, struct ucred *);
836 int	ifpromisc(struct ifnet *, int);
837 struct	ifnet *ifunit(const char *);
838 struct	ifnet *if_withname(struct sockaddr *);
839 
840 struct	ifg_group *if_creategroup(const char *);
841 int     if_addgroup(struct ifnet *, const char *);
842 int     if_delgroup(struct ifnet *, const char *);
843 int     if_getgroup(caddr_t, struct ifnet *);
844 int     if_getgroupmembers(caddr_t);
845 
846 struct	ifaddr *ifa_ifwithaddr(struct sockaddr *);
847 struct	ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
848 struct	ifaddr *ifa_ifwithnet(struct sockaddr *);
849 struct	ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
850 struct	ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
851 
852 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
853 typedef void if_com_free_t(void *com, u_char type);
854 void    if_register_com_alloc(u_char, if_com_alloc_t *a, if_com_free_t *);
855 void    if_deregister_com_alloc(u_char);
856 
857 void	*ifa_create(int, int);
858 void	ifa_destroy(struct ifaddr *);
859 void	ifa_iflink(struct ifaddr *, struct ifnet *, int);
860 void	ifa_ifunlink(struct ifaddr *, struct ifnet *);
861 
862 struct ifaddr *ifaddr_byindex(unsigned short);
863 
864 struct	ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
865 int	if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
866 void	if_devstart(struct ifnet *ifp); /* COMPAT */
867 void	if_devstart_sched(struct ifnet *ifp); /* COMPAT */
868 int	if_ring_count2(int cnt, int cnt_max);
869 
870 #define IF_LLSOCKADDR(ifp)						\
871     ((struct sockaddr_dl *)(ifp)->if_lladdr->ifa_addr)
872 #define IF_LLADDR(ifp)	LLADDR(IF_LLSOCKADDR(ifp))
873 
874 #ifdef IFPOLL_ENABLE
875 int	ifpoll_register(struct ifnet *);
876 int	ifpoll_deregister(struct ifnet *);
877 #endif	/* IFPOLL_ENABLE */
878 
879 #endif /* _KERNEL */
880 
881 #endif /* !_NET_IF_VAR_H_ */
882