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