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