xref: /dragonfly/sys/net/if_var.h (revision 92fc8b5c)
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 union	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 	TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
237 					/* protected by if_addr_mtx */
238 #ifdef DEVICE_POLLING
239 	void	(*if_poll)		/* IFF_POLLING support */
240 		(struct ifnet *, enum poll_cmd, int);
241 	int	if_poll_cpuid;
242 #else
243 	/* Place holders */
244 	void	(*if_poll_unused)(void);
245 	int	if_poll_cpuid_used;
246 #endif
247 	void	(*if_serialize)
248 		(struct ifnet *, enum ifnet_serialize);
249 	void	(*if_deserialize)
250 		(struct ifnet *, enum ifnet_serialize);
251 	int	(*if_tryserialize)
252 		(struct ifnet *, enum ifnet_serialize);
253 #ifdef INVARIANTS
254 	void	(*if_serialize_assert)
255 		(struct ifnet *, enum ifnet_serialize, boolean_t);
256 #else
257 	/* Place holders */
258 	void	(*if_serialize_unused)(void);
259 #endif
260 #ifdef IFPOLL_ENABLE
261 	void	(*if_qpoll)
262 		(struct ifnet *, struct ifpoll_info *);
263 #else
264 	/* Place holders */
265 	void	(*if_qpoll_unused)(void);
266 #endif
267 	struct	ifaltq if_snd;		/* output queue (includes altq) */
268 	struct	ifprefixhead if_prefixhead; /* list of prefixes per if */
269 	const uint8_t	*if_broadcastaddr;
270 	void	*if_bridge;		/* bridge glue */
271 	void	*if_afdata[AF_MAX];
272 	struct ifaddr	*if_lladdr;
273 	struct lwkt_serialize *if_serializer;	/* serializer or MP lock */
274 	struct lwkt_serialize if_default_serializer; /* if not supplied */
275 	int	if_cpuid;
276 	struct netmsg_base *if_start_nmsg; /* percpu msgs to sched if_start */
277 	void	*if_pf_kif; /* pf interface abstraction */
278  	union {
279  		void *carp_s;		/* carp structure (used by !carp ifs) */
280  		struct ifnet *carp_d;	/* ptr to carpdev (used by carp ifs) */
281  	} if_carp_ptr;
282 	#define if_carp		if_carp_ptr.carp_s
283 	#define if_carpdev	if_carp_ptr.carp_d
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 
316 /*
317  * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
318  * are queues of messages stored on ifqueue structures
319  * (defined above).  Entries are added to and deleted from these structures
320  * by these macros, which should be called with ipl raised to splimp().
321  */
322 #define	IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
323 #define	IF_DROP(ifq)		((ifq)->ifq_drops++)
324 #define	IF_QLEN(ifq)		((ifq)->ifq_len)
325 #define	IF_QEMPTY(ifq)		(IF_QLEN(ifq) == 0)
326 #define	IF_ENQUEUE(ifq, m) do {						\
327 	(m)->m_nextpkt = 0;						\
328 	if ((ifq)->ifq_tail == 0)					\
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 #define	IF_PREPEND(ifq, m) do {						\
336 	(m)->m_nextpkt = (ifq)->ifq_head;				\
337 	if ((ifq)->ifq_tail == 0)					\
338 		(ifq)->ifq_tail = (m);					\
339 	(ifq)->ifq_head = (m);						\
340 	(ifq)->ifq_len++;						\
341 } while (0)
342 #define	IF_DEQUEUE(ifq, m) do {						\
343 	(m) = (ifq)->ifq_head;						\
344 	if (m) {							\
345 		if (((ifq)->ifq_head = (m)->m_nextpkt) == 0)		\
346 			(ifq)->ifq_tail = 0;				\
347 		(m)->m_nextpkt = 0;					\
348 		(ifq)->ifq_len--;					\
349 	}								\
350 } while (0)
351 
352 #define	IF_POLL(ifq, m)		((m) = (ifq)->ifq_head)
353 
354 #define IF_DRAIN(ifq) do {						\
355 	struct mbuf *m;							\
356 	while (1) {							\
357 		IF_DEQUEUE(ifq, m);					\
358 		if (m == NULL)						\
359 			break;						\
360 		m_freem(m);						\
361 	}								\
362 } while (0)
363 
364 #ifdef _KERNEL
365 
366 /* interface link layer address change event */
367 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
368 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
369 
370 #ifdef INVARIANTS
371 #define ASSERT_IFNET_SERIALIZED_ALL(ifp) \
372 	(ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, TRUE)
373 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp) \
374 	(ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, FALSE)
375 
376 #define ASSERT_IFNET_SERIALIZED_TX(ifp) \
377 	(ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_TX, TRUE)
378 #define ASSERT_IFNET_NOT_SERIALIZED_TX(ifp) \
379 	(ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_TX, FALSE)
380 
381 #define ASSERT_IFNET_SERIALIZED_MAIN(ifp) \
382 	(ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_MAIN, TRUE)
383 #define ASSERT_IFNET_NOT_SERIALIZED_MAIN(ifp) \
384 	(ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_MAIN, FALSE)
385 #else
386 #define ASSERT_IFNET_SERIALIZED_ALL(ifp)	((void)0)
387 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp)	((void)0)
388 #define ASSERT_IFNET_SERIALIZED_TX(ifp)		((void)0)
389 #define ASSERT_IFNET_NOT_SERIALIZED_TX(ifp)	((void)0)
390 #define ASSERT_IFNET_SERIALIZED_MAIN(ifp)	((void)0)
391 #define ASSERT_IFNET_NOT_SERIALIZED_MAIN(ifp)	((void)0)
392 #endif
393 
394 static __inline void
395 ifnet_serialize_all(struct ifnet *_ifp)
396 {
397 	_ifp->if_serialize(_ifp, IFNET_SERIALIZE_ALL);
398 }
399 
400 static __inline void
401 ifnet_deserialize_all(struct ifnet *_ifp)
402 {
403 	_ifp->if_deserialize(_ifp, IFNET_SERIALIZE_ALL);
404 }
405 
406 static __inline int
407 ifnet_tryserialize_all(struct ifnet *_ifp)
408 {
409 	return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_ALL);
410 }
411 
412 static __inline void
413 ifnet_serialize_tx(struct ifnet *_ifp)
414 {
415 	_ifp->if_serialize(_ifp, IFNET_SERIALIZE_TX);
416 }
417 
418 static __inline void
419 ifnet_deserialize_tx(struct ifnet *_ifp)
420 {
421 	_ifp->if_deserialize(_ifp, IFNET_SERIALIZE_TX);
422 }
423 
424 static __inline int
425 ifnet_tryserialize_tx(struct ifnet *_ifp)
426 {
427 	return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_TX);
428 }
429 
430 static __inline void
431 ifnet_serialize_main(struct ifnet *_ifp)
432 {
433 	_ifp->if_serialize(_ifp, IFNET_SERIALIZE_MAIN);
434 }
435 
436 static __inline void
437 ifnet_deserialize_main(struct ifnet *_ifp)
438 {
439 	_ifp->if_deserialize(_ifp, IFNET_SERIALIZE_MAIN);
440 }
441 
442 static __inline int
443 ifnet_tryserialize_main(struct ifnet *_ifp)
444 {
445 	return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_MAIN);
446 }
447 
448 /*
449  * DEPRECATED - should not be used by any new driver.  This code uses the
450  * old queueing interface and if_start ABI and does not use the ifp's
451  * serializer.
452  */
453 #define IF_HANDOFF(ifq, m, ifp)			if_handoff(ifq, m, ifp, 0)
454 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj)	if_handoff(ifq, m, ifp, adj)
455 
456 static __inline int
457 if_handoff(struct ifqueue *_ifq, struct mbuf *_m, struct ifnet *_ifp,
458 	   int _adjust)
459 {
460 	int _need_if_start = 0;
461 
462 	crit_enter();
463 
464 	if (IF_QFULL(_ifq)) {
465 		IF_DROP(_ifq);
466 		crit_exit();
467 		m_freem(_m);
468 		return (0);
469 	}
470 	if (_ifp != NULL) {
471 		_ifp->if_obytes += _m->m_pkthdr.len + _adjust;
472 		if (_m->m_flags & M_MCAST)
473 			_ifp->if_omcasts++;
474 		_need_if_start = !(_ifp->if_flags & IFF_OACTIVE);
475 	}
476 	IF_ENQUEUE(_ifq, _m);
477 	if (_need_if_start) {
478 		(*_ifp->if_start)(_ifp);
479 	}
480 	crit_exit();
481 	return (1);
482 }
483 
484 /*
485  * 72 was chosen below because it is the size of a TCP/IP
486  * header (40) + the minimum mss (32).
487  */
488 #define	IF_MINMTU	72
489 #define	IF_MAXMTU	65535
490 
491 #endif /* _KERNEL */
492 
493 struct in_ifaddr;
494 
495 struct in_ifaddr_container {
496 	struct in_ifaddr	*ia;
497 	LIST_ENTRY(in_ifaddr_container) ia_hash;
498 				/* entry in bucket of inet addresses */
499 	TAILQ_ENTRY(in_ifaddr_container) ia_link;
500 				/* list of internet addresses */
501 	struct ifaddr_container	*ia_ifac; /* parent ifaddr_container */
502 };
503 
504 struct ifaddr_container {
505 #define IFA_CONTAINER_MAGIC	0x19810219
506 #define IFA_CONTAINER_DEAD	0xc0dedead
507 	uint32_t		ifa_magic;  /* IFA_CONTAINER_MAGIC */
508 	struct ifaddr		*ifa;
509 	TAILQ_ENTRY(ifaddr_container)	ifa_link;   /* queue macro glue */
510 	u_int			ifa_refcnt; /* references to this structure */
511 	uint16_t		ifa_listmask;	/* IFA_LIST_ */
512 	uint16_t		ifa_prflags;	/* protocol specific flags */
513 
514 	/*
515 	 * Protocol specific states
516 	 */
517 	union {
518 		struct in_ifaddr_container u_in_ifac;
519 	} ifa_proto_u;
520 };
521 
522 #define IFA_LIST_IFADDRHEAD	0x01	/* on ifnet.if_addrheads[cpuid] */
523 #define IFA_LIST_IN_IFADDRHEAD	0x02	/* on in_ifaddrheads[cpuid] */
524 #define IFA_LIST_IN_IFADDRHASH	0x04	/* on in_ifaddrhashtbls[cpuid] */
525 
526 #define IFA_PRF_FLAG0		0x01
527 #define IFA_PRF_FLAG1		0x02
528 #define IFA_PRF_FLAG2		0x04
529 #define IFA_PRF_FLAG3		0x08
530 
531 /*
532  * The ifaddr structure contains information about one address
533  * of an interface.  They are maintained by the different address families,
534  * are allocated and attached when an address is set, and are linked
535  * together so all addresses for an interface can be located.
536  */
537 struct ifaddr {
538 	struct	sockaddr *ifa_addr;	/* address of interface */
539 	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
540 #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
541 	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
542 	struct	if_data if_data;	/* not all members are meaningful */
543 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
544 	void	*ifa_link_pad;
545 	struct ifaddr_container *ifa_containers;
546 	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
547 		(int, struct rtentry *, struct rt_addrinfo *);
548 	u_short	ifa_flags;		/* mostly rt_flags for cloning */
549 	int	ifa_ncnt;		/* # of valid ifaddr_container */
550 	int	ifa_metric;		/* cost of going out this interface */
551 #ifdef notdef
552 	struct	rtentry *ifa_rt;	/* XXXX for ROUTETOIF ????? */
553 #endif
554 	int (*ifa_claim_addr)		/* check if an addr goes to this if */
555 		(struct ifaddr *, struct sockaddr *);
556 
557 };
558 #define	IFA_ROUTE	RTF_UP		/* route installed */
559 
560 /* for compatibility with other BSDs */
561 #define	ifa_list	ifa_link
562 
563 /*
564  * The prefix structure contains information about one prefix
565  * of an interface.  They are maintained by the different address families,
566  * are allocated and attached when an prefix or an address is set,
567  * and are linked together so all prefixes for an interface can be located.
568  */
569 struct ifprefix {
570 	struct	sockaddr *ifpr_prefix;	/* prefix of interface */
571 	struct	ifnet *ifpr_ifp;	/* back-pointer to interface */
572 	TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
573 	u_char	ifpr_plen;		/* prefix length in bits */
574 	u_char	ifpr_type;		/* protocol dependent prefix type */
575 };
576 
577 /*
578  * Multicast address structure.  This is analogous to the ifaddr
579  * structure except that it keeps track of multicast addresses.
580  * Also, the reference count here is a count of requests for this
581  * address, not a count of pointers to this structure.
582  */
583 struct ifmultiaddr {
584 	TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
585 	struct	sockaddr *ifma_addr;	/* address this membership is for */
586 	struct	sockaddr *ifma_lladdr;	/* link-layer translation, if any */
587 	struct	ifnet *ifma_ifp;	/* back-pointer to interface */
588 	u_int	ifma_refcount;		/* reference count */
589 	void	*ifma_protospec;	/* protocol-specific state, if any */
590 };
591 
592 #ifdef _KERNEL
593 
594 enum ifaddr_event {
595 	IFADDR_EVENT_ADD,
596 	IFADDR_EVENT_DELETE,
597 	IFADDR_EVENT_CHANGE
598 };
599 
600 /* interface address change event */
601 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *,
602 	enum ifaddr_event, struct ifaddr *);
603 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
604 /* new interface attach event */
605 typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *);
606 EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t);
607 /* interface detach event */
608 typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *);
609 EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t);
610 
611 /*
612  * interface groups
613  */
614 struct ifg_group {
615 	char				 ifg_group[IFNAMSIZ];
616 	u_int				 ifg_refcnt;
617 	void				*ifg_pf_kif;
618 	int				 ifg_carp_demoted;
619 	TAILQ_HEAD(, ifg_member)	 ifg_members;
620 	TAILQ_ENTRY(ifg_group)		 ifg_next;
621 };
622 
623 struct ifg_member {
624 	TAILQ_ENTRY(ifg_member)	 ifgm_next;
625 	struct ifnet		*ifgm_ifp;
626 };
627 
628 struct ifg_list {
629 	struct ifg_group	*ifgl_group;
630 	TAILQ_ENTRY(ifg_list)	 ifgl_next;
631 };
632 
633 /* group attach event */
634 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
635 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
636 /* group detach event */
637 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
638 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
639 /* group change event */
640 typedef void (*group_change_event_handler_t)(void *, const char *);
641 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
642 
643 
644 #ifdef INVARIANTS
645 #define ASSERT_IFAC_VALID(ifac)	do { \
646 	KKASSERT((ifac)->ifa_magic == IFA_CONTAINER_MAGIC); \
647 	KKASSERT((ifac)->ifa_refcnt > 0); \
648 } while (0)
649 #else
650 #define ASSERT_IFAC_VALID(ifac)	((void)0)
651 #endif
652 
653 static __inline void
654 _IFAREF(struct ifaddr *_ifa, int _cpu_id)
655 {
656 	struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
657 
658 	crit_enter();
659 	ASSERT_IFAC_VALID(_ifac);
660 	++_ifac->ifa_refcnt;
661 	crit_exit();
662 }
663 
664 static __inline void
665 IFAREF(struct ifaddr *_ifa)
666 {
667 	_IFAREF(_ifa, mycpuid);
668 }
669 
670 #include <sys/malloc.h>
671 
672 MALLOC_DECLARE(M_IFADDR);
673 MALLOC_DECLARE(M_IFMADDR);
674 MALLOC_DECLARE(M_IFNET);
675 
676 void	ifac_free(struct ifaddr_container *, int);
677 
678 static __inline void
679 _IFAFREE(struct ifaddr *_ifa, int _cpu_id)
680 {
681 	struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
682 
683 	crit_enter();
684 	ASSERT_IFAC_VALID(_ifac);
685 	if (--_ifac->ifa_refcnt == 0)
686 		ifac_free(_ifac, _cpu_id);
687 	crit_exit();
688 }
689 
690 static __inline void
691 IFAFREE(struct ifaddr *_ifa)
692 {
693 	_IFAFREE(_ifa, mycpuid);
694 }
695 
696 struct lwkt_port *ifnet_portfn(int);
697 int	ifnet_domsg(struct lwkt_msg *, int);
698 void	ifnet_sendmsg(struct lwkt_msg *, int);
699 void	ifnet_forwardmsg(struct lwkt_msg *, int);
700 struct ifnet *ifnet_byindex(unsigned short);
701 
702 static __inline int
703 ifa_domsg(struct lwkt_msg *_lmsg, int _cpu)
704 {
705 	return ifnet_domsg(_lmsg, _cpu);
706 }
707 
708 static __inline void
709 ifa_sendmsg(struct lwkt_msg *_lmsg, int _cpu)
710 {
711 	ifnet_sendmsg(_lmsg, _cpu);
712 }
713 
714 static __inline void
715 ifa_forwardmsg(struct lwkt_msg *_lmsg, int _nextcpu)
716 {
717 	ifnet_forwardmsg(_lmsg, _nextcpu);
718 }
719 
720 #define REINPUT_KEEPRCVIF	0x0001	/* ether_reinput_oncpu() */
721 #define REINPUT_RUNBPF 		0x0002	/* ether_reinput_oncpu() */
722 
723 
724 extern	struct ifnethead ifnet;
725 extern struct	ifnet	**ifindex2ifnet;
726 extern	int ifqmaxlen;
727 extern	struct ifnet loif[];
728 extern	int if_index;
729 
730 void	ether_ifattach(struct ifnet *, uint8_t *, struct lwkt_serialize *);
731 void	ether_ifattach_bpf(struct ifnet *, uint8_t *, u_int, u_int,
732 			struct lwkt_serialize *);
733 void	ether_ifdetach(struct ifnet *);
734 void	ether_demux_oncpu(struct ifnet *, struct mbuf *);
735 void	ether_reinput_oncpu(struct ifnet *, struct mbuf *, int);
736 void	ether_input_chain(struct ifnet *, struct mbuf *,
737 			  const struct pktinfo *, struct mbuf_chain *);
738 void	ether_input_chain_init(struct mbuf_chain *);
739 void	ether_input_dispatch(struct mbuf_chain *);
740 int	ether_output_frame(struct ifnet *, struct mbuf *);
741 int	ether_ioctl(struct ifnet *, int, caddr_t);
742 struct ifnet *ether_bridge_interface(struct ifnet *ifp);
743 uint32_t	ether_crc32_le(const uint8_t *, size_t);
744 uint32_t	ether_crc32_be(const uint8_t *, size_t);
745 
746 int	if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
747 int	if_allmulti(struct ifnet *, int);
748 void	if_attach(struct ifnet *, struct lwkt_serialize *);
749 int	if_delmulti(struct ifnet *, struct sockaddr *);
750 void	if_delallmulti(struct ifnet *ifp);
751 void	if_purgeaddrs_nolink(struct ifnet *);
752 void	if_detach(struct ifnet *);
753 void	if_down(struct ifnet *);
754 void	if_link_state_change(struct ifnet *);
755 void	if_initname(struct ifnet *, const char *, int);
756 int	if_getanyethermac(uint16_t *, int);
757 int	if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
758 struct ifnet *if_alloc(uint8_t);
759 void	if_free(struct ifnet *);
760 void	if_route(struct ifnet *, int flag, int fam);
761 int	if_setlladdr(struct ifnet *, const u_char *, int);
762 void	if_unroute(struct ifnet *, int flag, int fam);
763 void	if_up(struct ifnet *);
764 /*void	ifinit(void);*/ /* declared in systm.h for main() */
765 int	ifioctl(struct socket *, u_long, caddr_t, struct ucred *);
766 int	ifpromisc(struct ifnet *, int);
767 struct	ifnet *ifunit(const char *);
768 struct	ifnet *if_withname(struct sockaddr *);
769 
770 struct	ifg_group *if_creategroup(const char *);
771 int     if_addgroup(struct ifnet *, const char *);
772 int     if_delgroup(struct ifnet *, const char *);
773 int     if_getgroup(caddr_t, struct ifnet *);
774 int     if_getgroupmembers(caddr_t);
775 
776 struct	ifaddr *ifa_ifwithaddr(struct sockaddr *);
777 struct	ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
778 struct	ifaddr *ifa_ifwithnet(struct sockaddr *);
779 struct	ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
780 struct	ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
781 
782 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
783 typedef void if_com_free_t(void *com, u_char type);
784 void    if_register_com_alloc(u_char, if_com_alloc_t *a, if_com_free_t *);
785 void    if_deregister_com_alloc(u_char);
786 
787 void	*ifa_create(int, int);
788 void	ifa_destroy(struct ifaddr *);
789 void	ifa_iflink(struct ifaddr *, struct ifnet *, int);
790 void	ifa_ifunlink(struct ifaddr *, struct ifnet *);
791 
792 struct ifaddr *ifaddr_byindex(unsigned short);
793 
794 struct	ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
795 int	if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
796 void	if_devstart(struct ifnet *ifp);
797 
798 #define IF_LLSOCKADDR(ifp)						\
799     ((struct sockaddr_dl *)(ifp)->if_lladdr->ifa_addr)
800 #define IF_LLADDR(ifp)	LLADDR(IF_LLSOCKADDR(ifp))
801 
802 #ifdef DEVICE_POLLING
803 typedef	void poll_handler_t (struct ifnet *ifp, enum poll_cmd cmd, int count);
804 int	ether_poll_register(struct ifnet *);
805 int	ether_poll_deregister(struct ifnet *);
806 int	ether_pollcpu_register(struct ifnet *, int);
807 #endif /* DEVICE_POLLING */
808 
809 #ifdef IFPOLL_ENABLE
810 int	ifpoll_register(struct ifnet *);
811 int	ifpoll_deregister(struct ifnet *);
812 #endif	/* IFPOLL_ENABLE */
813 
814 #endif /* _KERNEL */
815 
816 #endif /* !_NET_IF_VAR_H_ */
817