xref: /freebsd/sys/net/if_var.h (revision 669f9224ec5398fbc825dd031415126af032cf42)
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  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	From: @(#)if.h	8.1 (Berkeley) 6/10/93
30  * $FreeBSD$
31  */
32 
33 #ifndef	_NET_IF_VAR_H_
34 #define	_NET_IF_VAR_H_
35 
36 /*
37  * Structures defining a network interface, providing a packet
38  * transport mechanism (ala level 0 of the PUP protocols).
39  *
40  * Each interface accepts output datagrams of a specified maximum
41  * length, and provides higher level routines with input datagrams
42  * received from its medium.
43  *
44  * Output occurs when the routine if_output is called, with three parameters:
45  *	(*ifp->if_output)(ifp, m, dst, rt)
46  * Here m is the mbuf chain to be sent and dst is the destination address.
47  * The output routine encapsulates the supplied datagram if necessary,
48  * and then transmits it on its medium.
49  *
50  * On input, each interface unwraps the data received by it, and either
51  * places it on the input queue of an internetwork datagram routine
52  * and posts the associated software interrupt, or passes the datagram to a raw
53  * packet input routine.
54  *
55  * Routines exist for locating interfaces by their addresses
56  * or for locating an interface on a certain network, as well as more general
57  * routing and gateway routines maintaining information used to locate
58  * interfaces.  These routines live in the files if.c and route.c
59  */
60 
61 struct	rtentry;		/* ifa_rtrequest */
62 struct	rt_addrinfo;		/* ifa_rtrequest */
63 struct	socket;
64 struct	carp_if;
65 struct	carp_softc;
66 struct  ifvlantrunk;
67 struct	route;			/* if_output */
68 struct	vnet;
69 struct	ifmedia;
70 struct	netmap_adapter;
71 
72 #ifdef _KERNEL
73 #include <sys/mbuf.h>		/* ifqueue only? */
74 #include <sys/buf_ring.h>
75 #include <net/vnet.h>
76 #endif /* _KERNEL */
77 #include <sys/counter.h>
78 #include <sys/lock.h>		/* XXX */
79 #include <sys/mutex.h>		/* struct ifqueue */
80 #include <sys/rwlock.h>		/* XXX */
81 #include <sys/sx.h>		/* XXX */
82 #include <sys/_task.h>		/* if_link_task */
83 
84 #define	IF_DUNIT_NONE	-1
85 
86 #include <net/altq/if_altq.h>
87 
88 TAILQ_HEAD(ifnethead, ifnet);	/* we use TAILQs so that the order of */
89 TAILQ_HEAD(ifaddrhead, ifaddr);	/* instantiation is preserved in the list */
90 TAILQ_HEAD(ifmultihead, ifmultiaddr);
91 TAILQ_HEAD(ifgrouphead, ifg_group);
92 
93 #ifdef _KERNEL
94 VNET_DECLARE(struct pfil_head, link_pfil_hook);	/* packet filter hooks */
95 #define	V_link_pfil_hook	VNET(link_pfil_hook)
96 
97 #define	HHOOK_IPSEC_INET	0
98 #define	HHOOK_IPSEC_INET6	1
99 #define	HHOOK_IPSEC_COUNT	2
100 VNET_DECLARE(struct hhook_head *, ipsec_hhh_in[HHOOK_IPSEC_COUNT]);
101 VNET_DECLARE(struct hhook_head *, ipsec_hhh_out[HHOOK_IPSEC_COUNT]);
102 #define	V_ipsec_hhh_in	VNET(ipsec_hhh_in)
103 #define	V_ipsec_hhh_out	VNET(ipsec_hhh_out)
104 #endif /* _KERNEL */
105 
106 typedef enum {
107 	IFCOUNTER_IPACKETS = 0,
108 	IFCOUNTER_IERRORS,
109 	IFCOUNTER_OPACKETS,
110 	IFCOUNTER_OERRORS,
111 	IFCOUNTER_COLLISIONS,
112 	IFCOUNTER_IBYTES,
113 	IFCOUNTER_OBYTES,
114 	IFCOUNTER_IMCASTS,
115 	IFCOUNTER_OMCASTS,
116 	IFCOUNTER_IQDROPS,
117 	IFCOUNTER_OQDROPS,
118 	IFCOUNTER_NOPROTO,
119 	IFCOUNTERS /* Array size. */
120 } ift_counter;
121 
122 typedef struct ifnet * if_t;
123 
124 typedef	void (*if_start_fn_t)(if_t);
125 typedef	int (*if_ioctl_fn_t)(if_t, u_long, caddr_t);
126 typedef	void (*if_init_fn_t)(void *);
127 typedef void (*if_qflush_fn_t)(if_t);
128 typedef int (*if_transmit_fn_t)(if_t, struct mbuf *);
129 typedef	uint64_t (*if_get_counter_t)(if_t, ift_counter);
130 
131 struct ifnet_hw_tsomax {
132 	u_int	tsomaxbytes;	/* TSO total burst length limit in bytes */
133 	u_int	tsomaxsegcount;	/* TSO maximum segment count */
134 	u_int	tsomaxsegsize;	/* TSO maximum segment size in bytes */
135 };
136 
137 /*
138  * Structure defining a network interface.
139  *
140  * Size ILP32:  592 (approx)
141  *	 LP64: 1048 (approx)
142  */
143 struct ifnet {
144 	/* General book keeping of interface lists. */
145 	TAILQ_ENTRY(ifnet) if_link; 	/* all struct ifnets are chained */
146 	LIST_ENTRY(ifnet) if_clones;	/* interfaces of a cloner */
147 	TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
148 					/* protected by if_addr_lock */
149 	u_char	if_alloctype;		/* if_type at time of allocation */
150 
151 	/* Driver and protocol specific information that remains stable. */
152 	void	*if_softc;		/* pointer to driver state */
153 	void	*if_llsoftc;		/* link layer softc */
154 	void	*if_l2com;		/* pointer to protocol bits */
155 	const char *if_dname;		/* driver name */
156 	int	if_dunit;		/* unit or IF_DUNIT_NONE */
157 	u_short	if_index;		/* numeric abbreviation for this if  */
158 	short	if_index_reserved;	/* spare space to grow if_index */
159 	char	if_xname[IFNAMSIZ];	/* external name (name + unit) */
160 	char	*if_description;	/* interface description */
161 
162 	/* Variable fields that are touched by the stack and drivers. */
163 	int	if_flags;		/* up/down, broadcast, etc. */
164 	int	if_drv_flags;		/* driver-managed status flags */
165 	int	if_capabilities;	/* interface features & capabilities */
166 	int	if_capenable;		/* enabled features & capabilities */
167 	void	*if_linkmib;		/* link-type-specific MIB data */
168 	size_t	if_linkmiblen;		/* length of above data */
169 	u_int	if_refcount;		/* reference count */
170 
171 	/* These fields are shared with struct if_data. */
172 	uint8_t		if_type;	/* ethernet, tokenring, etc */
173 	uint8_t		if_addrlen;	/* media address length */
174 	uint8_t		if_hdrlen;	/* media header length */
175 	uint8_t		if_link_state;	/* current link state */
176 	uint32_t	if_mtu;		/* maximum transmission unit */
177 	uint32_t	if_metric;	/* routing metric (external only) */
178 	uint64_t	if_baudrate;	/* linespeed */
179 	uint64_t	if_hwassist;	/* HW offload capabilities, see IFCAP */
180 	time_t		if_epoch;	/* uptime at attach or stat reset */
181 	struct timeval	if_lastchange;	/* time of last administrative change */
182 
183 	struct  ifaltq if_snd;		/* output queue (includes altq) */
184 	struct	task if_linktask;	/* task for link change events */
185 
186 	/* Addresses of different protocol families assigned to this if. */
187 	struct	rwlock if_addr_lock;	/* lock to protect address lists */
188 		/*
189 		 * if_addrhead is the list of all addresses associated to
190 		 * an interface.
191 		 * Some code in the kernel assumes that first element
192 		 * of the list has type AF_LINK, and contains sockaddr_dl
193 		 * addresses which store the link-level address and the name
194 		 * of the interface.
195 		 * However, access to the AF_LINK address through this
196 		 * field is deprecated. Use if_addr or ifaddr_byindex() instead.
197 		 */
198 	struct	ifaddrhead if_addrhead;	/* linked list of addresses per if */
199 	struct	ifmultihead if_multiaddrs; /* multicast addresses configured */
200 	int	if_amcount;		/* number of all-multicast requests */
201 	struct	ifaddr	*if_addr;	/* pointer to link-level address */
202 	const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
203 	struct	rwlock if_afdata_lock;
204 	void	*if_afdata[AF_MAX];
205 	int	if_afdata_initialized;
206 
207 	/* Additional features hung off the interface. */
208 	u_int	if_fib;			/* interface FIB */
209 	struct	vnet *if_vnet;		/* pointer to network stack instance */
210 	struct	vnet *if_home_vnet;	/* where this ifnet originates from */
211 	struct  ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */
212 	struct	bpf_if *if_bpf;		/* packet filter structure */
213 	int	if_pcount;		/* number of promiscuous listeners */
214 	void	*if_bridge;		/* bridge glue */
215 	void	*if_lagg;		/* lagg glue */
216 	void	*if_pf_kif;		/* pf glue */
217 	struct	carp_if *if_carp;	/* carp interface structure */
218 	struct	label *if_label;	/* interface MAC label */
219 	struct	netmap_adapter *if_netmap; /* netmap(4) softc */
220 
221 	/* Various procedures of the layer2 encapsulation and drivers. */
222 	int	(*if_output)		/* output routine (enqueue) */
223 		(struct ifnet *, struct mbuf *, const struct sockaddr *,
224 		     struct route *);
225 	void	(*if_input)		/* input routine (from h/w driver) */
226 		(struct ifnet *, struct mbuf *);
227 	if_start_fn_t	if_start;	/* initiate output routine */
228 	if_ioctl_fn_t	if_ioctl;	/* ioctl routine */
229 	if_init_fn_t	if_init;	/* Init routine */
230 	int	(*if_resolvemulti)	/* validate/resolve multicast */
231 		(struct ifnet *, struct sockaddr **, struct sockaddr *);
232 	if_qflush_fn_t	if_qflush;	/* flush any queue */
233 	if_transmit_fn_t if_transmit;   /* initiate output routine */
234 
235 	void	(*if_reassign)		/* reassign to vnet routine */
236 		(struct ifnet *, struct vnet *, char *);
237 	if_get_counter_t if_get_counter; /* get counter values */
238 
239 	/* Statistics. */
240 	counter_u64_t	if_counters[IFCOUNTERS];
241 
242 	/* Stuff that's only temporary and doesn't belong here. */
243 
244 	/*
245 	 * Network adapter TSO limits:
246 	 * ===========================
247 	 *
248 	 * If the "if_hw_tsomax" field is zero the maximum segment
249 	 * length limit does not apply. If the "if_hw_tsomaxsegcount"
250 	 * or the "if_hw_tsomaxsegsize" field is zero the TSO segment
251 	 * count limit does not apply. If all three fields are zero,
252 	 * there is no TSO limit.
253 	 *
254 	 * NOTE: The TSO limits should reflect the values used in the
255 	 * BUSDMA tag a network adapter is using to load a mbuf chain
256 	 * for transmission. The TCP/IP network stack will subtract
257 	 * space for all linklevel and protocol level headers and
258 	 * ensure that the full mbuf chain passed to the network
259 	 * adapter fits within the given limits.
260 	 */
261 	u_int	if_hw_tsomax;		/* TSO maximum size in bytes */
262 	u_int	if_hw_tsomaxsegcount;	/* TSO maximum segment count */
263 	u_int	if_hw_tsomaxsegsize;	/* TSO maximum segment size in bytes */
264 
265 	/*
266 	 * Spare fields to be added before branching a stable branch, so
267 	 * that structure can be enhanced without changing the kernel
268 	 * binary interface.
269 	 */
270 };
271 
272 /* for compatibility with other BSDs */
273 #define	if_addrlist	if_addrhead
274 #define	if_list		if_link
275 #define	if_name(ifp)	((ifp)->if_xname)
276 
277 /*
278  * Locks for address lists on the network interface.
279  */
280 #define	IF_ADDR_LOCK_INIT(if)	rw_init(&(if)->if_addr_lock, "if_addr_lock")
281 #define	IF_ADDR_LOCK_DESTROY(if)	rw_destroy(&(if)->if_addr_lock)
282 #define	IF_ADDR_WLOCK(if)	rw_wlock(&(if)->if_addr_lock)
283 #define	IF_ADDR_WUNLOCK(if)	rw_wunlock(&(if)->if_addr_lock)
284 #define	IF_ADDR_RLOCK(if)	rw_rlock(&(if)->if_addr_lock)
285 #define	IF_ADDR_RUNLOCK(if)	rw_runlock(&(if)->if_addr_lock)
286 #define	IF_ADDR_LOCK_ASSERT(if)	rw_assert(&(if)->if_addr_lock, RA_LOCKED)
287 #define	IF_ADDR_WLOCK_ASSERT(if) rw_assert(&(if)->if_addr_lock, RA_WLOCKED)
288 
289 /*
290  * Function variations on locking macros intended to be used by loadable
291  * kernel modules in order to divorce them from the internals of address list
292  * locking.
293  */
294 void	if_addr_rlock(struct ifnet *ifp);	/* if_addrhead */
295 void	if_addr_runlock(struct ifnet *ifp);	/* if_addrhead */
296 void	if_maddr_rlock(if_t ifp);	/* if_multiaddrs */
297 void	if_maddr_runlock(if_t ifp);	/* if_multiaddrs */
298 
299 #ifdef _KERNEL
300 #ifdef _SYS_EVENTHANDLER_H_
301 /* interface link layer address change event */
302 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
303 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
304 /* interface address change event */
305 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
306 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
307 /* new interface arrival event */
308 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
309 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
310 /* interface departure event */
311 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
312 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
313 /* Interface link state change event */
314 typedef void (*ifnet_link_event_handler_t)(void *, struct ifnet *, int);
315 EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t);
316 #endif /* _SYS_EVENTHANDLER_H_ */
317 
318 /*
319  * interface groups
320  */
321 struct ifg_group {
322 	char				 ifg_group[IFNAMSIZ];
323 	u_int				 ifg_refcnt;
324 	void				*ifg_pf_kif;
325 	TAILQ_HEAD(, ifg_member)	 ifg_members;
326 	TAILQ_ENTRY(ifg_group)		 ifg_next;
327 };
328 
329 struct ifg_member {
330 	TAILQ_ENTRY(ifg_member)	 ifgm_next;
331 	struct ifnet		*ifgm_ifp;
332 };
333 
334 struct ifg_list {
335 	struct ifg_group	*ifgl_group;
336 	TAILQ_ENTRY(ifg_list)	 ifgl_next;
337 };
338 
339 #ifdef _SYS_EVENTHANDLER_H_
340 /* group attach event */
341 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
342 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
343 /* group detach event */
344 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
345 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
346 /* group change event */
347 typedef void (*group_change_event_handler_t)(void *, const char *);
348 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
349 #endif /* _SYS_EVENTHANDLER_H_ */
350 
351 #define	IF_AFDATA_LOCK_INIT(ifp)	\
352 	rw_init(&(ifp)->if_afdata_lock, "if_afdata")
353 
354 #define	IF_AFDATA_WLOCK(ifp)	rw_wlock(&(ifp)->if_afdata_lock)
355 #define	IF_AFDATA_RLOCK(ifp)	rw_rlock(&(ifp)->if_afdata_lock)
356 #define	IF_AFDATA_WUNLOCK(ifp)	rw_wunlock(&(ifp)->if_afdata_lock)
357 #define	IF_AFDATA_RUNLOCK(ifp)	rw_runlock(&(ifp)->if_afdata_lock)
358 #define	IF_AFDATA_LOCK(ifp)	IF_AFDATA_WLOCK(ifp)
359 #define	IF_AFDATA_UNLOCK(ifp)	IF_AFDATA_WUNLOCK(ifp)
360 #define	IF_AFDATA_TRYLOCK(ifp)	rw_try_wlock(&(ifp)->if_afdata_lock)
361 #define	IF_AFDATA_DESTROY(ifp)	rw_destroy(&(ifp)->if_afdata_lock)
362 
363 #define	IF_AFDATA_LOCK_ASSERT(ifp)	rw_assert(&(ifp)->if_afdata_lock, RA_LOCKED)
364 #define	IF_AFDATA_RLOCK_ASSERT(ifp)	rw_assert(&(ifp)->if_afdata_lock, RA_RLOCKED)
365 #define	IF_AFDATA_WLOCK_ASSERT(ifp)	rw_assert(&(ifp)->if_afdata_lock, RA_WLOCKED)
366 #define	IF_AFDATA_UNLOCK_ASSERT(ifp)	rw_assert(&(ifp)->if_afdata_lock, RA_UNLOCKED)
367 
368 /*
369  * 72 was chosen below because it is the size of a TCP/IP
370  * header (40) + the minimum mss (32).
371  */
372 #define	IF_MINMTU	72
373 #define	IF_MAXMTU	65535
374 
375 #define	TOEDEV(ifp)	((ifp)->if_llsoftc)
376 
377 /*
378  * The ifaddr structure contains information about one address
379  * of an interface.  They are maintained by the different address families,
380  * are allocated and attached when an address is set, and are linked
381  * together so all addresses for an interface can be located.
382  *
383  * NOTE: a 'struct ifaddr' is always at the beginning of a larger
384  * chunk of malloc'ed memory, where we store the three addresses
385  * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
386  */
387 struct ifaddr {
388 	struct	sockaddr *ifa_addr;	/* address of interface */
389 	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
390 #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
391 	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
392 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
393 	struct	carp_softc *ifa_carp;	/* pointer to CARP data */
394 	TAILQ_ENTRY(ifaddr) ifa_link;	/* queue macro glue */
395 	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
396 		(int, struct rtentry *, struct rt_addrinfo *);
397 	u_short	ifa_flags;		/* mostly rt_flags for cloning */
398 #define	IFA_ROUTE	RTF_UP		/* route installed */
399 #define	IFA_RTSELF	RTF_HOST	/* loopback route to self installed */
400 	u_int	ifa_refcnt;		/* references to this structure */
401 
402 	counter_u64_t	ifa_ipackets;
403 	counter_u64_t	ifa_opackets;
404 	counter_u64_t	ifa_ibytes;
405 	counter_u64_t	ifa_obytes;
406 };
407 
408 /* For compatibility with other BSDs. SCTP uses it. */
409 #define	ifa_list	ifa_link
410 
411 struct ifaddr *	ifa_alloc(size_t size, int flags);
412 void	ifa_free(struct ifaddr *ifa);
413 void	ifa_ref(struct ifaddr *ifa);
414 
415 /*
416  * Multicast address structure.  This is analogous to the ifaddr
417  * structure except that it keeps track of multicast addresses.
418  */
419 struct ifmultiaddr {
420 	TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
421 	struct	sockaddr *ifma_addr; 	/* address this membership is for */
422 	struct	sockaddr *ifma_lladdr;	/* link-layer translation, if any */
423 	struct	ifnet *ifma_ifp;	/* back-pointer to interface */
424 	u_int	ifma_refcount;		/* reference count */
425 	void	*ifma_protospec;	/* protocol-specific state, if any */
426 	struct	ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
427 };
428 
429 extern	struct rwlock ifnet_rwlock;
430 extern	struct sx ifnet_sxlock;
431 
432 #define	IFNET_WLOCK() do {						\
433 	sx_xlock(&ifnet_sxlock);					\
434 	rw_wlock(&ifnet_rwlock);					\
435 } while (0)
436 
437 #define	IFNET_WUNLOCK() do {						\
438 	rw_wunlock(&ifnet_rwlock);					\
439 	sx_xunlock(&ifnet_sxlock);					\
440 } while (0)
441 
442 /*
443  * To assert the ifnet lock, you must know not only whether it's for read or
444  * write, but also whether it was acquired with sleep support or not.
445  */
446 #define	IFNET_RLOCK_ASSERT()		sx_assert(&ifnet_sxlock, SA_SLOCKED)
447 #define	IFNET_RLOCK_NOSLEEP_ASSERT()	rw_assert(&ifnet_rwlock, RA_RLOCKED)
448 #define	IFNET_WLOCK_ASSERT() do {					\
449 	sx_assert(&ifnet_sxlock, SA_XLOCKED);				\
450 	rw_assert(&ifnet_rwlock, RA_WLOCKED);				\
451 } while (0)
452 
453 #define	IFNET_RLOCK()		sx_slock(&ifnet_sxlock)
454 #define	IFNET_RLOCK_NOSLEEP()	rw_rlock(&ifnet_rwlock)
455 #define	IFNET_RUNLOCK()		sx_sunlock(&ifnet_sxlock)
456 #define	IFNET_RUNLOCK_NOSLEEP()	rw_runlock(&ifnet_rwlock)
457 
458 /*
459  * Look up an ifnet given its index; the _ref variant also acquires a
460  * reference that must be freed using if_rele().  It is almost always a bug
461  * to call ifnet_byindex() instead if ifnet_byindex_ref().
462  */
463 struct ifnet	*ifnet_byindex(u_short idx);
464 struct ifnet	*ifnet_byindex_locked(u_short idx);
465 struct ifnet	*ifnet_byindex_ref(u_short idx);
466 
467 /*
468  * Given the index, ifaddr_byindex() returns the one and only
469  * link-level ifaddr for the interface. You are not supposed to use
470  * it to traverse the list of addresses associated to the interface.
471  */
472 struct ifaddr	*ifaddr_byindex(u_short idx);
473 
474 VNET_DECLARE(struct ifnethead, ifnet);
475 VNET_DECLARE(struct ifgrouphead, ifg_head);
476 VNET_DECLARE(int, if_index);
477 VNET_DECLARE(struct ifnet *, loif);	/* first loopback interface */
478 
479 #define	V_ifnet		VNET(ifnet)
480 #define	V_ifg_head	VNET(ifg_head)
481 #define	V_if_index	VNET(if_index)
482 #define	V_loif		VNET(loif)
483 
484 int	if_addgroup(struct ifnet *, const char *);
485 int	if_delgroup(struct ifnet *, const char *);
486 int	if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
487 int	if_allmulti(struct ifnet *, int);
488 struct	ifnet* if_alloc(u_char);
489 void	if_attach(struct ifnet *);
490 void	if_dead(struct ifnet *);
491 int	if_delmulti(struct ifnet *, struct sockaddr *);
492 void	if_delmulti_ifma(struct ifmultiaddr *);
493 void	if_detach(struct ifnet *);
494 void	if_vmove(struct ifnet *, struct vnet *);
495 void	if_purgeaddrs(struct ifnet *);
496 void	if_delallmulti(struct ifnet *);
497 void	if_down(struct ifnet *);
498 struct ifmultiaddr *
499 	if_findmulti(struct ifnet *, const struct sockaddr *);
500 void	if_free(struct ifnet *);
501 void	if_initname(struct ifnet *, const char *, int);
502 void	if_link_state_change(struct ifnet *, int);
503 int	if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
504 void	if_ref(struct ifnet *);
505 void	if_rele(struct ifnet *);
506 int	if_setlladdr(struct ifnet *, const u_char *, int);
507 void	if_up(struct ifnet *);
508 int	ifioctl(struct socket *, u_long, caddr_t, struct thread *);
509 int	ifpromisc(struct ifnet *, int);
510 struct	ifnet *ifunit(const char *);
511 struct	ifnet *ifunit_ref(const char *);
512 
513 int	ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
514 int	ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
515 int	ifa_switch_loopback_route(struct ifaddr *, struct sockaddr *);
516 
517 struct	ifaddr *ifa_ifwithaddr(const struct sockaddr *);
518 int		ifa_ifwithaddr_check(const struct sockaddr *);
519 struct	ifaddr *ifa_ifwithbroadaddr(const struct sockaddr *, int);
520 struct	ifaddr *ifa_ifwithdstaddr(const struct sockaddr *, int);
521 struct	ifaddr *ifa_ifwithnet(const struct sockaddr *, int, int);
522 struct	ifaddr *ifa_ifwithroute(int, const struct sockaddr *, struct sockaddr *,
523     u_int);
524 struct	ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *);
525 int	ifa_preferred(struct ifaddr *, struct ifaddr *);
526 
527 int	if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
528 
529 typedef	void *if_com_alloc_t(u_char type, struct ifnet *ifp);
530 typedef	void if_com_free_t(void *com, u_char type);
531 void	if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
532 void	if_deregister_com_alloc(u_char type);
533 void	if_data_copy(struct ifnet *, struct if_data *);
534 uint64_t if_get_counter_default(struct ifnet *, ift_counter);
535 void	if_inc_counter(struct ifnet *, ift_counter, int64_t);
536 
537 #define IF_LLADDR(ifp)							\
538     LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr))
539 
540 uint64_t if_setbaudrate(if_t ifp, uint64_t baudrate);
541 uint64_t if_getbaudrate(if_t ifp);
542 int if_setcapabilities(if_t ifp, int capabilities);
543 int if_setcapabilitiesbit(if_t ifp, int setbit, int clearbit);
544 int if_getcapabilities(if_t ifp);
545 int if_togglecapenable(if_t ifp, int togglecap);
546 int if_setcapenable(if_t ifp, int capenable);
547 int if_setcapenablebit(if_t ifp, int setcap, int clearcap);
548 int if_getcapenable(if_t ifp);
549 const char *if_getdname(if_t ifp);
550 int if_setdev(if_t ifp, void *dev);
551 int if_setdrvflagbits(if_t ifp, int if_setflags, int clear_flags);
552 int if_getdrvflags(if_t ifp);
553 int if_setdrvflags(if_t ifp, int flags);
554 int if_clearhwassist(if_t ifp);
555 int if_sethwassistbits(if_t ifp, int toset, int toclear);
556 int if_sethwassist(if_t ifp, int hwassist_bit);
557 int if_gethwassist(if_t ifp);
558 int if_setsoftc(if_t ifp, void *softc);
559 void *if_getsoftc(if_t ifp);
560 int if_setflags(if_t ifp, int flags);
561 int if_setmtu(if_t ifp, int mtu);
562 int if_getmtu(if_t ifp);
563 int if_getmtu_family(if_t ifp, int family);
564 int if_setflagbits(if_t ifp, int set, int clear);
565 int if_getflags(if_t ifp);
566 int if_sendq_empty(if_t ifp);
567 int if_setsendqready(if_t ifp);
568 int if_setsendqlen(if_t ifp, int tx_desc_count);
569 int if_input(if_t ifp, struct mbuf* sendmp);
570 int if_sendq_prepend(if_t ifp, struct mbuf *m);
571 struct mbuf *if_dequeue(if_t ifp);
572 int if_setifheaderlen(if_t ifp, int len);
573 void if_setrcvif(struct mbuf *m, if_t ifp);
574 void if_setvtag(struct mbuf *m, u_int16_t tag);
575 u_int16_t if_getvtag(struct mbuf *m);
576 int if_vlantrunkinuse(if_t ifp);
577 caddr_t if_getlladdr(if_t ifp);
578 void *if_gethandle(u_char);
579 void if_bpfmtap(if_t ifp, struct mbuf *m);
580 void if_etherbpfmtap(if_t ifp, struct mbuf *m);
581 void if_vlancap(if_t ifp);
582 
583 int if_setupmultiaddr(if_t ifp, void *mta, int *cnt, int max);
584 int if_multiaddr_array(if_t ifp, void *mta, int *cnt, int max);
585 int if_multiaddr_count(if_t ifp, int max);
586 
587 int if_getamcount(if_t ifp);
588 struct ifaddr * if_getifaddr(if_t ifp);
589 
590 /* Functions */
591 void if_setinitfn(if_t ifp, void (*)(void *));
592 void if_setioctlfn(if_t ifp, int (*)(if_t, u_long, caddr_t));
593 void if_setstartfn(if_t ifp, void (*)(if_t));
594 void if_settransmitfn(if_t ifp, if_transmit_fn_t);
595 void if_setqflushfn(if_t ifp, if_qflush_fn_t);
596 void if_setgetcounterfn(if_t ifp, if_get_counter_t);
597 
598 /* Revisit the below. These are inline functions originally */
599 int drbr_inuse_drv(if_t ifp, struct buf_ring *br);
600 struct mbuf* drbr_dequeue_drv(if_t ifp, struct buf_ring *br);
601 int drbr_needs_enqueue_drv(if_t ifp, struct buf_ring *br);
602 int drbr_enqueue_drv(if_t ifp, struct buf_ring *br, struct mbuf *m);
603 
604 /* TSO */
605 void if_hw_tsomax_common(if_t ifp, struct ifnet_hw_tsomax *);
606 int if_hw_tsomax_update(if_t ifp, struct ifnet_hw_tsomax *);
607 
608 #ifdef DEVICE_POLLING
609 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS };
610 
611 typedef	int poll_handler_t(if_t ifp, enum poll_cmd cmd, int count);
612 int    ether_poll_register(poll_handler_t *h, if_t ifp);
613 int    ether_poll_deregister(if_t ifp);
614 #endif /* DEVICE_POLLING */
615 
616 #endif /* _KERNEL */
617 
618 #include <net/ifq.h>	/* XXXAO: temporary unconditional include */
619 
620 #endif /* !_NET_IF_VAR_H_ */
621