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