xref: /freebsd/sys/net/if_var.h (revision f5463265955b829775bbb32e1fd0bc11dafc36ce)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1982, 1986, 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #ifndef	_NET_IF_VAR_H_
33 #define	_NET_IF_VAR_H_
34 
35 /*
36  * Structures defining a network interface, providing a packet
37  * transport mechanism (ala level 0 of the PUP protocols).
38  *
39  * Each interface accepts output datagrams of a specified maximum
40  * length, and provides higher level routines with input datagrams
41  * received from its medium.
42  *
43  * Output occurs when the routine if_output is called, with three parameters:
44  *	(*ifp->if_output)(ifp, m, dst, ro)
45  * Here m is the mbuf chain to be sent and dst is the destination address.
46  * The output routine encapsulates the supplied datagram if necessary,
47  * and then transmits it on its medium.
48  *
49  * On input, each interface unwraps the data received by it, and either
50  * places it on the input queue of an internetwork datagram routine
51  * and posts the associated software interrupt, or passes the datagram to a raw
52  * packet input routine.
53  *
54  * Routines exist for locating interfaces by their addresses
55  * or for locating an interface on a certain network, as well as more general
56  * routing and gateway routines maintaining information used to locate
57  * interfaces.  These routines live in the files if.c and route.c
58  */
59 
60 struct	rtentry;		/* ifa_rtrequest */
61 struct	socket;
62 struct	carp_if;
63 struct	carp_softc;
64 struct  ifvlantrunk;
65 struct	route;			/* if_output */
66 struct	vnet;
67 struct	ifmedia;
68 struct	netmap_adapter;
69 struct	debugnet_methods;
70 
71 #ifdef _KERNEL
72 #include <sys/_eventhandler.h>
73 #include <sys/mbuf.h>		/* ifqueue only? */
74 #include <sys/buf_ring.h>
75 #include <net/vnet.h>
76 #endif /* _KERNEL */
77 #include <sys/ck.h>
78 #include <sys/counter.h>
79 #include <sys/epoch.h>
80 #include <sys/lock.h>		/* XXX */
81 #include <sys/mutex.h>		/* struct ifqueue */
82 #include <sys/rwlock.h>		/* XXX */
83 #include <sys/sx.h>		/* XXX */
84 #include <sys/_task.h>		/* if_link_task */
85 #define	IF_DUNIT_NONE	-1
86 
87 #include <net/altq/if_altq.h>
88 
89 CK_STAILQ_HEAD(ifnethead, ifnet);	/* we use TAILQs so that the order of */
90 CK_STAILQ_HEAD(ifaddrhead, ifaddr);	/* instantiation is preserved in the list */
91 CK_STAILQ_HEAD(ifmultihead, ifmultiaddr);
92 CK_STAILQ_HEAD(ifgrouphead, ifg_group);
93 
94 #ifdef _KERNEL
95 VNET_DECLARE(struct pfil_head *, link_pfil_head);
96 #define	V_link_pfil_head	VNET(link_pfil_head)
97 #define	PFIL_ETHER_NAME		"ethernet"
98 
99 #define	HHOOK_IPSEC_INET	0
100 #define	HHOOK_IPSEC_INET6	1
101 #define	HHOOK_IPSEC_COUNT	2
102 VNET_DECLARE(struct hhook_head *, ipsec_hhh_in[HHOOK_IPSEC_COUNT]);
103 VNET_DECLARE(struct hhook_head *, ipsec_hhh_out[HHOOK_IPSEC_COUNT]);
104 #define	V_ipsec_hhh_in	VNET(ipsec_hhh_in)
105 #define	V_ipsec_hhh_out	VNET(ipsec_hhh_out)
106 #endif /* _KERNEL */
107 
108 typedef enum {
109 	IFCOUNTER_IPACKETS = 0,
110 	IFCOUNTER_IERRORS,
111 	IFCOUNTER_OPACKETS,
112 	IFCOUNTER_OERRORS,
113 	IFCOUNTER_COLLISIONS,
114 	IFCOUNTER_IBYTES,
115 	IFCOUNTER_OBYTES,
116 	IFCOUNTER_IMCASTS,
117 	IFCOUNTER_OMCASTS,
118 	IFCOUNTER_IQDROPS,
119 	IFCOUNTER_OQDROPS,
120 	IFCOUNTER_NOPROTO,
121 	IFCOUNTERS /* Array size. */
122 } ift_counter;
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_input_fn_t)(if_t, struct mbuf *);
128 typedef	int (*if_output_fn_t)(if_t, struct mbuf *, const struct sockaddr *,
129     struct route *);
130 typedef void (*if_qflush_fn_t)(if_t);
131 typedef int (*if_transmit_fn_t)(if_t, struct mbuf *);
132 typedef	uint64_t (*if_get_counter_t)(if_t, ift_counter);
133 typedef	void (*if_reassign_fn_t)(if_t, struct vnet *, char *);
134 
135 struct ifnet_hw_tsomax {
136 	u_int	tsomaxbytes;	/* TSO total burst length limit in bytes */
137 	u_int	tsomaxsegcount;	/* TSO maximum segment count */
138 	u_int	tsomaxsegsize;	/* TSO maximum segment size in bytes */
139 };
140 
141 /* Interface encap request types */
142 typedef enum {
143 	IFENCAP_LL = 1			/* pre-calculate link-layer header */
144 } ife_type;
145 
146 /*
147  * The structure below allows to request various pre-calculated L2/L3 headers
148  * for different media. Requests varies by type (rtype field).
149  *
150  * IFENCAP_LL type: pre-calculates link header based on address family
151  *   and destination lladdr.
152  *
153  *   Input data fields:
154  *     buf: pointer to destination buffer
155  *     bufsize: buffer size
156  *     flags: IFENCAP_FLAG_BROADCAST if destination is broadcast
157  *     family: address family defined by AF_ constant.
158  *     lladdr: pointer to link-layer address
159  *     lladdr_len: length of link-layer address
160  *     hdata: pointer to L3 header (optional, used for ARP requests).
161  *   Output data fields:
162  *     buf: encap data is stored here
163  *     bufsize: resulting encap length is stored here
164  *     lladdr_off: offset of link-layer address from encap hdr start
165  *     hdata: L3 header may be altered if necessary
166  */
167 
168 struct if_encap_req {
169 	u_char		*buf;		/* Destination buffer (w) */
170 	size_t		bufsize;	/* size of provided buffer (r) */
171 	ife_type	rtype;		/* request type (r) */
172 	uint32_t	flags;		/* Request flags (r) */
173 	int		family;		/* Address family AF_* (r) */
174 	int		lladdr_off;	/* offset from header start (w) */
175 	int		lladdr_len;	/* lladdr length (r) */
176 	char		*lladdr;	/* link-level address pointer (r) */
177 	char		*hdata;		/* Upper layer header data (rw) */
178 };
179 
180 #define	IFENCAP_FLAG_BROADCAST	0x02	/* Destination is broadcast */
181 
182 /*
183  * Network interface send tag support. The storage of "struct
184  * m_snd_tag" comes from the network driver and it is free to allocate
185  * as much additional space as it wants for its own use.
186  */
187 struct ktls_session;
188 struct m_snd_tag;
189 
190 #define	IF_SND_TAG_TYPE_RATE_LIMIT 0
191 #define	IF_SND_TAG_TYPE_UNLIMITED 1
192 #define	IF_SND_TAG_TYPE_TLS 2
193 #define	IF_SND_TAG_TYPE_TLS_RATE_LIMIT 3
194 #define	IF_SND_TAG_TYPE_TLS_RX 4
195 #define	IF_SND_TAG_TYPE_MAX 5
196 
197 struct if_snd_tag_alloc_header {
198 	uint32_t type;		/* send tag type, see IF_SND_TAG_XXX */
199 	uint32_t flowid;	/* mbuf hash value */
200 	uint32_t flowtype;	/* mbuf hash type */
201 	uint8_t numa_domain;	/* numa domain of associated inp */
202 };
203 
204 struct if_snd_tag_alloc_rate_limit {
205 	struct if_snd_tag_alloc_header hdr;
206 	uint64_t max_rate;	/* in bytes/s */
207 	uint32_t flags;		/* M_NOWAIT or M_WAITOK */
208 	uint32_t reserved;	/* alignment */
209 };
210 
211 struct if_snd_tag_alloc_tls {
212 	struct if_snd_tag_alloc_header hdr;
213 	struct inpcb *inp;
214 	const struct ktls_session *tls;
215 };
216 
217 struct if_snd_tag_alloc_tls_rx {
218 	struct if_snd_tag_alloc_header hdr;
219 	struct inpcb *inp;
220 	const struct ktls_session *tls;
221 	uint16_t vlan_id;	/* valid if non-zero */
222 };
223 
224 struct if_snd_tag_alloc_tls_rate_limit {
225 	struct if_snd_tag_alloc_header hdr;
226 	struct inpcb *inp;
227 	const struct ktls_session *tls;
228 	uint64_t max_rate;	/* in bytes/s */
229 };
230 
231 struct if_snd_tag_rate_limit_params {
232 	uint64_t max_rate;	/* in bytes/s */
233 	uint32_t queue_level;	/* 0 (empty) .. 65535 (full) */
234 #define	IF_SND_QUEUE_LEVEL_MIN 0
235 #define	IF_SND_QUEUE_LEVEL_MAX 65535
236 	uint32_t flags;		/* M_NOWAIT or M_WAITOK */
237 };
238 
239 struct if_snd_tag_modify_tls_rx {
240 	/* TCP sequence number of TLS header in host endian format */
241 	uint32_t tls_hdr_tcp_sn;
242 
243 	/*
244 	 * TLS record length, including all headers, data and trailers.
245 	 * If the tls_rec_length is zero, it means HW encryption resumed.
246 	 */
247 	uint32_t tls_rec_length;
248 
249 	/* TLS sequence number in host endian format */
250 	uint64_t tls_seq_number;
251 };
252 
253 union if_snd_tag_alloc_params {
254 	struct if_snd_tag_alloc_header hdr;
255 	struct if_snd_tag_alloc_rate_limit rate_limit;
256 	struct if_snd_tag_alloc_rate_limit unlimited;
257 	struct if_snd_tag_alloc_tls tls;
258 	struct if_snd_tag_alloc_tls_rx tls_rx;
259 	struct if_snd_tag_alloc_tls_rate_limit tls_rate_limit;
260 };
261 
262 union if_snd_tag_modify_params {
263 	struct if_snd_tag_rate_limit_params rate_limit;
264 	struct if_snd_tag_rate_limit_params unlimited;
265 	struct if_snd_tag_rate_limit_params tls_rate_limit;
266 	struct if_snd_tag_modify_tls_rx tls_rx;
267 };
268 
269 union if_snd_tag_query_params {
270 	struct if_snd_tag_rate_limit_params rate_limit;
271 	struct if_snd_tag_rate_limit_params unlimited;
272 	struct if_snd_tag_rate_limit_params tls_rate_limit;
273 };
274 
275 typedef int (if_snd_tag_alloc_t)(if_t, union if_snd_tag_alloc_params *,
276     struct m_snd_tag **);
277 typedef int (if_snd_tag_modify_t)(struct m_snd_tag *, union if_snd_tag_modify_params *);
278 typedef int (if_snd_tag_query_t)(struct m_snd_tag *, union if_snd_tag_query_params *);
279 typedef void (if_snd_tag_free_t)(struct m_snd_tag *);
280 typedef struct m_snd_tag *(if_next_send_tag_t)(struct m_snd_tag *);
281 
282 struct if_snd_tag_sw {
283 	if_snd_tag_modify_t *snd_tag_modify;
284 	if_snd_tag_query_t *snd_tag_query;
285 	if_snd_tag_free_t *snd_tag_free;
286 	if_next_send_tag_t *next_snd_tag;
287 	u_int	type;			/* One of IF_SND_TAG_TYPE_*. */
288 };
289 
290 /* Query return flags */
291 #define RT_NOSUPPORT	  0x00000000	/* Not supported */
292 #define RT_IS_INDIRECT    0x00000001	/*
293 					 * Interface like a lagg, select
294 					 * the actual interface for
295 					 * capabilities.
296 					 */
297 #define RT_IS_SELECTABLE  0x00000002	/*
298 					 * No rate table, you select
299 					 * rates and the first
300 					 * number_of_rates are created.
301 					 */
302 #define RT_IS_FIXED_TABLE 0x00000004	/* A fixed table is attached */
303 #define RT_IS_UNUSABLE	  0x00000008	/* It is not usable for this */
304 #define RT_IS_SETUP_REQ	  0x00000010	/* The interface setup must be called before use */
305 
306 struct if_ratelimit_query_results {
307 	const uint64_t *rate_table;	/* Pointer to table if present */
308 	uint32_t flags;			/* Flags indicating results */
309 	uint32_t max_flows;		/* Max flows using, 0=unlimited */
310 	uint32_t number_of_rates;	/* How many unique rates can be created */
311 	uint32_t min_segment_burst;	/* The amount the adapter bursts at each send */
312 };
313 
314 typedef void (if_ratelimit_query_t)(if_t,
315     struct if_ratelimit_query_results *);
316 typedef int (if_ratelimit_setup_t)(if_t, uint64_t, uint32_t);
317 #define	IF_NODOM	255
318 /*
319  * Locks for address lists on the network interface.
320  */
321 #define	IF_ADDR_LOCK_INIT(if)	mtx_init(&(if)->if_addr_lock, "if_addr_lock", NULL, MTX_DEF)
322 #define	IF_ADDR_LOCK_DESTROY(if)	mtx_destroy(&(if)->if_addr_lock)
323 
324 #define	IF_ADDR_WLOCK(if)	mtx_lock(&(if)->if_addr_lock)
325 #define	IF_ADDR_WUNLOCK(if)	mtx_unlock(&(if)->if_addr_lock)
326 #define	IF_ADDR_LOCK_ASSERT(if)	MPASS(in_epoch(net_epoch_preempt) || mtx_owned(&(if)->if_addr_lock))
327 #define	IF_ADDR_WLOCK_ASSERT(if) mtx_assert(&(if)->if_addr_lock, MA_OWNED)
328 
329 #ifdef _KERNEL
330 /* interface link layer address change event */
331 typedef void (*iflladdr_event_handler_t)(void *, if_t);
332 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
333 /* interface address change event */
334 typedef void (*ifaddr_event_handler_t)(void *, if_t);
335 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
336 typedef void (*ifaddr_event_ext_handler_t)(void *, if_t, struct ifaddr *, int);
337 EVENTHANDLER_DECLARE(ifaddr_event_ext, ifaddr_event_ext_handler_t);
338 #define	IFADDR_EVENT_ADD	0
339 #define	IFADDR_EVENT_DEL	1
340 /* new interface arrival event */
341 typedef void (*ifnet_arrival_event_handler_t)(void *, if_t);
342 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
343 /* interface departure event */
344 typedef void (*ifnet_departure_event_handler_t)(void *, if_t);
345 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
346 /* Interface link state change event */
347 typedef void (*ifnet_link_event_handler_t)(void *, if_t, int);
348 EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t);
349 /* Interface up/down event */
350 #define IFNET_EVENT_UP		0
351 #define IFNET_EVENT_DOWN	1
352 #define IFNET_EVENT_PCP		2	/* priority code point, PCP */
353 #define	IFNET_EVENT_UPDATE_BAUDRATE	3
354 
355 typedef void (*ifnet_event_fn)(void *, if_t ifp, int event);
356 EVENTHANDLER_DECLARE(ifnet_event, ifnet_event_fn);
357 
358 /*
359  * interface groups
360  */
361 struct ifg_group {
362 	char				 ifg_group[IFNAMSIZ];
363 	u_int				 ifg_refcnt;
364 	void				*ifg_pf_kif;
365 	CK_STAILQ_HEAD(, ifg_member)	 ifg_members; /* (CK_) */
366 	CK_STAILQ_ENTRY(ifg_group)		 ifg_next; /* (CK_) */
367 };
368 
369 struct ifg_member {
370 	CK_STAILQ_ENTRY(ifg_member)	 ifgm_next; /* (CK_) */
371 	if_t				 ifgm_ifp;
372 };
373 
374 struct ifg_list {
375 	struct ifg_group	*ifgl_group;
376 	CK_STAILQ_ENTRY(ifg_list)	 ifgl_next; /* (CK_) */
377 };
378 
379 #ifdef _SYS_EVENTHANDLER_H_
380 /* group attach event */
381 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
382 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
383 /* group detach event */
384 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
385 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
386 /* group change event */
387 typedef void (*group_change_event_handler_t)(void *, const char *);
388 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
389 #endif /* _SYS_EVENTHANDLER_H_ */
390 
391 /*
392  * 72 was chosen below because it is the size of a TCP/IP
393  * header (40) + the minimum mss (32).
394  */
395 #define	IF_MINMTU	72
396 #define	IF_MAXMTU	65535
397 
398 #define	TOEDEV(ifp)		if_getllsoftc(ifp)
399 #define	SETTOEDEV(ifp, sc)	if_setllsoftc((ifp), (sc))
400 
401 /*
402  * The ifaddr structure contains information about one address
403  * of an interface.  They are maintained by the different address families,
404  * are allocated and attached when an address is set, and are linked
405  * together so all addresses for an interface can be located.
406  *
407  * NOTE: a 'struct ifaddr' is always at the beginning of a larger
408  * chunk of malloc'ed memory, where we store the three addresses
409  * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
410  */
411 struct ifaddr {
412 	struct	sockaddr *ifa_addr;	/* address of interface */
413 	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
414 #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
415 	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
416 	if_t		 ifa_ifp;		/* back-pointer to interface */
417 	struct	carp_softc *ifa_carp;	/* pointer to CARP data */
418 	CK_STAILQ_ENTRY(ifaddr) ifa_link;	/* queue macro glue */
419 	u_short	ifa_flags;		/* mostly rt_flags for cloning */
420 #define	IFA_ROUTE	RTF_UP		/* route installed */
421 #define	IFA_RTSELF	RTF_HOST	/* loopback route to self installed */
422 	u_int	ifa_refcnt;		/* references to this structure */
423 
424 	counter_u64_t	ifa_ipackets;
425 	counter_u64_t	ifa_opackets;
426 	counter_u64_t	ifa_ibytes;
427 	counter_u64_t	ifa_obytes;
428 	struct	epoch_context	ifa_epoch_ctx;
429 };
430 
431 struct ifaddr *	ifa_alloc(size_t size, int flags);
432 void	ifa_free(struct ifaddr *ifa);
433 void	ifa_ref(struct ifaddr *ifa);
434 int __result_use_check ifa_try_ref(struct ifaddr *ifa);
435 
436 /*
437  * Multicast address structure.  This is analogous to the ifaddr
438  * structure except that it keeps track of multicast addresses.
439  */
440 #define IFMA_F_ENQUEUED		0x1
441 struct ifmultiaddr {
442 	CK_STAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
443 	struct	sockaddr *ifma_addr; 	/* address this membership is for */
444 	struct	sockaddr *ifma_lladdr;	/* link-layer translation, if any */
445 	if_t	ifma_ifp;		/* back-pointer to interface */
446 	u_int	ifma_refcount;		/* reference count */
447 	int	ifma_flags;
448 	void	*ifma_protospec;	/* protocol-specific state, if any */
449 	struct	ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
450 	struct	epoch_context	ifma_epoch_ctx;
451 };
452 
453 extern	struct sx ifnet_sxlock;
454 
455 #define	IFNET_WLOCK()		sx_xlock(&ifnet_sxlock)
456 #define	IFNET_WUNLOCK()		sx_xunlock(&ifnet_sxlock)
457 #define	IFNET_RLOCK_ASSERT()	sx_assert(&ifnet_sxlock, SA_SLOCKED)
458 #define	IFNET_WLOCK_ASSERT()	sx_assert(&ifnet_sxlock, SA_XLOCKED)
459 #define	IFNET_RLOCK()		sx_slock(&ifnet_sxlock)
460 #define	IFNET_RUNLOCK()		sx_sunlock(&ifnet_sxlock)
461 
462 /*
463  * Look up an ifnet given its index.  The returned value protected from
464  * being freed by the network epoch.  The _ref variant also acquires a
465  * reference that must be freed using if_rele().
466  */
467 if_t ifnet_byindex(u_int);
468 if_t ifnet_byindex_ref(u_int);
469 
470 /*
471  * ifnet_byindexgen() looks up ifnet by index and generation count,
472  * attempting to restore a weak pointer that had been stored across
473  * the epoch.
474  */
475 if_t ifnet_byindexgen(uint16_t idx, uint16_t gen);
476 
477 VNET_DECLARE(struct ifnethead, ifnet);
478 VNET_DECLARE(struct ifgrouphead, ifg_head);
479 VNET_DECLARE(if_t, loif);	/* first loopback interface */
480 
481 #define	V_ifnet		VNET(ifnet)
482 #define	V_ifg_head	VNET(ifg_head)
483 #define	V_loif		VNET(loif)
484 
485 #ifdef MCAST_VERBOSE
486 #define MCDPRINTF printf
487 #else
488 #define MCDPRINTF(...)
489 #endif
490 
491 int	if_addgroup(if_t, const char *);
492 int	if_delgroup(if_t, const char *);
493 int	if_addmulti(if_t, struct sockaddr *, struct ifmultiaddr **);
494 int	if_allmulti(if_t, int);
495 if_t	if_alloc(u_char);
496 if_t	if_alloc_dev(u_char, device_t dev);
497 void	if_attach(if_t);
498 void	if_dead(if_t);
499 int	if_delmulti(if_t, struct sockaddr *);
500 void	if_delmulti_ifma(struct ifmultiaddr *);
501 void	if_delmulti_ifma_flags(struct ifmultiaddr *, int flags);
502 void	if_detach(if_t);
503 void	if_purgeaddrs(if_t);
504 void	if_delallmulti(if_t);
505 void	if_down(if_t);
506 struct ifmultiaddr *
507 	if_findmulti(if_t, const struct sockaddr *);
508 void	if_freemulti(struct ifmultiaddr *ifma);
509 void	if_free(if_t);
510 void	if_initname(if_t, const char *, int);
511 void	if_link_state_change(if_t, int);
512 int	if_printf(if_t, const char *, ...) __printflike(2, 3);
513 int	if_log(if_t, int, const char *, ...) __printflike(3, 4);
514 void	if_ref(if_t);
515 void	if_rele(if_t);
516 bool	__result_use_check if_try_ref(if_t);
517 int	if_setlladdr(if_t, const u_char *, int);
518 int	if_tunnel_check_nesting(if_t, struct mbuf *, uint32_t, int);
519 void	if_up(if_t);
520 int	ifioctl(struct socket *, u_long, caddr_t, struct thread *);
521 int	ifpromisc(if_t, int);
522 if_t	ifunit(const char *);
523 if_t	ifunit_ref(const char *);
524 
525 int	ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
526 int	ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
527 int	ifa_switch_loopback_route(struct ifaddr *, struct sockaddr *);
528 
529 struct	ifaddr *ifa_ifwithaddr(const struct sockaddr *);
530 int		ifa_ifwithaddr_check(const struct sockaddr *);
531 struct	ifaddr *ifa_ifwithbroadaddr(const struct sockaddr *, int);
532 struct	ifaddr *ifa_ifwithdstaddr(const struct sockaddr *, int);
533 struct	ifaddr *ifa_ifwithnet(const struct sockaddr *, int, int);
534 struct	ifaddr *ifa_ifwithroute(int, const struct sockaddr *,
535     const struct sockaddr *, u_int);
536 struct	ifaddr *ifaof_ifpforaddr(const struct sockaddr *, if_t);
537 int	ifa_preferred(struct ifaddr *, struct ifaddr *);
538 
539 int	if_simloop(if_t ifp, struct mbuf *m, int af, int hlen);
540 
541 typedef	void *if_com_alloc_t(u_char type, if_t ifp);
542 typedef	void if_com_free_t(void *com, u_char type);
543 void	if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
544 void	if_deregister_com_alloc(u_char type);
545 void	if_data_copy(if_t, struct if_data *);
546 uint64_t if_get_counter_default(if_t, ift_counter);
547 void	if_inc_counter(if_t, ift_counter, int64_t);
548 
549 uint64_t if_setbaudrate(if_t ifp, uint64_t baudrate);
550 uint64_t if_getbaudrate(const if_t ifp);
551 int if_setcapabilities(if_t ifp, int capabilities);
552 int if_setcapabilitiesbit(if_t ifp, int setbit, int clearbit);
553 int if_getcapabilities(const if_t ifp);
554 int if_togglecapenable(if_t ifp, int togglecap);
555 int if_setcapenable(if_t ifp, int capenable);
556 int if_setcapenablebit(if_t ifp, int setcap, int clearcap);
557 int if_getcapenable(const if_t ifp);
558 int if_setcapabilities2(if_t ifp, int capabilities);
559 int if_setcapabilities2bit(if_t ifp, int setbit, int clearbit);
560 int if_getcapabilities2(const if_t ifp);
561 int if_togglecapenable2(if_t ifp, int togglecap);
562 int if_setcapenable2(if_t ifp, int capenable);
563 int if_setcapenable2bit(if_t ifp, int setcap, int clearcap);
564 int if_getcapenable2(const if_t ifp);
565 int if_getdunit(const if_t ifp);
566 int if_getindex(const if_t ifp);
567 int if_getidxgen(const if_t ifp);
568 const char *if_getdname(const if_t ifp);
569 void if_setdname(if_t ifp, const char *name);
570 const char *if_name(if_t ifp);
571 int if_setname(if_t ifp, const char *name);
572 int if_rename(if_t ifp, char *new_name);
573 const char *if_getdescr(if_t ifp);
574 void if_setdescr(if_t ifp, char *descrbuf);
575 char *if_allocdescr(size_t sz, int malloc_flag);
576 void if_freedescr(char *descrbuf);
577 void if_setlastchange(if_t ifp);
578 int if_getalloctype(const if_t ifp);
579 int if_gettype(const if_t ifp);
580 int if_setdev(if_t ifp, void *dev);
581 int if_setdrvflagbits(if_t ifp, int if_setflags, int clear_flags);
582 int if_getdrvflags(const if_t ifp);
583 int if_setdrvflags(if_t ifp, int flags);
584 int if_getlinkstate(if_t ifp);
585 int if_clearhwassist(if_t ifp);
586 int if_sethwassistbits(if_t ifp, int toset, int toclear);
587 int if_sethwassist(if_t ifp, int hwassist_bit);
588 int if_gethwassist(const if_t ifp);
589 int if_togglehwassist(if_t ifp, int toggle_bits);
590 int if_setsoftc(if_t ifp, void *softc);
591 void *if_getsoftc(if_t ifp);
592 int if_setflags(if_t ifp, int flags);
593 void if_setllsoftc(if_t ifp, void *softc);
594 void *if_getllsoftc(if_t ifp);
595 u_int if_getfib(if_t ifp);
596 uint8_t if_getaddrlen(if_t ifp);
597 int if_gethwaddr(const if_t ifp, struct ifreq *);
598 const uint8_t *if_getbroadcastaddr(const if_t ifp);
599 void if_setbroadcastaddr(if_t ifp, const uint8_t *);
600 int if_setmtu(if_t ifp, int mtu);
601 int if_getmtu(const if_t ifp);
602 int if_getmtu_family(const if_t ifp, int family);
603 void if_notifymtu(if_t ifp);
604 int if_setflagbits(if_t ifp, int set, int clear);
605 int if_setflags(if_t ifp, int flags);
606 int if_getflags(const if_t ifp);
607 int if_getnumadomain(if_t ifp);
608 int if_sendq_empty(if_t ifp);
609 int if_setsendqready(if_t ifp);
610 int if_setsendqlen(if_t ifp, int tx_desc_count);
611 int if_sethwtsomax(if_t ifp, u_int if_hw_tsomax);
612 int if_sethwtsomaxsegcount(if_t ifp, u_int if_hw_tsomaxsegcount);
613 int if_sethwtsomaxsegsize(if_t ifp, u_int if_hw_tsomaxsegsize);
614 u_int if_gethwtsomax(const if_t ifp);
615 u_int if_gethwtsomaxsegcount(const if_t ifp);
616 u_int if_gethwtsomaxsegsize(const if_t ifp);
617 void if_setnetmapadapter(if_t ifp, struct netmap_adapter *na);
618 struct netmap_adapter *if_getnetmapadapter(if_t ifp);
619 void if_input(if_t ifp, struct mbuf* sendmp);
620 int if_sendq_prepend(if_t ifp, struct mbuf *m);
621 struct mbuf *if_dequeue(if_t ifp);
622 int if_setifheaderlen(if_t ifp, int len);
623 void if_setrcvif(struct mbuf *m, if_t ifp);
624 void if_setvtag(struct mbuf *m, u_int16_t tag);
625 u_int16_t if_getvtag(struct mbuf *m);
626 int if_vlantrunkinuse(if_t ifp);
627 caddr_t if_getlladdr(const if_t ifp);
628 struct vnet *if_getvnet(const if_t ifp);
629 void *if_gethandle(u_char);
630 void if_vlancap(if_t ifp);
631 int if_transmit(if_t ifp, struct mbuf *m);
632 void if_init(if_t ifp, void *ctx);
633 int if_ioctl(if_t ifp, u_long cmd, void *data);
634 int if_resolvemulti(if_t ifp, struct sockaddr **, struct sockaddr *);
635 uint64_t if_getcounter(if_t ifp, ift_counter counter);
636 struct label *if_getmaclabel(if_t ifp);
637 void if_setmaclabel(if_t ifp, struct label *label);
638 struct bpf_if *if_getbpf(if_t ifp);
639 uint8_t if_getpcp(if_t ifp);
640 void *if_getl2com(if_t ifp);
641 struct ifvlantrunk *if_getvlantrunk(if_t ifp);
642 bool if_altq_is_enabled(if_t ifp);
643 
644 void *if_getafdata(if_t ifp, int);
645 
646 int if_snd_tag_alloc(if_t ifp, union if_snd_tag_alloc_params *params,
647     struct m_snd_tag **mstp);
648 /*
649  * Traversing through interface address lists.
650  */
651 struct sockaddr_dl;
652 typedef u_int iflladdr_cb_t(void *, struct sockaddr_dl *, u_int);
653 u_int if_foreach_lladdr(if_t, iflladdr_cb_t, void *);
654 u_int if_foreach_llmaddr(if_t, iflladdr_cb_t, void *);
655 u_int if_lladdr_count(if_t);
656 u_int if_llmaddr_count(if_t);
657 bool if_maddr_empty(if_t);
658 
659 int if_getamcount(const if_t ifp);
660 struct ifaddr * if_getifaddr(const if_t ifp);
661 typedef u_int if_addr_cb_t(void *, struct ifaddr *, u_int);
662 u_int if_foreach_addr_type(if_t ifp, int type, if_addr_cb_t cb, void *cb_arg);
663 
664 typedef int (*if_foreach_cb_t)(if_t, void *);
665 typedef bool (*if_foreach_match_t)(if_t, void *);
666 int	if_foreach(if_foreach_cb_t, void *);
667 int	if_foreach_sleep(if_foreach_match_t, void *, if_foreach_cb_t, void *);
668 
669 /* Opaque iterator structure for iterating over interfaces. */
670 struct if_iter {
671 	void *context[4];
672 };
673 
674 if_t	if_iter_start(struct if_iter *);
675 if_t	if_iter_next(struct if_iter *);
676 void	if_iter_finish(struct if_iter *);
677 
678 struct ifa_iter {
679 	void *context[4];
680 };
681 
682 struct ifaddr *ifa_iter_start(if_t ifp, struct ifa_iter *iter);
683 struct ifaddr *ifa_iter_next(struct ifa_iter *iter);
684 void ifa_iter_finish(struct ifa_iter *iter);
685 
686 /* Functions */
687 void if_setinitfn(if_t ifp, if_init_fn_t);
688 void if_setinputfn(if_t ifp, if_input_fn_t);
689 if_input_fn_t if_getinputfn(if_t ifp);
690 void if_setioctlfn(if_t ifp, if_ioctl_fn_t);
691 void if_setoutputfn(if_t ifp, if_output_fn_t);
692 void if_setstartfn(if_t ifp, if_start_fn_t);
693 if_start_fn_t if_getstartfn(if_t ifp);
694 void if_settransmitfn(if_t ifp, if_transmit_fn_t);
695 if_transmit_fn_t if_gettransmitfn(if_t ifp);
696 void if_setqflushfn(if_t ifp, if_qflush_fn_t);
697 void if_setgetcounterfn(if_t ifp, if_get_counter_t);
698 void if_setsndtagallocfn(if_t ifp, if_snd_tag_alloc_t);
699 void if_setdebugnet_methods(if_t, struct debugnet_methods *);
700 void if_setreassignfn(if_t ifp, if_reassign_fn_t);
701 void if_setratelimitqueryfn(if_t ifp, if_ratelimit_query_t);
702 
703 /* TSO */
704 void if_hw_tsomax_common(if_t ifp, struct ifnet_hw_tsomax *);
705 int if_hw_tsomax_update(if_t ifp, struct ifnet_hw_tsomax *);
706 
707 /* accessors for struct ifreq */
708 void *ifr_data_get_ptr(void *ifrp);
709 void *ifr_buffer_get_buffer(void *data);
710 size_t ifr_buffer_get_length(void *data);
711 
712 int ifhwioctl(u_long, if_t, caddr_t, struct thread *);
713 
714 #ifdef DEVICE_POLLING
715 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS };
716 
717 typedef	int poll_handler_t(if_t ifp, enum poll_cmd cmd, int count);
718 int    ether_poll_register(poll_handler_t *h, if_t ifp);
719 int    ether_poll_deregister(if_t ifp);
720 #endif /* DEVICE_POLLING */
721 
722 #endif /* _KERNEL */
723 
724 #include <net/if_private.h>	/* XXX: temporary until drivers converted. */
725 #include <net/ifq.h>	/* XXXAO: temporary unconditional include */
726 
727 #endif /* !_NET_IF_VAR_H_ */
728