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