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
60struct	rtentry;		/* ifa_rtrequest */
61struct	socket;
62struct	carp_if;
63struct	carp_softc;
64struct  ifvlantrunk;
65struct	route;			/* if_output */
66struct	vnet;
67struct	ifmedia;
68struct	netmap_adapter;
69struct	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
89CK_STAILQ_HEAD(ifnethead, ifnet);	/* we use TAILQs so that the order of */
90CK_STAILQ_HEAD(ifaddrhead, ifaddr);	/* instantiation is preserved in the list */
91CK_STAILQ_HEAD(ifmultihead, ifmultiaddr);
92CK_STAILQ_HEAD(ifgrouphead, ifg_group);
93
94#ifdef _KERNEL
95VNET_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
102VNET_DECLARE(struct hhook_head *, ipsec_hhh_in[HHOOK_IPSEC_COUNT]);
103VNET_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
108typedef 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
124typedef	void (*if_start_fn_t)(if_t);
125typedef	int (*if_ioctl_fn_t)(if_t, u_long, caddr_t);
126typedef	void (*if_init_fn_t)(void *);
127typedef	void (*if_input_fn_t)(if_t, struct mbuf *);
128typedef	int (*if_output_fn_t)(if_t, struct mbuf *, const struct sockaddr *,
129    struct route *);
130typedef void (*if_qflush_fn_t)(if_t);
131typedef int (*if_transmit_fn_t)(if_t, struct mbuf *);
132typedef	uint64_t (*if_get_counter_t)(if_t, ift_counter);
133typedef	void (*if_reassign_fn_t)(if_t, struct vnet *, char *);
134
135struct 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 */
142typedef 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
168struct 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 */
187struct ktls_session;
188struct 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
197struct 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
204struct 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
211struct 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
217struct 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
224struct 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
231struct 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
239struct 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
253union 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
262union 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
269union 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
275typedef int (if_snd_tag_alloc_t)(if_t, union if_snd_tag_alloc_params *,
276    struct m_snd_tag **);
277typedef int (if_snd_tag_modify_t)(struct m_snd_tag *, union if_snd_tag_modify_params *);
278typedef int (if_snd_tag_query_t)(struct m_snd_tag *, union if_snd_tag_query_params *);
279typedef void (if_snd_tag_free_t)(struct m_snd_tag *);
280typedef struct m_snd_tag *(if_next_send_tag_t)(struct m_snd_tag *);
281
282struct 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
306struct 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
314typedef void (if_ratelimit_query_t)(if_t,
315    struct if_ratelimit_query_results *);
316typedef 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 */
331typedef void (*iflladdr_event_handler_t)(void *, if_t);
332EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
333/* interface address change event */
334typedef void (*ifaddr_event_handler_t)(void *, if_t);
335EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
336typedef void (*ifaddr_event_ext_handler_t)(void *, if_t, struct ifaddr *, int);
337EVENTHANDLER_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 */
341typedef void (*ifnet_arrival_event_handler_t)(void *, if_t);
342EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
343/* interface departure event */
344typedef void (*ifnet_departure_event_handler_t)(void *, if_t);
345EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
346/* Interface link state change event */
347typedef void (*ifnet_link_event_handler_t)(void *, if_t, int);
348EVENTHANDLER_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
355typedef void (*ifnet_event_fn)(void *, if_t ifp, int event);
356EVENTHANDLER_DECLARE(ifnet_event, ifnet_event_fn);
357
358/*
359 * interface groups
360 */
361struct 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
369struct ifg_member {
370	CK_STAILQ_ENTRY(ifg_member)	 ifgm_next; /* (CK_) */
371	if_t				 ifgm_ifp;
372};
373
374struct 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 */
381typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
382EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
383/* group detach event */
384typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
385EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
386/* group change event */
387typedef void (*group_change_event_handler_t)(void *, const char *);
388EVENTHANDLER_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 */
411struct 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
431struct ifaddr *	ifa_alloc(size_t size, int flags);
432void	ifa_free(struct ifaddr *ifa);
433void	ifa_ref(struct ifaddr *ifa);
434int __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
441struct 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
453extern	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 */
467if_t ifnet_byindex(u_int);
468if_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 */
475if_t ifnet_byindexgen(uint16_t idx, uint16_t gen);
476
477VNET_DECLARE(struct ifnethead, ifnet);
478VNET_DECLARE(struct ifgrouphead, ifg_head);
479VNET_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
491int	if_addgroup(if_t, const char *);
492int	if_delgroup(if_t, const char *);
493int	if_addmulti(if_t, struct sockaddr *, struct ifmultiaddr **);
494int	if_allmulti(if_t, int);
495if_t	if_alloc(u_char);
496if_t	if_alloc_dev(u_char, device_t dev);
497void	if_attach(if_t);
498void	if_dead(if_t);
499int	if_delmulti(if_t, struct sockaddr *);
500void	if_delmulti_ifma(struct ifmultiaddr *);
501void	if_delmulti_ifma_flags(struct ifmultiaddr *, int flags);
502void	if_detach(if_t);
503void	if_purgeaddrs(if_t);
504void	if_delallmulti(if_t);
505void	if_down(if_t);
506struct ifmultiaddr *
507	if_findmulti(if_t, const struct sockaddr *);
508void	if_freemulti(struct ifmultiaddr *ifma);
509void	if_free(if_t);
510void	if_initname(if_t, const char *, int);
511void	if_link_state_change(if_t, int);
512int	if_printf(if_t, const char *, ...) __printflike(2, 3);
513int	if_log(if_t, int, const char *, ...) __printflike(3, 4);
514void	if_ref(if_t);
515void	if_rele(if_t);
516bool	__result_use_check if_try_ref(if_t);
517int	if_setlladdr(if_t, const u_char *, int);
518int	if_tunnel_check_nesting(if_t, struct mbuf *, uint32_t, int);
519void	if_up(if_t);
520int	ifioctl(struct socket *, u_long, caddr_t, struct thread *);
521int	ifpromisc(if_t, int);
522if_t	ifunit(const char *);
523if_t	ifunit_ref(const char *);
524
525int	ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
526int	ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
527int	ifa_switch_loopback_route(struct ifaddr *, struct sockaddr *);
528
529struct	ifaddr *ifa_ifwithaddr(const struct sockaddr *);
530int		ifa_ifwithaddr_check(const struct sockaddr *);
531struct	ifaddr *ifa_ifwithbroadaddr(const struct sockaddr *, int);
532struct	ifaddr *ifa_ifwithdstaddr(const struct sockaddr *, int);
533struct	ifaddr *ifa_ifwithnet(const struct sockaddr *, int, int);
534struct	ifaddr *ifa_ifwithroute(int, const struct sockaddr *,
535    const struct sockaddr *, u_int);
536struct	ifaddr *ifaof_ifpforaddr(const struct sockaddr *, if_t);
537int	ifa_preferred(struct ifaddr *, struct ifaddr *);
538
539int	if_simloop(if_t ifp, struct mbuf *m, int af, int hlen);
540
541typedef	void *if_com_alloc_t(u_char type, if_t ifp);
542typedef	void if_com_free_t(void *com, u_char type);
543void	if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
544void	if_deregister_com_alloc(u_char type);
545void	if_data_copy(if_t, struct if_data *);
546uint64_t if_get_counter_default(if_t, ift_counter);
547void	if_inc_counter(if_t, ift_counter, int64_t);
548
549uint64_t if_setbaudrate(if_t ifp, uint64_t baudrate);
550uint64_t if_getbaudrate(const if_t ifp);
551int if_setcapabilities(if_t ifp, int capabilities);
552int if_setcapabilitiesbit(if_t ifp, int setbit, int clearbit);
553int if_getcapabilities(const if_t ifp);
554int if_togglecapenable(if_t ifp, int togglecap);
555int if_setcapenable(if_t ifp, int capenable);
556int if_setcapenablebit(if_t ifp, int setcap, int clearcap);
557int if_getcapenable(const if_t ifp);
558int if_setcapabilities2(if_t ifp, int capabilities);
559int if_setcapabilities2bit(if_t ifp, int setbit, int clearbit);
560int if_getcapabilities2(const if_t ifp);
561int if_togglecapenable2(if_t ifp, int togglecap);
562int if_setcapenable2(if_t ifp, int capenable);
563int if_setcapenable2bit(if_t ifp, int setcap, int clearcap);
564int if_getcapenable2(const if_t ifp);
565int if_getdunit(const if_t ifp);
566int if_getindex(const if_t ifp);
567int if_getidxgen(const if_t ifp);
568const char *if_getdname(const if_t ifp);
569void if_setdname(if_t ifp, const char *name);
570const char *if_name(if_t ifp);
571int if_setname(if_t ifp, const char *name);
572int if_rename(if_t ifp, char *new_name);
573const char *if_getdescr(if_t ifp);
574void if_setdescr(if_t ifp, char *descrbuf);
575char *if_allocdescr(size_t sz, int malloc_flag);
576void if_freedescr(char *descrbuf);
577void if_setlastchange(if_t ifp);
578int if_getalloctype(const if_t ifp);
579int if_gettype(const if_t ifp);
580int if_setdev(if_t ifp, void *dev);
581int if_setdrvflagbits(if_t ifp, int if_setflags, int clear_flags);
582int if_getdrvflags(const if_t ifp);
583int if_setdrvflags(if_t ifp, int flags);
584int if_getlinkstate(if_t ifp);
585int if_clearhwassist(if_t ifp);
586int if_sethwassistbits(if_t ifp, int toset, int toclear);
587int if_sethwassist(if_t ifp, int hwassist_bit);
588int if_gethwassist(const if_t ifp);
589int if_togglehwassist(if_t ifp, int toggle_bits);
590int if_setsoftc(if_t ifp, void *softc);
591void *if_getsoftc(if_t ifp);
592int if_setflags(if_t ifp, int flags);
593void if_setllsoftc(if_t ifp, void *softc);
594void *if_getllsoftc(if_t ifp);
595u_int if_getfib(if_t ifp);
596uint8_t if_getaddrlen(if_t ifp);
597int if_gethwaddr(const if_t ifp, struct ifreq *);
598const uint8_t *if_getbroadcastaddr(const if_t ifp);
599void if_setbroadcastaddr(if_t ifp, const uint8_t *);
600int if_setmtu(if_t ifp, int mtu);
601int if_getmtu(const if_t ifp);
602int if_getmtu_family(const if_t ifp, int family);
603void if_notifymtu(if_t ifp);
604int if_setflagbits(if_t ifp, int set, int clear);
605int if_setflags(if_t ifp, int flags);
606int if_getflags(const if_t ifp);
607int if_getnumadomain(if_t ifp);
608int if_sendq_empty(if_t ifp);
609int if_setsendqready(if_t ifp);
610int if_setsendqlen(if_t ifp, int tx_desc_count);
611int if_sethwtsomax(if_t ifp, u_int if_hw_tsomax);
612int if_sethwtsomaxsegcount(if_t ifp, u_int if_hw_tsomaxsegcount);
613int if_sethwtsomaxsegsize(if_t ifp, u_int if_hw_tsomaxsegsize);
614u_int if_gethwtsomax(const if_t ifp);
615u_int if_gethwtsomaxsegcount(const if_t ifp);
616u_int if_gethwtsomaxsegsize(const if_t ifp);
617void if_setnetmapadapter(if_t ifp, struct netmap_adapter *na);
618struct netmap_adapter *if_getnetmapadapter(if_t ifp);
619void if_input(if_t ifp, struct mbuf* sendmp);
620int if_sendq_prepend(if_t ifp, struct mbuf *m);
621struct mbuf *if_dequeue(if_t ifp);
622int if_setifheaderlen(if_t ifp, int len);
623void if_setrcvif(struct mbuf *m, if_t ifp);
624void if_setvtag(struct mbuf *m, u_int16_t tag);
625u_int16_t if_getvtag(struct mbuf *m);
626int if_vlantrunkinuse(if_t ifp);
627caddr_t if_getlladdr(const if_t ifp);
628struct vnet *if_getvnet(const if_t ifp);
629void *if_gethandle(u_char);
630void if_vlancap(if_t ifp);
631int if_transmit(if_t ifp, struct mbuf *m);
632void if_init(if_t ifp, void *ctx);
633int if_ioctl(if_t ifp, u_long cmd, void *data);
634int if_resolvemulti(if_t ifp, struct sockaddr **, struct sockaddr *);
635uint64_t if_getcounter(if_t ifp, ift_counter counter);
636struct label *if_getmaclabel(if_t ifp);
637void if_setmaclabel(if_t ifp, struct label *label);
638struct bpf_if *if_getbpf(if_t ifp);
639uint8_t if_getpcp(if_t ifp);
640void *if_getl2com(if_t ifp);
641struct ifvlantrunk *if_getvlantrunk(if_t ifp);
642bool if_altq_is_enabled(if_t ifp);
643
644void *if_getafdata(if_t ifp, int);
645
646int 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 */
651struct sockaddr_dl;
652typedef u_int iflladdr_cb_t(void *, struct sockaddr_dl *, u_int);
653u_int if_foreach_lladdr(if_t, iflladdr_cb_t, void *);
654u_int if_foreach_llmaddr(if_t, iflladdr_cb_t, void *);
655u_int if_lladdr_count(if_t);
656u_int if_llmaddr_count(if_t);
657bool if_maddr_empty(if_t);
658
659int if_getamcount(const if_t ifp);
660struct ifaddr * if_getifaddr(const if_t ifp);
661typedef u_int if_addr_cb_t(void *, struct ifaddr *, u_int);
662u_int if_foreach_addr_type(if_t ifp, int type, if_addr_cb_t cb, void *cb_arg);
663
664typedef int (*if_foreach_cb_t)(if_t, void *);
665typedef bool (*if_foreach_match_t)(if_t, void *);
666int	if_foreach(if_foreach_cb_t, void *);
667int	if_foreach_sleep(if_foreach_match_t, void *, if_foreach_cb_t, void *);
668
669/* Opaque iterator structure for iterating over interfaces. */
670struct if_iter {
671	void *context[4];
672};
673
674if_t	if_iter_start(struct if_iter *);
675if_t	if_iter_next(struct if_iter *);
676void	if_iter_finish(struct if_iter *);
677
678struct ifa_iter {
679	void *context[4];
680};
681
682struct ifaddr *ifa_iter_start(if_t ifp, struct ifa_iter *iter);
683struct ifaddr *ifa_iter_next(struct ifa_iter *iter);
684void ifa_iter_finish(struct ifa_iter *iter);
685
686/* Functions */
687void if_setinitfn(if_t ifp, if_init_fn_t);
688void if_setinputfn(if_t ifp, if_input_fn_t);
689if_input_fn_t if_getinputfn(if_t ifp);
690void if_setioctlfn(if_t ifp, if_ioctl_fn_t);
691void if_setoutputfn(if_t ifp, if_output_fn_t);
692void if_setstartfn(if_t ifp, if_start_fn_t);
693if_start_fn_t if_getstartfn(if_t ifp);
694void if_settransmitfn(if_t ifp, if_transmit_fn_t);
695if_transmit_fn_t if_gettransmitfn(if_t ifp);
696void if_setqflushfn(if_t ifp, if_qflush_fn_t);
697void if_setgetcounterfn(if_t ifp, if_get_counter_t);
698void if_setsndtagallocfn(if_t ifp, if_snd_tag_alloc_t);
699void if_setdebugnet_methods(if_t, struct debugnet_methods *);
700void if_setreassignfn(if_t ifp, if_reassign_fn_t);
701void if_setratelimitqueryfn(if_t ifp, if_ratelimit_query_t);
702
703/* TSO */
704void if_hw_tsomax_common(if_t ifp, struct ifnet_hw_tsomax *);
705int if_hw_tsomax_update(if_t ifp, struct ifnet_hw_tsomax *);
706
707/* accessors for struct ifreq */
708void *ifr_data_get_ptr(void *ifrp);
709void *ifr_buffer_get_buffer(void *data);
710size_t ifr_buffer_get_length(void *data);
711
712int ifhwioctl(u_long, if_t, caddr_t, struct thread *);
713
714#ifdef DEVICE_POLLING
715enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS };
716
717typedef	int poll_handler_t(if_t ifp, enum poll_cmd cmd, int count);
718int    ether_poll_register(poll_handler_t *h, if_t ifp);
719int    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