xref: /netbsd-src/sys/net/if.h (revision 796c32c94f6e154afc9de0f63da35c91bb739b45)
1 /*	$NetBSD: if.h,v 1.244 2017/11/22 03:03:18 ozaki-r Exp $	*/
2 
3 /*-
4  * Copyright (c) 1999, 2000, 2001 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by William Studenmund and Jason R. Thorpe.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * Copyright (c) 1982, 1986, 1989, 1993
34  *	The Regents of the University of California.  All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  * 3. Neither the name of the University nor the names of its contributors
45  *    may be used to endorse or promote products derived from this software
46  *    without specific prior written permission.
47  *
48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58  * SUCH DAMAGE.
59  *
60  *	@(#)if.h	8.3 (Berkeley) 2/9/95
61  */
62 
63 #ifndef _NET_IF_H_
64 #define _NET_IF_H_
65 
66 #if !defined(_KERNEL) && !defined(_STANDALONE)
67 #include <stdbool.h>
68 #endif
69 
70 #include <sys/featuretest.h>
71 
72 /*
73  * Length of interface external name, including terminating '\0'.
74  * Note: this is the same size as a generic device's external name.
75  */
76 #define IF_NAMESIZE 16
77 
78 #if defined(_NETBSD_SOURCE)
79 
80 #include <sys/socket.h>
81 #include <sys/queue.h>
82 #include <sys/mutex.h>
83 
84 #include <net/dlt.h>
85 #include <net/pfil.h>
86 #ifdef _KERNEL
87 #include <net/pktqueue.h>
88 #include <sys/pslist.h>
89 #include <sys/pserialize.h>
90 #include <sys/psref.h>
91 #endif
92 
93 /*
94  * Always include ALTQ glue here -- we use the ALTQ interface queue
95  * structure even when ALTQ is not configured into the kernel so that
96  * the size of struct ifnet does not changed based on the option.  The
97  * ALTQ queue structure is API-compatible with the legacy ifqueue.
98  */
99 #include <altq/if_altq.h>
100 
101 /*
102  * Structures defining a network interface, providing a packet
103  * transport mechanism (ala level 0 of the PUP protocols).
104  *
105  * Each interface accepts output datagrams of a specified maximum
106  * length, and provides higher level routines with input datagrams
107  * received from its medium.
108  *
109  * Output occurs when the routine if_output is called, with four parameters:
110  *	(*ifp->if_output)(ifp, m, dst, rt)
111  * Here m is the mbuf chain to be sent and dst is the destination address.
112  * The output routine encapsulates the supplied datagram if necessary,
113  * and then transmits it on its medium.
114  *
115  * On input, each interface unwraps the data received by it, and either
116  * places it on the input queue of a internetwork datagram routine
117  * and posts the associated software interrupt, or passes the datagram to a raw
118  * packet input routine.
119  *
120  * Routines exist for locating interfaces by their addresses
121  * or for locating a interface on a certain network, as well as more general
122  * routing and gateway routines maintaining information used to locate
123  * interfaces.  These routines live in the files if.c and route.c
124  */
125 #include <sys/time.h>
126 
127 #if defined(_KERNEL_OPT)
128 #include "opt_compat_netbsd.h"
129 #include "opt_gateway.h"
130 #endif
131 
132 struct mbuf;
133 struct proc;
134 struct rtentry;
135 struct socket;
136 struct ether_header;
137 struct ifaddr;
138 struct ifnet;
139 struct rt_addrinfo;
140 
141 #define	IFNAMSIZ	IF_NAMESIZE
142 
143 /*
144  * Structure describing a `cloning' interface.
145  */
146 struct if_clone {
147 	LIST_ENTRY(if_clone) ifc_list;	/* on list of cloners */
148 	const char *ifc_name;		/* name of device, e.g. `gif' */
149 	size_t ifc_namelen;		/* length of name */
150 
151 	int	(*ifc_create)(struct if_clone *, int);
152 	int	(*ifc_destroy)(struct ifnet *);
153 };
154 
155 #define	IF_CLONE_INITIALIZER(name, create, destroy)			\
156 	{ { NULL, NULL }, name, sizeof(name) - 1, create, destroy }
157 
158 /*
159  * Structure used to query names of interface cloners.
160  */
161 struct if_clonereq {
162 	int	ifcr_total;		/* total cloners (out) */
163 	int	ifcr_count;		/* room for this many in user buffer */
164 	char	*ifcr_buffer;		/* buffer for cloner names */
165 };
166 
167 /*
168  * Structure defining statistics and other data kept regarding a network
169  * interface.
170  */
171 struct if_data {
172 	/* generic interface information */
173 	u_char	ifi_type;		/* ethernet, tokenring, etc. */
174 	u_char	ifi_addrlen;		/* media address length */
175 	u_char	ifi_hdrlen;		/* media header length */
176 	int	ifi_link_state;		/* current link state */
177 	uint64_t ifi_mtu;		/* maximum transmission unit */
178 	uint64_t ifi_metric;		/* routing metric (external only) */
179 	uint64_t ifi_baudrate;		/* linespeed */
180 	/* volatile statistics */
181 	uint64_t ifi_ipackets;		/* packets received on interface */
182 	uint64_t ifi_ierrors;		/* input errors on interface */
183 	uint64_t ifi_opackets;		/* packets sent on interface */
184 	uint64_t ifi_oerrors;		/* output errors on interface */
185 	uint64_t ifi_collisions;	/* collisions on csma interfaces */
186 	uint64_t ifi_ibytes;		/* total number of octets received */
187 	uint64_t ifi_obytes;		/* total number of octets sent */
188 	uint64_t ifi_imcasts;		/* packets received via multicast */
189 	uint64_t ifi_omcasts;		/* packets sent via multicast */
190 	uint64_t ifi_iqdrops;		/* dropped on input, this interface */
191 	uint64_t ifi_noproto;		/* destined for unsupported protocol */
192 	struct	timespec ifi_lastchange;/* last operational state change */
193 };
194 
195 /*
196  * Values for if_link_state.
197  */
198 #define	LINK_STATE_UNKNOWN	0	/* link invalid/unknown */
199 #define	LINK_STATE_DOWN		1	/* link is down */
200 #define	LINK_STATE_UP		2	/* link is up */
201 
202 /*
203  * Structure defining a queue for a network interface.
204  */
205 struct ifqueue {
206 	struct		mbuf *ifq_head;
207 	struct		mbuf *ifq_tail;
208 	int		ifq_len;
209 	int		ifq_maxlen;
210 	int		ifq_drops;
211 	kmutex_t	*ifq_lock;
212 };
213 
214 #ifdef _KERNEL
215 #include <sys/percpu.h>
216 #include <sys/callout.h>
217 #include <sys/rwlock.h>
218 
219 #endif /* _KERNEL */
220 
221 /*
222  * Structure defining a queue for a network interface.
223  *
224  * (Would like to call this struct ``if'', but C isn't PL/1.)
225  */
226 TAILQ_HEAD(ifnet_head, ifnet);		/* the actual queue head */
227 
228 struct bridge_softc;
229 struct bridge_iflist;
230 struct callout;
231 struct krwlock;
232 struct if_percpuq;
233 struct if_deferred_start;
234 struct in6_multi;
235 
236 typedef unsigned short if_index_t;
237 
238 typedef struct ifnet {
239 	void	*if_softc;		/* lower-level data for this if */
240 	/* DEPRECATED. Keep it to avoid breaking kvm(3) users */
241 	TAILQ_ENTRY(ifnet) if_list;	/* all struct ifnets are chained */
242 	TAILQ_HEAD(, ifaddr) if_addrlist; /* linked list of addresses per if */
243 	char	if_xname[IFNAMSIZ];	/* external name (name + unit) */
244 	int	if_pcount;		/* number of promiscuous listeners */
245 	struct bpf_if *if_bpf;		/* packet filter structure */
246 	if_index_t	if_index;	/* numeric abbreviation for this if */
247 	short	if_timer;		/* time 'til if_slowtimo called */
248 	unsigned short	if_flags;	/* up/down, broadcast, etc. */
249 	short	if_extflags;		/* if_output MP-safe, etc. */
250 	struct	if_data if_data;	/* statistics and other data about if */
251 	/*
252 	 * Procedure handles.  If you add more of these, don't forget the
253 	 * corresponding NULL stub in if.c.
254 	 */
255 	int	(*if_output)		/* output routine (enqueue) */
256 		    (struct ifnet *, struct mbuf *, const struct sockaddr *,
257 		     const struct rtentry *);
258 	void	(*_if_input)		/* input routine (from h/w driver) */
259 		    (struct ifnet *, struct mbuf *);
260 	void	(*if_start)		/* initiate output routine */
261 		    (struct ifnet *);
262 	int	(*if_transmit)		/* output routine, must be MP-safe */
263 		    (struct ifnet *, struct mbuf *);
264 	int	(*if_ioctl)		/* ioctl routine */
265 		    (struct ifnet *, u_long, void *);
266 	int	(*if_init)		/* init routine */
267 		    (struct ifnet *);
268 	void	(*if_stop)		/* stop routine */
269 		    (struct ifnet *, int);
270 	void	(*if_slowtimo)		/* timer routine */
271 		    (struct ifnet *);
272 #define	if_watchdog	if_slowtimo
273 	void	(*if_drain)		/* routine to release resources */
274 		    (struct ifnet *);
275 	struct ifaltq if_snd;		/* output queue (includes altq) */
276 	struct ifaddr	*if_dl;		/* identity of this interface. */
277 	const struct	sockaddr_dl *if_sadl;	/* pointer to sockaddr_dl
278 						 * of if_dl
279 						 */
280 	/* if_hwdl: h/w identity
281 	 *
282 	 * May be NULL.  If not NULL, it is the address assigned
283 	 * to the interface by the manufacturer, so it very likely
284 	 * to be unique.  It MUST NOT be deleted.  It is highly
285 	 * suitable for deriving the EUI64 for the interface.
286 	 */
287 	struct ifaddr	*if_hwdl;
288 	const uint8_t *if_broadcastaddr;/* linklevel broadcast bytestring */
289 	struct bridge_softc	*if_bridge;	/* bridge glue */
290 	struct bridge_iflist	*if_bridgeif;	/* shortcut to interface list entry */
291 	int	if_dlt;			/* data link type (<net/dlt.h>) */
292 	pfil_head_t *	if_pfil;	/* filtering point */
293 	uint64_t if_capabilities;	/* interface capabilities */
294 	uint64_t if_capenable;		/* capabilities enabled */
295 	union {
296 		void *		carp_s;	/* carp structure (used by !carp ifs) */
297 		struct ifnet	*carp_d;/* ptr to carpdev (used by carp ifs) */
298 	} if_carp_ptr;
299 #define if_carp		if_carp_ptr.carp_s
300 #define if_carpdev	if_carp_ptr.carp_d
301 	/*
302 	 * These are pre-computed based on an interfaces enabled
303 	 * capabilities, for speed elsewhere.
304 	 */
305 	int	if_csum_flags_tx;	/* M_CSUM_* flags for Tx */
306 	int	if_csum_flags_rx;	/* M_CSUM_* flags for Rx */
307 
308 	void	*if_afdata[AF_MAX];
309 	struct	mowner *if_mowner;	/* who owns mbufs for this interface */
310 
311 	void	*if_agrprivate;		/* used only when #if NAGR > 0 */
312 
313 	/*
314 	 * pf specific data, used only when #if NPF > 0.
315 	 */
316 	void	*if_pf_kif;		/* pf interface abstraction */
317 	void	*if_pf_groups;		/* pf interface groups */
318 	/*
319 	 * During an ifnet's lifetime, it has only one if_index, but
320 	 * and if_index is not sufficient to identify an ifnet
321 	 * because during the lifetime of the system, many ifnets may occupy a
322 	 * given if_index.  Let us tell different ifnets at the same
323 	 * if_index apart by their if_index_gen, a unique number that each ifnet
324 	 * is assigned when it if_attach()s.  Now, the kernel can use the
325 	 * pair (if_index, if_index_gen) as a weak reference to an ifnet.
326 	 */
327 	uint64_t if_index_gen;		/* generation number for the ifnet
328 					 * at if_index: if two ifnets' index
329 					 * and generation number are both the
330 					 * same, they are the same ifnet.
331 					 */
332 	struct sysctllog	*if_sysctl_log;
333 	int (*if_initaddr)(struct ifnet *, struct ifaddr *, bool);
334 	int (*if_mcastop)(struct ifnet *, const unsigned long,
335 	    const struct sockaddr *);
336 	int (*if_setflags)(struct ifnet *, const short);
337 	kmutex_t	*if_ioctl_lock;
338 #ifdef _KERNEL /* XXX kvm(3) */
339 	struct callout *if_slowtimo_ch;
340 	struct krwlock	*if_afdata_lock;
341 	struct if_percpuq	*if_percpuq; /* We should remove it in the future */
342 	void	*if_link_si;		/* softint to handle link state changes */
343 	uint16_t	if_link_queue;	/* masked link state change queue */
344 	struct pslist_entry	if_pslist_entry;
345 	struct psref_target     if_psref;
346 	struct pslist_head	if_addr_pslist;
347 	struct if_deferred_start	*if_deferred_start;
348 	/* XXX should be protocol independent */
349 	LIST_HEAD(, in6_multi) if_multiaddrs;
350 #endif
351 } ifnet_t;
352 
353 #define	if_mtu		if_data.ifi_mtu
354 #define	if_type		if_data.ifi_type
355 #define	if_addrlen	if_data.ifi_addrlen
356 #define	if_hdrlen	if_data.ifi_hdrlen
357 #define	if_metric	if_data.ifi_metric
358 #define	if_link_state	if_data.ifi_link_state
359 #define	if_baudrate	if_data.ifi_baudrate
360 #define	if_ipackets	if_data.ifi_ipackets
361 #define	if_ierrors	if_data.ifi_ierrors
362 #define	if_opackets	if_data.ifi_opackets
363 #define	if_oerrors	if_data.ifi_oerrors
364 #define	if_collisions	if_data.ifi_collisions
365 #define	if_ibytes	if_data.ifi_ibytes
366 #define	if_obytes	if_data.ifi_obytes
367 #define	if_imcasts	if_data.ifi_imcasts
368 #define	if_omcasts	if_data.ifi_omcasts
369 #define	if_iqdrops	if_data.ifi_iqdrops
370 #define	if_noproto	if_data.ifi_noproto
371 #define	if_lastchange	if_data.ifi_lastchange
372 
373 #define	IFF_UP		0x0001		/* interface is up */
374 #define	IFF_BROADCAST	0x0002		/* broadcast address valid */
375 #define	IFF_DEBUG	0x0004		/* turn on debugging */
376 #define	IFF_LOOPBACK	0x0008		/* is a loopback net */
377 #define	IFF_POINTOPOINT	0x0010		/* interface is point-to-point link */
378 #define	IFF_NOTRAILERS	0x0020		/* avoid use of trailers */
379 #define	IFF_RUNNING	0x0040		/* resources allocated */
380 #define	IFF_NOARP	0x0080		/* no address resolution protocol */
381 #define	IFF_PROMISC	0x0100		/* receive all packets */
382 #define	IFF_ALLMULTI	0x0200		/* receive all multicast packets */
383 #define	IFF_OACTIVE	0x0400		/* transmission in progress */
384 #define	IFF_SIMPLEX	0x0800		/* can't hear own transmissions */
385 #define	IFF_LINK0	0x1000		/* per link layer defined bit */
386 #define	IFF_LINK1	0x2000		/* per link layer defined bit */
387 #define	IFF_LINK2	0x4000		/* per link layer defined bit */
388 #define	IFF_MULTICAST	0x8000		/* supports multicast */
389 
390 #define	IFEF_MPSAFE			__BIT(0)	/* handlers can run in parallel (see below) */
391 #define	IFEF_NO_LINK_STATE_CHANGE	__BIT(1)	/* doesn't use link state interrupts */
392 
393 /*
394  * The following if_XXX() handlers don't take KERNEL_LOCK if the interface
395  * is set IFEF_MPSAFE:
396  *   - if_start
397  *   - if_output
398  *   - if_ioctl
399  */
400 
401 #ifdef _KERNEL
402 static inline bool
403 if_is_mpsafe(struct ifnet *ifp)
404 {
405 
406 	return ((ifp->if_extflags & IFEF_MPSAFE) != 0);
407 }
408 
409 static inline int
410 if_output_lock(struct ifnet *cifp, struct ifnet *ifp, struct mbuf *m,
411     const struct sockaddr *dst, const struct rtentry *rt)
412 {
413 
414 	if (if_is_mpsafe(cifp)) {
415 		return (*cifp->if_output)(ifp, m, dst, rt);
416 	} else {
417 		int ret;
418 
419 		KERNEL_LOCK(1, NULL);
420 		ret = (*cifp->if_output)(ifp, m, dst, rt);
421 		KERNEL_UNLOCK_ONE(NULL);
422 		return ret;
423 	}
424 }
425 
426 static inline void
427 if_start_lock(struct ifnet *ifp)
428 {
429 
430 	if (if_is_mpsafe(ifp)) {
431 		(*ifp->if_start)(ifp);
432 	} else {
433 		KERNEL_LOCK(1, NULL);
434 		(*ifp->if_start)(ifp);
435 		KERNEL_UNLOCK_ONE(NULL);
436 	}
437 }
438 
439 static inline bool
440 if_is_link_state_changeable(struct ifnet *ifp)
441 {
442 
443 	return ((ifp->if_extflags & IFEF_NO_LINK_STATE_CHANGE) == 0);
444 }
445 
446 #define KERNEL_LOCK_IF_IFP_MPSAFE(ifp)					\
447 	do { if (if_is_mpsafe(ifp)) { KERNEL_LOCK(1, NULL); } } while (0)
448 #define KERNEL_UNLOCK_IF_IFP_MPSAFE(ifp)				\
449 	do { if (if_is_mpsafe(ifp)) { KERNEL_UNLOCK_ONE(NULL); } } while (0)
450 
451 #define KERNEL_LOCK_UNLESS_IFP_MPSAFE(ifp)				\
452 	do { if (!if_is_mpsafe(ifp)) { KERNEL_LOCK(1, NULL); } } while (0)
453 #define KERNEL_UNLOCK_UNLESS_IFP_MPSAFE(ifp)				\
454 	do { if (!if_is_mpsafe(ifp)) { KERNEL_UNLOCK_ONE(NULL); } } while (0)
455 
456 #ifdef _KERNEL_OPT
457 #include "opt_net_mpsafe.h"
458 #endif
459 
460 /* XXX explore a better place to define */
461 #ifdef NET_MPSAFE
462 
463 #define KERNEL_LOCK_UNLESS_NET_MPSAFE()		do { } while (0)
464 #define KERNEL_UNLOCK_UNLESS_NET_MPSAFE()	do { } while (0)
465 
466 #define SOFTNET_LOCK_UNLESS_NET_MPSAFE()	do { } while (0)
467 #define SOFTNET_UNLOCK_UNLESS_NET_MPSAFE()	do { } while (0)
468 
469 #else /* NET_MPSAFE */
470 
471 #define KERNEL_LOCK_UNLESS_NET_MPSAFE()					\
472 	do { KERNEL_LOCK(1, NULL); } while (0)
473 #define KERNEL_UNLOCK_UNLESS_NET_MPSAFE()				\
474 	do { KERNEL_UNLOCK_ONE(NULL); } while (0)
475 
476 #define SOFTNET_LOCK_UNLESS_NET_MPSAFE()				\
477 	do { mutex_enter(softnet_lock); } while (0)
478 #define SOFTNET_UNLOCK_UNLESS_NET_MPSAFE()				\
479 	do { mutex_exit(softnet_lock); } while (0)
480 
481 #endif /* NET_MPSAFE */
482 
483 #define SOFTNET_KERNEL_LOCK_UNLESS_NET_MPSAFE()				\
484 	do {								\
485 		SOFTNET_LOCK_UNLESS_NET_MPSAFE();			\
486 		KERNEL_LOCK_UNLESS_NET_MPSAFE();			\
487 	} while (0)
488 
489 #define SOFTNET_KERNEL_UNLOCK_UNLESS_NET_MPSAFE()			\
490 	do {								\
491 		KERNEL_UNLOCK_UNLESS_NET_MPSAFE();			\
492 		SOFTNET_UNLOCK_UNLESS_NET_MPSAFE();			\
493 	} while (0)
494 
495 #endif /* _KERNEL */
496 
497 #define	IFFBITS \
498     "\020\1UP\2BROADCAST\3DEBUG\4LOOPBACK\5POINTOPOINT\6NOTRAILERS" \
499     "\7RUNNING\10NOARP\11PROMISC\12ALLMULTI\13OACTIVE\14SIMPLEX" \
500     "\15LINK0\16LINK1\17LINK2\20MULTICAST"
501 
502 /* flags set internally only: */
503 #define	IFF_CANTCHANGE \
504 	(IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
505 	    IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC)
506 
507 /*
508  * Some convenience macros used for setting ifi_baudrate.
509  */
510 #define	IF_Kbps(x)	((x) * 1000ULL)			/* kilobits/sec. */
511 #define	IF_Mbps(x)	(IF_Kbps((x) * 1000ULL))	/* megabits/sec. */
512 #define	IF_Gbps(x)	(IF_Mbps((x) * 1000ULL))	/* gigabits/sec. */
513 
514 /* Capabilities that interfaces can advertise. */
515 					/* 0x01 .. 0x40 were previously used */
516 #define	IFCAP_TSOv4		0x00080	/* can do TCPv4 segmentation offload */
517 #define	IFCAP_CSUM_IPv4_Rx	0x00100	/* can do IPv4 header checksums (Rx) */
518 #define	IFCAP_CSUM_IPv4_Tx	0x00200	/* can do IPv4 header checksums (Tx) */
519 #define	IFCAP_CSUM_TCPv4_Rx	0x00400	/* can do IPv4/TCP checksums (Rx) */
520 #define	IFCAP_CSUM_TCPv4_Tx	0x00800	/* can do IPv4/TCP checksums (Tx) */
521 #define	IFCAP_CSUM_UDPv4_Rx	0x01000	/* can do IPv4/UDP checksums (Rx) */
522 #define	IFCAP_CSUM_UDPv4_Tx	0x02000	/* can do IPv4/UDP checksums (Tx) */
523 #define	IFCAP_CSUM_TCPv6_Rx	0x04000	/* can do IPv6/TCP checksums (Rx) */
524 #define	IFCAP_CSUM_TCPv6_Tx	0x08000	/* can do IPv6/TCP checksums (Tx) */
525 #define	IFCAP_CSUM_UDPv6_Rx	0x10000	/* can do IPv6/UDP checksums (Rx) */
526 #define	IFCAP_CSUM_UDPv6_Tx	0x20000	/* can do IPv6/UDP checksums (Tx) */
527 #define	IFCAP_TSOv6		0x40000	/* can do TCPv6 segmentation offload */
528 #define	IFCAP_LRO		0x80000	/* can do Large Receive Offload */
529 #define	IFCAP_MASK		0xfff80 /* currently valid capabilities */
530 
531 #define	IFCAPBITS		\
532 	"\020"			\
533 	"\10TSO4"		\
534 	"\11IP4CSUM_Rx"		\
535 	"\12IP4CSUM_Tx"		\
536 	"\13TCP4CSUM_Rx"	\
537 	"\14TCP4CSUM_Tx"	\
538 	"\15UDP4CSUM_Rx"	\
539 	"\16UDP4CSUM_Tx"	\
540 	"\17TCP6CSUM_Rx"	\
541 	"\20TCP6CSUM_Tx"	\
542 	"\21UDP6CSUM_Rx"	\
543 	"\22UDP6CSUM_Tx"	\
544 	"\23TSO6"		\
545 	"\24LRO"		\
546 
547 #define	IF_AFDATA_LOCK_INIT(ifp)	\
548 	do {(ifp)->if_afdata_lock = rw_obj_alloc();} while (0)
549 
550 #define	IF_AFDATA_LOCK_DESTROY(ifp)	rw_obj_free((ifp)->if_afdata_lock)
551 
552 #define	IF_AFDATA_WLOCK(ifp)	rw_enter((ifp)->if_afdata_lock, RW_WRITER)
553 #define	IF_AFDATA_RLOCK(ifp)	rw_enter((ifp)->if_afdata_lock, RW_READER)
554 #define	IF_AFDATA_WUNLOCK(ifp)	rw_exit((ifp)->if_afdata_lock)
555 #define	IF_AFDATA_RUNLOCK(ifp)	rw_exit((ifp)->if_afdata_lock)
556 #define	IF_AFDATA_LOCK(ifp)	IF_AFDATA_WLOCK(ifp)
557 #define	IF_AFDATA_UNLOCK(ifp)	IF_AFDATA_WUNLOCK(ifp)
558 #define	IF_AFDATA_TRYLOCK(ifp)	rw_tryenter((ifp)->if_afdata_lock, RW_WRITER)
559 
560 #define	IF_AFDATA_LOCK_ASSERT(ifp)	\
561 	KASSERT(rw_lock_held((ifp)->if_afdata_lock))
562 #define	IF_AFDATA_RLOCK_ASSERT(ifp)	\
563 	KASSERT(rw_read_held((ifp)->if_afdata_lock))
564 #define	IF_AFDATA_WLOCK_ASSERT(ifp)	\
565 	KASSERT(rw_write_held((ifp)->if_afdata_lock))
566 
567 /*
568  * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
569  * input routines have queues of messages stored on ifqueue structures
570  * (defined above).  Entries are added to and deleted from these structures
571  * by these macros, which should be called with ipl raised to splnet().
572  */
573 #define	IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
574 #define	IF_DROP(ifq)		((ifq)->ifq_drops++)
575 #define	IF_ENQUEUE(ifq, m) do { \
576 	(m)->m_nextpkt = 0; \
577 	if ((ifq)->ifq_tail == 0) \
578 		(ifq)->ifq_head = m; \
579 	else \
580 		(ifq)->ifq_tail->m_nextpkt = m; \
581 	(ifq)->ifq_tail = m; \
582 	(ifq)->ifq_len++; \
583 } while (/*CONSTCOND*/0)
584 #define	IF_PREPEND(ifq, m) do { \
585 	(m)->m_nextpkt = (ifq)->ifq_head; \
586 	if ((ifq)->ifq_tail == 0) \
587 		(ifq)->ifq_tail = (m); \
588 	(ifq)->ifq_head = (m); \
589 	(ifq)->ifq_len++; \
590 } while (/*CONSTCOND*/0)
591 #define	IF_DEQUEUE(ifq, m) do { \
592 	(m) = (ifq)->ifq_head; \
593 	if (m) { \
594 		if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
595 			(ifq)->ifq_tail = 0; \
596 		(m)->m_nextpkt = 0; \
597 		(ifq)->ifq_len--; \
598 	} \
599 } while (/*CONSTCOND*/0)
600 #define	IF_POLL(ifq, m)		((m) = (ifq)->ifq_head)
601 #define	IF_PURGE(ifq)							\
602 do {									\
603 	struct mbuf *__m0;						\
604 									\
605 	for (;;) {							\
606 		IF_DEQUEUE((ifq), __m0);				\
607 		if (__m0 == NULL)					\
608 			break;						\
609 		else							\
610 			m_freem(__m0);					\
611 	}								\
612 } while (/*CONSTCOND*/ 0)
613 #define	IF_IS_EMPTY(ifq)	((ifq)->ifq_len == 0)
614 
615 #ifndef IFQ_MAXLEN
616 #define	IFQ_MAXLEN	256
617 #endif
618 #define	IFNET_SLOWHZ	1		/* granularity is 1 second */
619 
620 /*
621  * Structure defining statistics and other data kept regarding an address
622  * on a network interface.
623  */
624 struct ifaddr_data {
625 	int64_t	ifad_inbytes;
626 	int64_t	ifad_outbytes;
627 };
628 
629 /*
630  * The ifaddr structure contains information about one address
631  * of an interface.  They are maintained by the different address families,
632  * are allocated and attached when an address is set, and are linked
633  * together so all addresses for an interface can be located.
634  */
635 struct ifaddr {
636 	struct	sockaddr *ifa_addr;	/* address of interface */
637 	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
638 #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
639 	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
640 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
641 	TAILQ_ENTRY(ifaddr) ifa_list;	/* list of addresses for interface */
642 	struct	ifaddr_data	ifa_data;	/* statistics on the address */
643 	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
644 		        (int, struct rtentry *, const struct rt_addrinfo *);
645 	u_int	ifa_flags;		/* mostly rt_flags for cloning */
646 	int	ifa_refcnt;		/* count of references */
647 	int	ifa_metric;		/* cost of going out this interface */
648 	struct ifaddr	*(*ifa_getifa)(struct ifaddr *,
649 			               const struct sockaddr *);
650 	uint32_t	*ifa_seqno;
651 	int16_t	ifa_preference;	/* preference level for this address */
652 #ifdef _KERNEL
653 	struct pslist_entry     ifa_pslist_entry;
654 	struct psref_target	ifa_psref;
655 #endif
656 };
657 #define	IFA_ROUTE	RTF_UP	/* (0x01) route installed */
658 #define	IFA_DESTROYING	0x2
659 
660 /*
661  * Message format for use in obtaining information about interfaces from
662  * sysctl and the routing socket.  We need to force 64-bit alignment if we
663  * aren't using compatiblity definitons.
664  */
665 #if !defined(_KERNEL) || !defined(COMPAT_RTSOCK)
666 #define	__align64	__aligned(sizeof(uint64_t))
667 #else
668 #define	__align64
669 #endif
670 struct if_msghdr {
671 	u_short	ifm_msglen __align64;
672 				/* to skip over non-understood messages */
673 	u_char	ifm_version;	/* future binary compatibility */
674 	u_char	ifm_type;	/* message type */
675 	int	ifm_addrs;	/* like rtm_addrs */
676 	int	ifm_flags;	/* value of if_flags */
677 	u_short	ifm_index;	/* index for associated ifp */
678 	struct	if_data ifm_data __align64;
679 				/* statistics and other data about if */
680 };
681 
682 /*
683  * Message format for use in obtaining information about interface addresses
684  * from sysctl and the routing socket.
685  */
686 struct ifa_msghdr {
687 	u_short	ifam_msglen __align64;
688 				/* to skip over non-understood messages */
689 	u_char	ifam_version;	/* future binary compatibility */
690 	u_char	ifam_type;	/* message type */
691 	u_short	ifam_index;	/* index for associated ifp */
692 	int	ifam_flags;	/* value of ifa_flags */
693 	int	ifam_addrs;	/* like rtm_addrs */
694 	pid_t	ifam_pid;	/* identify sender */
695 	int	ifam_addrflags;	/* family specific address flags */
696 	int	ifam_metric;	/* value of ifa_metric */
697 };
698 
699 /*
700  * Message format announcing the arrival or departure of a network interface.
701  */
702 struct if_announcemsghdr {
703 	u_short	ifan_msglen __align64;
704 				/* to skip over non-understood messages */
705 	u_char	ifan_version;	/* future binary compatibility */
706 	u_char	ifan_type;	/* message type */
707 	u_short	ifan_index;	/* index for associated ifp */
708 	char	ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
709 	u_short	ifan_what;	/* what type of announcement */
710 };
711 
712 #define	IFAN_ARRIVAL	0	/* interface arrival */
713 #define	IFAN_DEPARTURE	1	/* interface departure */
714 
715 #undef __align64
716 
717 /*
718  * Interface request structure used for socket
719  * ioctl's.  All interface ioctl's must have parameter
720  * definitions which begin with ifr_name.  The
721  * remainder may be interface specific.
722  */
723 struct	ifreq {
724 	char	ifr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
725 	union {
726 		struct	sockaddr ifru_addr;
727 		struct	sockaddr ifru_dstaddr;
728 		struct	sockaddr ifru_broadaddr;
729 		struct	sockaddr_storage ifru_space;
730 		short	ifru_flags;
731 		int	ifru_addrflags;
732 		int	ifru_metric;
733 		int	ifru_mtu;
734 		int	ifru_dlt;
735 		u_int	ifru_value;
736 		void *	ifru_data;
737 		struct {
738 			uint32_t	b_buflen;
739 			void		*b_buf;
740 		} ifru_b;
741 	} ifr_ifru;
742 #define	ifr_addr	ifr_ifru.ifru_addr	/* address */
743 #define	ifr_dstaddr	ifr_ifru.ifru_dstaddr	/* other end of p-to-p link */
744 #define	ifr_broadaddr	ifr_ifru.ifru_broadaddr	/* broadcast address */
745 #define	ifr_space	ifr_ifru.ifru_space	/* sockaddr_storage */
746 #define	ifr_flags	ifr_ifru.ifru_flags	/* flags */
747 #define	ifr_addrflags	ifr_ifru.ifru_addrflags	/* addr flags */
748 #define	ifr_metric	ifr_ifru.ifru_metric	/* metric */
749 #define	ifr_mtu		ifr_ifru.ifru_mtu	/* mtu */
750 #define	ifr_dlt		ifr_ifru.ifru_dlt	/* data link type (DLT_*) */
751 #define	ifr_value	ifr_ifru.ifru_value	/* generic value */
752 #define	ifr_media	ifr_ifru.ifru_metric	/* media options (overload) */
753 #define	ifr_data	ifr_ifru.ifru_data	/* for use by interface
754 						 * XXX deprecated
755 						 */
756 #define	ifr_buf		ifr_ifru.ifru_b.b_buf	/* new interface ioctls */
757 #define	ifr_buflen	ifr_ifru.ifru_b.b_buflen
758 #define	ifr_index	ifr_ifru.ifru_value	/* interface index, BSD */
759 #define	ifr_ifindex	ifr_index		/* interface index, linux */
760 };
761 
762 #ifdef _KERNEL
763 #define	ifreq_setdstaddr	ifreq_setaddr
764 #define	ifreq_setbroadaddr	ifreq_setaddr
765 #define	ifreq_getdstaddr	ifreq_getaddr
766 #define	ifreq_getbroadaddr	ifreq_getaddr
767 
768 static inline const struct sockaddr *
769 /*ARGSUSED*/
770 ifreq_getaddr(u_long cmd, const struct ifreq *ifr)
771 {
772 	return &ifr->ifr_addr;
773 }
774 #endif /* _KERNEL */
775 
776 struct ifcapreq {
777 	char		ifcr_name[IFNAMSIZ];	/* if name, e.g. "en0" */
778 	uint64_t	ifcr_capabilities;	/* supported capabiliites */
779 	uint64_t	ifcr_capenable;		/* capabilities enabled */
780 };
781 
782 struct ifaliasreq {
783 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
784 	struct	sockaddr ifra_addr;
785 	struct	sockaddr ifra_dstaddr;
786 #define	ifra_broadaddr	ifra_dstaddr
787 	struct	sockaddr ifra_mask;
788 };
789 
790 struct ifdatareq {
791 	char	ifdr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
792 	struct	if_data ifdr_data;
793 };
794 
795 struct ifmediareq {
796 	char	ifm_name[IFNAMSIZ];		/* if name, e.g. "en0" */
797 	int	ifm_current;			/* current media options */
798 	int	ifm_mask;			/* don't care mask */
799 	int	ifm_status;			/* media status */
800 	int	ifm_active;			/* active options */
801 	int	ifm_count;			/* # entries in ifm_ulist
802 						   array */
803 	int	*ifm_ulist;			/* media words */
804 };
805 
806 
807 struct  ifdrv {
808 	char		ifd_name[IFNAMSIZ];	/* if name, e.g. "en0" */
809 	unsigned long	ifd_cmd;
810 	size_t		ifd_len;
811 	void		*ifd_data;
812 };
813 #define IFLINKSTR_QUERYLEN	0x01
814 #define IFLINKSTR_UNSET		0x02
815 
816 /*
817  * Structure used in SIOCGIFCONF request.
818  * Used to retrieve interface configuration
819  * for machine (useful for programs which
820  * must know all networks accessible).
821  */
822 struct	ifconf {
823 	int	ifc_len;		/* size of associated buffer */
824 	union {
825 		void *	ifcu_buf;
826 		struct	ifreq *ifcu_req;
827 	} ifc_ifcu;
828 #define	ifc_buf	ifc_ifcu.ifcu_buf	/* buffer address */
829 #define	ifc_req	ifc_ifcu.ifcu_req	/* array of structures returned */
830 };
831 
832 /*
833  * Structure for SIOC[AGD]LIFADDR
834  */
835 struct if_laddrreq {
836 	char iflr_name[IFNAMSIZ];
837 	unsigned int flags;
838 #define IFLR_PREFIX	0x8000	/* in: prefix given  out: kernel fills id */
839 #define IFLR_ACTIVE	0x4000	/* in/out: link-layer address activation */
840 #define IFLR_FACTORY	0x2000	/* in/out: factory link-layer address */
841 	unsigned int prefixlen;		/* in/out */
842 	struct sockaddr_storage addr;	/* in/out */
843 	struct sockaddr_storage dstaddr; /* out */
844 };
845 
846 /*
847  * Structure for SIOC[SG]IFADDRPREF
848  */
849 struct if_addrprefreq {
850 	char			ifap_name[IFNAMSIZ];
851 	int16_t			ifap_preference;	/* in/out */
852 	struct sockaddr_storage	ifap_addr;		/* in/out */
853 };
854 
855 #include <net/if_arp.h>
856 
857 #endif /* _NETBSD_SOURCE */
858 
859 #ifdef _KERNEL
860 #ifdef ALTQ
861 #define IFQ_ENQUEUE(ifq, m, err)					\
862 do {									\
863 	mutex_enter((ifq)->ifq_lock);					\
864 	if (ALTQ_IS_ENABLED((ifq)))					\
865 		ALTQ_ENQUEUE((ifq), (m), (err));			\
866 	else {								\
867 		if (IF_QFULL((ifq))) {					\
868 			m_freem((m));					\
869 			(err) = ENOBUFS;				\
870 		} else {						\
871 			IF_ENQUEUE((ifq), (m));				\
872 			(err) = 0;					\
873 		}							\
874 	}								\
875 	if ((err))							\
876 		(ifq)->ifq_drops++;					\
877 	mutex_exit((ifq)->ifq_lock);					\
878 } while (/*CONSTCOND*/ 0)
879 
880 #define IFQ_DEQUEUE(ifq, m)						\
881 do {									\
882 	mutex_enter((ifq)->ifq_lock);					\
883 	if (TBR_IS_ENABLED((ifq)))					\
884 		(m) = tbr_dequeue((ifq), ALTDQ_REMOVE);			\
885 	else if (ALTQ_IS_ENABLED((ifq)))				\
886 		ALTQ_DEQUEUE((ifq), (m));				\
887 	else								\
888 		IF_DEQUEUE((ifq), (m));					\
889 	mutex_exit((ifq)->ifq_lock);					\
890 } while (/*CONSTCOND*/ 0)
891 
892 #define	IFQ_POLL(ifq, m)						\
893 do {									\
894 	mutex_enter((ifq)->ifq_lock);					\
895 	if (TBR_IS_ENABLED((ifq)))					\
896 		(m) = tbr_dequeue((ifq), ALTDQ_POLL);			\
897 	else if (ALTQ_IS_ENABLED((ifq)))				\
898 		ALTQ_POLL((ifq), (m));					\
899 	else								\
900 		IF_POLL((ifq), (m));					\
901 	mutex_exit((ifq)->ifq_lock);					\
902 } while (/*CONSTCOND*/ 0)
903 
904 #define	IFQ_PURGE(ifq)							\
905 do {									\
906 	mutex_enter((ifq)->ifq_lock);					\
907 	if (ALTQ_IS_ENABLED((ifq)))					\
908 		ALTQ_PURGE((ifq));					\
909 	else								\
910 		IF_PURGE((ifq));					\
911 	mutex_exit((ifq)->ifq_lock);					\
912 } while (/*CONSTCOND*/ 0)
913 
914 #define	IFQ_SET_READY(ifq)						\
915 do {									\
916 	(ifq)->altq_flags |= ALTQF_READY;				\
917 } while (/*CONSTCOND*/ 0)
918 
919 #define	IFQ_CLASSIFY(ifq, m, af)					\
920 do {									\
921 	mutex_enter((ifq)->ifq_lock);					\
922 	if (ALTQ_IS_ENABLED((ifq))) {					\
923 		if (ALTQ_NEEDS_CLASSIFY((ifq)))				\
924 			m->m_pkthdr.pattr_class = (*(ifq)->altq_classify) \
925 				((ifq)->altq_clfier, (m), (af));	\
926 		m->m_pkthdr.pattr_af = (af);				\
927 		m->m_pkthdr.pattr_hdr = mtod((m), void *);		\
928 	}								\
929 	mutex_exit((ifq)->ifq_lock);					\
930 } while (/*CONSTCOND*/ 0)
931 #else /* ! ALTQ */
932 #define	IFQ_ENQUEUE(ifq, m, err)					\
933 do {									\
934 	mutex_enter((ifq)->ifq_lock);					\
935 	if (IF_QFULL((ifq))) {						\
936 		m_freem((m));						\
937 		(err) = ENOBUFS;					\
938 	} else {							\
939 		IF_ENQUEUE((ifq), (m));					\
940 		(err) = 0;						\
941 	}								\
942 	if ((err))							\
943 		(ifq)->ifq_drops++;					\
944 	mutex_exit((ifq)->ifq_lock);					\
945 } while (/*CONSTCOND*/ 0)
946 
947 #define	IFQ_DEQUEUE(ifq, m)						\
948 do {									\
949 	mutex_enter((ifq)->ifq_lock);					\
950 	IF_DEQUEUE((ifq), (m));						\
951 	mutex_exit((ifq)->ifq_lock);					\
952 } while (/*CONSTCOND*/ 0)
953 
954 #define	IFQ_POLL(ifq, m)						\
955 do {									\
956 	mutex_enter((ifq)->ifq_lock);					\
957 	IF_POLL((ifq), (m));						\
958 	mutex_exit((ifq)->ifq_lock);					\
959 } while (/*CONSTCOND*/ 0)
960 
961 #define	IFQ_PURGE(ifq)							\
962 do {									\
963 	mutex_enter((ifq)->ifq_lock);					\
964 	IF_PURGE((ifq));						\
965 	mutex_exit((ifq)->ifq_lock);					\
966 } while (/*CONSTCOND*/ 0)
967 
968 #define	IFQ_SET_READY(ifq)	/* nothing */
969 
970 #define	IFQ_CLASSIFY(ifq, m, af) /* nothing */
971 
972 #endif /* ALTQ */
973 
974 #define IFQ_LOCK_INIT(ifq)	(ifq)->ifq_lock =			\
975 	    mutex_obj_alloc(MUTEX_DEFAULT, IPL_NET)
976 #define IFQ_LOCK_DESTROY(ifq)	mutex_obj_free((ifq)->ifq_lock)
977 #define IFQ_LOCK(ifq)		mutex_enter((ifq)->ifq_lock)
978 #define IFQ_UNLOCK(ifq)		mutex_exit((ifq)->ifq_lock)
979 
980 #define	IFQ_IS_EMPTY(ifq)		IF_IS_EMPTY((ifq))
981 #define	IFQ_INC_LEN(ifq)		((ifq)->ifq_len++)
982 #define	IFQ_DEC_LEN(ifq)		(--(ifq)->ifq_len)
983 #define	IFQ_INC_DROPS(ifq)		((ifq)->ifq_drops++)
984 #define	IFQ_SET_MAXLEN(ifq, len)	((ifq)->ifq_maxlen = (len))
985 
986 #include <sys/mallocvar.h>
987 MALLOC_DECLARE(M_IFADDR);
988 MALLOC_DECLARE(M_IFMADDR);
989 
990 int ifreq_setaddr(u_long, struct ifreq *, const struct sockaddr *);
991 
992 struct ifnet *if_alloc(u_char);
993 void if_free(struct ifnet *);
994 void if_initname(struct ifnet *, const char *, int);
995 struct ifaddr *if_dl_create(const struct ifnet *, const struct sockaddr_dl **);
996 void if_activate_sadl(struct ifnet *, struct ifaddr *,
997     const struct sockaddr_dl *);
998 void	if_set_sadl(struct ifnet *, const void *, u_char, bool);
999 void	if_alloc_sadl(struct ifnet *);
1000 int	if_initialize(struct ifnet *);
1001 void	if_register(struct ifnet *);
1002 int	if_attach(struct ifnet *); /* Deprecated. Use if_initialize and if_register */
1003 void	if_attachdomain(void);
1004 void	if_deactivate(struct ifnet *);
1005 bool	if_is_deactivated(const struct ifnet *);
1006 void	if_purgeaddrs(struct ifnet *, int, void (*)(struct ifaddr *));
1007 void	if_detach(struct ifnet *);
1008 void	if_down(struct ifnet *);
1009 void	if_link_state_change(struct ifnet *, int);
1010 void	if_link_state_change_softint(struct ifnet *, int);
1011 void	if_up(struct ifnet *);
1012 void	ifinit(void);
1013 void	ifinit1(void);
1014 int	ifaddrpref_ioctl(struct socket *, u_long, void *, struct ifnet *);
1015 extern int (*ifioctl)(struct socket *, u_long, void *, struct lwp *);
1016 int	ifioctl_common(struct ifnet *, u_long, void *);
1017 int	ifpromisc(struct ifnet *, int);
1018 int	if_addr_init(ifnet_t *, struct ifaddr *, bool);
1019 int	if_do_dad(struct ifnet *);
1020 int	if_mcast_op(ifnet_t *, const unsigned long, const struct sockaddr *);
1021 int	if_flags_set(struct ifnet *, const short);
1022 int	if_clone_list(int, char *, int *);
1023 
1024 struct	ifnet *ifunit(const char *);
1025 struct	ifnet *if_get(const char *, struct psref *);
1026 ifnet_t *if_byindex(u_int);
1027 ifnet_t *if_get_byindex(u_int, struct psref *);
1028 ifnet_t *if_get_bylla(const void *, unsigned char, struct psref *);
1029 void	if_put(const struct ifnet *, struct psref *);
1030 void	if_acquire(struct ifnet *, struct psref *);
1031 #define	if_release	if_put
1032 
1033 static inline if_index_t
1034 if_get_index(const struct ifnet *ifp)
1035 {
1036 
1037 	return ifp != NULL ? ifp->if_index : 0;
1038 }
1039 
1040 bool	if_held(struct ifnet *);
1041 
1042 void	if_input(struct ifnet *, struct mbuf *);
1043 
1044 struct if_percpuq *
1045 	if_percpuq_create(struct ifnet *);
1046 void	if_percpuq_destroy(struct if_percpuq *);
1047 void
1048 	if_percpuq_enqueue(struct if_percpuq *, struct mbuf *);
1049 
1050 void	if_deferred_start_init(struct ifnet *, void (*)(struct ifnet *));
1051 void	if_schedule_deferred_start(struct ifnet *);
1052 
1053 void ifa_insert(struct ifnet *, struct ifaddr *);
1054 void ifa_remove(struct ifnet *, struct ifaddr *);
1055 
1056 void	ifa_psref_init(struct ifaddr *);
1057 void	ifa_acquire(struct ifaddr *, struct psref *);
1058 void	ifa_release(struct ifaddr *, struct psref *);
1059 bool	ifa_held(struct ifaddr *);
1060 bool	ifa_is_destroying(struct ifaddr *);
1061 
1062 void	ifaref(struct ifaddr *);
1063 void	ifafree(struct ifaddr *);
1064 
1065 struct	ifaddr *ifa_ifwithaddr(const struct sockaddr *);
1066 struct	ifaddr *ifa_ifwithaddr_psref(const struct sockaddr *, struct psref *);
1067 struct	ifaddr *ifa_ifwithaf(int);
1068 struct	ifaddr *ifa_ifwithdstaddr(const struct sockaddr *);
1069 struct	ifaddr *ifa_ifwithdstaddr_psref(const struct sockaddr *,
1070 	    struct psref *);
1071 struct	ifaddr *ifa_ifwithnet(const struct sockaddr *);
1072 struct	ifaddr *ifa_ifwithnet_psref(const struct sockaddr *, struct psref *);
1073 struct	ifaddr *ifa_ifwithladdr(const struct sockaddr *);
1074 struct	ifaddr *ifa_ifwithladdr_psref(const struct sockaddr *, struct psref *);
1075 struct	ifaddr *ifa_ifwithroute_psref(int, const struct sockaddr *,
1076 	    const struct sockaddr *, struct psref *);
1077 struct	ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *);
1078 struct	ifaddr *ifaof_ifpforaddr_psref(const struct sockaddr *, struct ifnet *,
1079 	    struct psref *);
1080 void	link_rtrequest(int, struct rtentry *, const struct rt_addrinfo *);
1081 void	p2p_rtrequest(int, struct rtentry *, const struct rt_addrinfo *);
1082 
1083 void	if_clone_attach(struct if_clone *);
1084 void	if_clone_detach(struct if_clone *);
1085 
1086 int	if_transmit_lock(struct ifnet *, struct mbuf *);
1087 
1088 int	ifq_enqueue(struct ifnet *, struct mbuf *);
1089 int	ifq_enqueue2(struct ifnet *, struct ifqueue *, struct mbuf *);
1090 
1091 int	loioctl(struct ifnet *, u_long, void *);
1092 void	loopattach(int);
1093 void	loopinit(void);
1094 int	looutput(struct ifnet *,
1095 	   struct mbuf *, const struct sockaddr *, const struct rtentry *);
1096 
1097 /*
1098  * These are exported because they're an easy way to tell if
1099  * an interface is going away without having to burn a flag.
1100  */
1101 int	if_nulloutput(struct ifnet *, struct mbuf *,
1102 	    const struct sockaddr *, const struct rtentry *);
1103 void	if_nullinput(struct ifnet *, struct mbuf *);
1104 void	if_nullstart(struct ifnet *);
1105 int	if_nulltransmit(struct ifnet *, struct mbuf *);
1106 int	if_nullioctl(struct ifnet *, u_long, void *);
1107 int	if_nullinit(struct ifnet *);
1108 void	if_nullstop(struct ifnet *, int);
1109 void	if_nullslowtimo(struct ifnet *);
1110 #define	if_nullwatchdog	if_nullslowtimo
1111 void	if_nulldrain(struct ifnet *);
1112 #else
1113 struct if_nameindex {
1114 	unsigned int	if_index;	/* 1, 2, ... */
1115 	char		*if_name;	/* null terminated name: "le0", ... */
1116 };
1117 
1118 #include <sys/cdefs.h>
1119 __BEGIN_DECLS
1120 unsigned int if_nametoindex(const char *);
1121 char *	if_indextoname(unsigned int, char *);
1122 struct	if_nameindex * if_nameindex(void);
1123 void	if_freenameindex(struct if_nameindex *);
1124 __END_DECLS
1125 #endif /* _KERNEL */ /* XXX really ALTQ? */
1126 
1127 #ifdef _KERNEL
1128 
1129 #define	IFADDR_FIRST(__ifp)		TAILQ_FIRST(&(__ifp)->if_addrlist)
1130 #define	IFADDR_NEXT(__ifa)		TAILQ_NEXT((__ifa), ifa_list)
1131 #define	IFADDR_FOREACH(__ifa, __ifp)	TAILQ_FOREACH(__ifa, \
1132 					    &(__ifp)->if_addrlist, ifa_list)
1133 #define	IFADDR_FOREACH_SAFE(__ifa, __ifp, __nifa) \
1134 					    TAILQ_FOREACH_SAFE(__ifa, \
1135 					    &(__ifp)->if_addrlist, ifa_list, __nifa)
1136 #define	IFADDR_EMPTY(__ifp)		TAILQ_EMPTY(&(__ifp)->if_addrlist)
1137 
1138 #define IFADDR_ENTRY_INIT(__ifa)					\
1139 	PSLIST_ENTRY_INIT((__ifa), ifa_pslist_entry)
1140 #define IFADDR_ENTRY_DESTROY(__ifa)					\
1141 	PSLIST_ENTRY_DESTROY((__ifa), ifa_pslist_entry)
1142 #define IFADDR_READER_EMPTY(__ifp)					\
1143 	(PSLIST_READER_FIRST(&(__ifp)->if_addr_pslist, struct ifaddr,	\
1144 	                     ifa_pslist_entry) == NULL)
1145 #define IFADDR_READER_FIRST(__ifp)					\
1146 	PSLIST_READER_FIRST(&(__ifp)->if_addr_pslist, struct ifaddr,	\
1147 	                    ifa_pslist_entry)
1148 #define IFADDR_READER_NEXT(__ifa)					\
1149 	PSLIST_READER_NEXT((__ifa), struct ifaddr, ifa_pslist_entry)
1150 #define IFADDR_READER_FOREACH(__ifa, __ifp)				\
1151 	PSLIST_READER_FOREACH((__ifa), &(__ifp)->if_addr_pslist, struct ifaddr,\
1152 	                      ifa_pslist_entry)
1153 #define IFADDR_WRITER_INSERT_HEAD(__ifp, __ifa)				\
1154 	PSLIST_WRITER_INSERT_HEAD(&(__ifp)->if_addr_pslist, (__ifa),	\
1155 	                          ifa_pslist_entry)
1156 #define IFADDR_WRITER_REMOVE(__ifa)					\
1157 	PSLIST_WRITER_REMOVE((__ifa), ifa_pslist_entry)
1158 #define IFADDR_WRITER_FOREACH(__ifa, __ifp)				\
1159 	PSLIST_WRITER_FOREACH((__ifa), &(__ifp)->if_addr_pslist, struct ifaddr,\
1160 	                      ifa_pslist_entry)
1161 #define IFADDR_WRITER_NEXT(__ifp)					\
1162 	PSLIST_WRITER_NEXT((__ifp), struct ifaddr, ifa_pslist_entry)
1163 #define IFADDR_WRITER_INSERT_AFTER(__ifp, __new)			\
1164 	PSLIST_WRITER_INSERT_AFTER((__ifp), (__new), ifa_pslist_entry)
1165 #define IFADDR_WRITER_EMPTY(__ifp)					\
1166 	(PSLIST_WRITER_FIRST(&(__ifp)->if_addr_pslist, struct ifaddr,	\
1167 	                     ifa_pslist_entry) == NULL)
1168 #define IFADDR_WRITER_INSERT_TAIL(__ifp, __new)				\
1169 	do {								\
1170 		if (IFADDR_WRITER_EMPTY((__ifp))) {			\
1171 			IFADDR_WRITER_INSERT_HEAD((__ifp), (__new));	\
1172 		} else {						\
1173 			struct ifaddr *__ifa;				\
1174 			IFADDR_WRITER_FOREACH(__ifa, (__ifp)) {		\
1175 				if (IFADDR_WRITER_NEXT(__ifa) == NULL) {\
1176 					IFADDR_WRITER_INSERT_AFTER(__ifa,\
1177 					    (__new));			\
1178 					break;				\
1179 				}					\
1180 			}						\
1181 		}							\
1182 	} while (0)
1183 
1184 #define	IFNET_LOCK()			mutex_enter(&ifnet_mtx)
1185 #define	IFNET_UNLOCK()			mutex_exit(&ifnet_mtx)
1186 #define	IFNET_LOCKED()			mutex_owned(&ifnet_mtx)
1187 
1188 #define IFNET_READER_EMPTY() \
1189 	(PSLIST_READER_FIRST(&ifnet_pslist, struct ifnet, if_pslist_entry) == NULL)
1190 #define IFNET_READER_FIRST() \
1191 	PSLIST_READER_FIRST(&ifnet_pslist, struct ifnet, if_pslist_entry)
1192 #define IFNET_READER_NEXT(__ifp) \
1193 	PSLIST_READER_NEXT((__ifp), struct ifnet, if_pslist_entry)
1194 #define IFNET_READER_FOREACH(__ifp) \
1195 	PSLIST_READER_FOREACH((__ifp), &ifnet_pslist, struct ifnet, \
1196 	                      if_pslist_entry)
1197 #define IFNET_WRITER_INSERT_HEAD(__ifp) \
1198 	PSLIST_WRITER_INSERT_HEAD(&ifnet_pslist, (__ifp), if_pslist_entry)
1199 #define IFNET_WRITER_REMOVE(__ifp) \
1200 	PSLIST_WRITER_REMOVE((__ifp), if_pslist_entry)
1201 #define IFNET_WRITER_FOREACH(__ifp) \
1202 	PSLIST_WRITER_FOREACH((__ifp), &ifnet_pslist, struct ifnet, \
1203 	                      if_pslist_entry)
1204 #define IFNET_WRITER_NEXT(__ifp) \
1205 	PSLIST_WRITER_NEXT((__ifp), struct ifnet, if_pslist_entry)
1206 #define IFNET_WRITER_INSERT_AFTER(__ifp, __new) \
1207 	PSLIST_WRITER_INSERT_AFTER((__ifp), (__new), if_pslist_entry)
1208 #define IFNET_WRITER_EMPTY() \
1209 	(PSLIST_WRITER_FIRST(&ifnet_pslist, struct ifnet, if_pslist_entry) == NULL)
1210 #define IFNET_WRITER_INSERT_TAIL(__new)					\
1211 	do {								\
1212 		if (IFNET_WRITER_EMPTY()) {				\
1213 			IFNET_WRITER_INSERT_HEAD((__new));		\
1214 		} else {						\
1215 			struct ifnet *__ifp;				\
1216 			IFNET_WRITER_FOREACH(__ifp) {			\
1217 				if (IFNET_WRITER_NEXT(__ifp) == NULL) {	\
1218 					IFNET_WRITER_INSERT_AFTER(__ifp,\
1219 					    (__new));			\
1220 					break;				\
1221 				}					\
1222 			}						\
1223 		}							\
1224 	} while (0)
1225 
1226 extern struct pslist_head ifnet_pslist;
1227 extern kmutex_t ifnet_mtx;
1228 
1229 extern struct ifnet *lo0ifp;
1230 
1231 /*
1232  * ifq sysctl support
1233  */
1234 int	sysctl_ifq(int *name, u_int namelen, void *oldp,
1235 		       size_t *oldlenp, void *newp, size_t newlen,
1236 		       struct ifqueue *ifq);
1237 /* symbolic names for terminal (per-protocol) CTL_IFQ_ nodes */
1238 #define IFQCTL_LEN 1
1239 #define IFQCTL_MAXLEN 2
1240 #define IFQCTL_PEAK 3
1241 #define IFQCTL_DROPS 4
1242 #define IFQCTL_MAXID 5
1243 
1244 #endif /* _KERNEL */
1245 
1246 #ifdef _NETBSD_SOURCE
1247 /*
1248  * sysctl for ifq (per-protocol packet input queue variant of ifqueue)
1249  */
1250 #define CTL_IFQ_NAMES  { \
1251 	{ 0, 0 }, \
1252 	{ "len", CTLTYPE_INT }, \
1253 	{ "maxlen", CTLTYPE_INT }, \
1254 	{ "peak", CTLTYPE_INT }, \
1255 	{ "drops", CTLTYPE_INT }, \
1256 }
1257 #endif /* _NETBSD_SOURCE */
1258 #endif /* !_NET_IF_H_ */
1259