xref: /netbsd-src/sys/net/if.h (revision e89934bbf778a6d6d6894877c4da59d0c7835b0f)
1 /*	$NetBSD: if.h,v 1.233 2016/12/22 03:46:51 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 
235 typedef unsigned short if_index_t;
236 
237 typedef struct ifnet {
238 	void	*if_softc;		/* lower-level data for this if */
239 	/* DEPRECATED. Keep it to avoid breaking kvm(3) users */
240 	TAILQ_ENTRY(ifnet) if_list;	/* all struct ifnets are chained */
241 	TAILQ_HEAD(, ifaddr) if_addrlist; /* linked list of addresses per if */
242 	char	if_xname[IFNAMSIZ];	/* external name (name + unit) */
243 	int	if_pcount;		/* number of promiscuous listeners */
244 	struct bpf_if *if_bpf;		/* packet filter structure */
245 	if_index_t	if_index;	/* numeric abbreviation for this if */
246 	short	if_timer;		/* time 'til if_slowtimo called */
247 	unsigned short	if_flags;	/* up/down, broadcast, etc. */
248 	short	if_extflags;		/* if_output MP-safe, etc. */
249 	struct	if_data if_data;	/* statistics and other data about if */
250 	/*
251 	 * Procedure handles.  If you add more of these, don't forget the
252 	 * corresponding NULL stub in if.c.
253 	 */
254 	int	(*if_output)		/* output routine (enqueue) */
255 		    (struct ifnet *, struct mbuf *, const struct sockaddr *,
256 		     const struct rtentry *);
257 	void	(*_if_input)		/* input routine (from h/w driver) */
258 		    (struct ifnet *, struct mbuf *);
259 	void	(*if_start)		/* initiate output routine */
260 		    (struct ifnet *);
261 	int	(*if_transmit)		/* output routine, must be MP-safe */
262 		    (struct ifnet *, struct mbuf *);
263 	int	(*if_ioctl)		/* ioctl routine */
264 		    (struct ifnet *, u_long, void *);
265 	int	(*if_init)		/* init routine */
266 		    (struct ifnet *);
267 	void	(*if_stop)		/* stop routine */
268 		    (struct ifnet *, int);
269 	void	(*if_slowtimo)		/* timer routine */
270 		    (struct ifnet *);
271 #define	if_watchdog	if_slowtimo
272 	void	(*if_drain)		/* routine to release resources */
273 		    (struct ifnet *);
274 	struct ifaltq if_snd;		/* output queue (includes altq) */
275 	struct ifaddr	*if_dl;		/* identity of this interface. */
276 	const struct	sockaddr_dl *if_sadl;	/* pointer to sockaddr_dl
277 						 * of if_dl
278 						 */
279 	/* if_hwdl: h/w identity
280 	 *
281 	 * May be NULL.  If not NULL, it is the address assigned
282 	 * to the interface by the manufacturer, so it very likely
283 	 * to be unique.  It MUST NOT be deleted.  It is highly
284 	 * suitable for deriving the EUI64 for the interface.
285 	 */
286 	struct ifaddr	*if_hwdl;
287 	const uint8_t *if_broadcastaddr;/* linklevel broadcast bytestring */
288 	struct bridge_softc	*if_bridge;	/* bridge glue */
289 	struct bridge_iflist	*if_bridgeif;	/* shortcut to interface list entry */
290 	int	if_dlt;			/* data link type (<net/dlt.h>) */
291 	pfil_head_t *	if_pfil;	/* filtering point */
292 	uint64_t if_capabilities;	/* interface capabilities */
293 	uint64_t if_capenable;		/* capabilities enabled */
294 	union {
295 		void *		carp_s;	/* carp structure (used by !carp ifs) */
296 		struct ifnet	*carp_d;/* ptr to carpdev (used by carp ifs) */
297 	} if_carp_ptr;
298 #define if_carp		if_carp_ptr.carp_s
299 #define if_carpdev	if_carp_ptr.carp_d
300 	/*
301 	 * These are pre-computed based on an interfaces enabled
302 	 * capabilities, for speed elsewhere.
303 	 */
304 	int	if_csum_flags_tx;	/* M_CSUM_* flags for Tx */
305 	int	if_csum_flags_rx;	/* M_CSUM_* flags for Rx */
306 
307 	void	*if_afdata[AF_MAX];
308 	struct	mowner *if_mowner;	/* who owns mbufs for this interface */
309 
310 	void	*if_agrprivate;		/* used only when #if NAGR > 0 */
311 
312 	/*
313 	 * pf specific data, used only when #if NPF > 0.
314 	 */
315 	void	*if_pf_kif;		/* pf interface abstraction */
316 	void	*if_pf_groups;		/* pf interface groups */
317 	/*
318 	 * During an ifnet's lifetime, it has only one if_index, but
319 	 * and if_index is not sufficient to identify an ifnet
320 	 * because during the lifetime of the system, many ifnets may occupy a
321 	 * given if_index.  Let us tell different ifnets at the same
322 	 * if_index apart by their if_index_gen, a unique number that each ifnet
323 	 * is assigned when it if_attach()s.  Now, the kernel can use the
324 	 * pair (if_index, if_index_gen) as a weak reference to an ifnet.
325 	 */
326 	uint64_t if_index_gen;		/* generation number for the ifnet
327 					 * at if_index: if two ifnets' index
328 					 * and generation number are both the
329 					 * same, they are the same ifnet.
330 					 */
331 	struct sysctllog	*if_sysctl_log;
332 	int (*if_initaddr)(struct ifnet *, struct ifaddr *, bool);
333 	int (*if_mcastop)(struct ifnet *, const unsigned long,
334 	    const struct sockaddr *);
335 	int (*if_setflags)(struct ifnet *, const short);
336 	kmutex_t	*if_ioctl_lock;
337 #ifdef _KERNEL /* XXX kvm(3) */
338 	struct callout *if_slowtimo_ch;
339 	struct krwlock	*if_afdata_lock;
340 	struct if_percpuq	*if_percpuq; /* We should remove it in the future */
341 	void	*if_link_si;		/* softint to handle link state changes */
342 	uint16_t	if_link_queue;	/* masked link state change queue */
343 	struct pslist_entry	if_pslist_entry;
344 	struct psref_target     if_psref;
345 	struct pslist_head	if_addr_pslist;
346 	struct if_deferred_start	*if_deferred_start;
347 #endif
348 } ifnet_t;
349 
350 #define	if_mtu		if_data.ifi_mtu
351 #define	if_type		if_data.ifi_type
352 #define	if_addrlen	if_data.ifi_addrlen
353 #define	if_hdrlen	if_data.ifi_hdrlen
354 #define	if_metric	if_data.ifi_metric
355 #define	if_link_state	if_data.ifi_link_state
356 #define	if_baudrate	if_data.ifi_baudrate
357 #define	if_ipackets	if_data.ifi_ipackets
358 #define	if_ierrors	if_data.ifi_ierrors
359 #define	if_opackets	if_data.ifi_opackets
360 #define	if_oerrors	if_data.ifi_oerrors
361 #define	if_collisions	if_data.ifi_collisions
362 #define	if_ibytes	if_data.ifi_ibytes
363 #define	if_obytes	if_data.ifi_obytes
364 #define	if_imcasts	if_data.ifi_imcasts
365 #define	if_omcasts	if_data.ifi_omcasts
366 #define	if_iqdrops	if_data.ifi_iqdrops
367 #define	if_noproto	if_data.ifi_noproto
368 #define	if_lastchange	if_data.ifi_lastchange
369 
370 #define	IFF_UP		0x0001		/* interface is up */
371 #define	IFF_BROADCAST	0x0002		/* broadcast address valid */
372 #define	IFF_DEBUG	0x0004		/* turn on debugging */
373 #define	IFF_LOOPBACK	0x0008		/* is a loopback net */
374 #define	IFF_POINTOPOINT	0x0010		/* interface is point-to-point link */
375 #define	IFF_NOTRAILERS	0x0020		/* avoid use of trailers */
376 #define	IFF_RUNNING	0x0040		/* resources allocated */
377 #define	IFF_NOARP	0x0080		/* no address resolution protocol */
378 #define	IFF_PROMISC	0x0100		/* receive all packets */
379 #define	IFF_ALLMULTI	0x0200		/* receive all multicast packets */
380 #define	IFF_OACTIVE	0x0400		/* transmission in progress */
381 #define	IFF_SIMPLEX	0x0800		/* can't hear own transmissions */
382 #define	IFF_LINK0	0x1000		/* per link layer defined bit */
383 #define	IFF_LINK1	0x2000		/* per link layer defined bit */
384 #define	IFF_LINK2	0x4000		/* per link layer defined bit */
385 #define	IFF_MULTICAST	0x8000		/* supports multicast */
386 
387 #define	IFEF_OUTPUT_MPSAFE		__BIT(0)	/* if_output() can run parallel */
388 #define	IFEF_START_MPSAFE		__BIT(1)	/* if_start() can run parallel */
389 #define	IFEF_NO_LINK_STATE_CHANGE	__BIT(2)	/* doesn't use link state interrupts */
390 
391 #ifdef _KERNEL
392 static inline bool
393 if_output_is_mpsafe(struct ifnet *ifp)
394 {
395 
396 	return ((ifp->if_extflags & IFEF_OUTPUT_MPSAFE) != 0);
397 }
398 
399 static inline int
400 if_output_lock(struct ifnet *cifp, struct ifnet *ifp, struct mbuf *m,
401     const struct sockaddr *dst, const struct rtentry *rt)
402 {
403 
404 	if (if_output_is_mpsafe(cifp)) {
405 		return (*cifp->if_output)(ifp, m, dst, rt);
406 	} else {
407 		int ret;
408 
409 		KERNEL_LOCK(1, NULL);
410 		ret = (*cifp->if_output)(ifp, m, dst, rt);
411 		KERNEL_UNLOCK_ONE(NULL);
412 		return ret;
413 	}
414 }
415 
416 static inline bool
417 if_start_is_mpsafe(struct ifnet *ifp)
418 {
419 
420 	return ((ifp->if_extflags & IFEF_START_MPSAFE) != 0);
421 }
422 
423 static inline void
424 if_start_lock(struct ifnet *ifp)
425 {
426 
427 	if (if_start_is_mpsafe(ifp)) {
428 		(*ifp->if_start)(ifp);
429 	} else {
430 		KERNEL_LOCK(1, NULL);
431 		(*ifp->if_start)(ifp);
432 		KERNEL_UNLOCK_ONE(NULL);
433 	}
434 }
435 
436 static inline bool
437 if_is_link_state_changeable(struct ifnet *ifp)
438 {
439 
440 	return ((ifp->if_extflags & IFEF_NO_LINK_STATE_CHANGE) == 0);
441 }
442 #endif /* _KERNEL */
443 
444 #define	IFFBITS \
445     "\020\1UP\2BROADCAST\3DEBUG\4LOOPBACK\5POINTOPOINT\6NOTRAILERS" \
446     "\7RUNNING\10NOARP\11PROMISC\12ALLMULTI\13OACTIVE\14SIMPLEX" \
447     "\15LINK0\16LINK1\17LINK2\20MULTICAST"
448 
449 /* flags set internally only: */
450 #define	IFF_CANTCHANGE \
451 	(IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
452 	    IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC)
453 
454 /*
455  * Some convenience macros used for setting ifi_baudrate.
456  */
457 #define	IF_Kbps(x)	((x) * 1000ULL)			/* kilobits/sec. */
458 #define	IF_Mbps(x)	(IF_Kbps((x) * 1000ULL))	/* megabits/sec. */
459 #define	IF_Gbps(x)	(IF_Mbps((x) * 1000ULL))	/* gigabits/sec. */
460 
461 /* Capabilities that interfaces can advertise. */
462 					/* 0x01 .. 0x40 were previously used */
463 #define	IFCAP_TSOv4		0x00080	/* can do TCPv4 segmentation offload */
464 #define	IFCAP_CSUM_IPv4_Rx	0x00100	/* can do IPv4 header checksums (Rx) */
465 #define	IFCAP_CSUM_IPv4_Tx	0x00200	/* can do IPv4 header checksums (Tx) */
466 #define	IFCAP_CSUM_TCPv4_Rx	0x00400	/* can do IPv4/TCP checksums (Rx) */
467 #define	IFCAP_CSUM_TCPv4_Tx	0x00800	/* can do IPv4/TCP checksums (Tx) */
468 #define	IFCAP_CSUM_UDPv4_Rx	0x01000	/* can do IPv4/UDP checksums (Rx) */
469 #define	IFCAP_CSUM_UDPv4_Tx	0x02000	/* can do IPv4/UDP checksums (Tx) */
470 #define	IFCAP_CSUM_TCPv6_Rx	0x04000	/* can do IPv6/TCP checksums (Rx) */
471 #define	IFCAP_CSUM_TCPv6_Tx	0x08000	/* can do IPv6/TCP checksums (Tx) */
472 #define	IFCAP_CSUM_UDPv6_Rx	0x10000	/* can do IPv6/UDP checksums (Rx) */
473 #define	IFCAP_CSUM_UDPv6_Tx	0x20000	/* can do IPv6/UDP checksums (Tx) */
474 #define	IFCAP_TSOv6		0x40000	/* can do TCPv6 segmentation offload */
475 #define	IFCAP_LRO		0x80000	/* can do Large Receive Offload */
476 #define	IFCAP_MASK		0xfff80 /* currently valid capabilities */
477 
478 #define	IFCAPBITS		\
479 	"\020"			\
480 	"\10TSO4"		\
481 	"\11IP4CSUM_Rx"		\
482 	"\12IP4CSUM_Tx"		\
483 	"\13TCP4CSUM_Rx"	\
484 	"\14TCP4CSUM_Tx"	\
485 	"\15UDP4CSUM_Rx"	\
486 	"\16UDP4CSUM_Tx"	\
487 	"\17TCP6CSUM_Rx"	\
488 	"\20TCP6CSUM_Tx"	\
489 	"\21UDP6CSUM_Rx"	\
490 	"\22UDP6CSUM_Tx"	\
491 	"\23TSO6"		\
492 	"\24LRO"		\
493 
494 #define	IF_AFDATA_LOCK_INIT(ifp)	\
495 	do {(ifp)->if_afdata_lock = rw_obj_alloc();} while (0)
496 
497 #define	IF_AFDATA_LOCK_DESTROY(ifp)	rw_obj_free((ifp)->if_afdata_lock)
498 
499 #define	IF_AFDATA_WLOCK(ifp)	rw_enter((ifp)->if_afdata_lock, RW_WRITER)
500 #define	IF_AFDATA_RLOCK(ifp)	rw_enter((ifp)->if_afdata_lock, RW_READER)
501 #define	IF_AFDATA_WUNLOCK(ifp)	rw_exit((ifp)->if_afdata_lock)
502 #define	IF_AFDATA_RUNLOCK(ifp)	rw_exit((ifp)->if_afdata_lock)
503 #define	IF_AFDATA_LOCK(ifp)	IF_AFDATA_WLOCK(ifp)
504 #define	IF_AFDATA_UNLOCK(ifp)	IF_AFDATA_WUNLOCK(ifp)
505 #define	IF_AFDATA_TRYLOCK(ifp)	rw_tryenter((ifp)->if_afdata_lock, RW_WRITER)
506 
507 #define	IF_AFDATA_LOCK_ASSERT(ifp)	\
508 	KASSERT(rw_lock_held((ifp)->if_afdata_lock))
509 #define	IF_AFDATA_RLOCK_ASSERT(ifp)	\
510 	KASSERT(rw_read_held((ifp)->if_afdata_lock))
511 #define	IF_AFDATA_WLOCK_ASSERT(ifp)	\
512 	KASSERT(rw_write_held((ifp)->if_afdata_lock))
513 
514 /*
515  * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
516  * input routines have queues of messages stored on ifqueue structures
517  * (defined above).  Entries are added to and deleted from these structures
518  * by these macros, which should be called with ipl raised to splnet().
519  */
520 #define	IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
521 #define	IF_DROP(ifq)		((ifq)->ifq_drops++)
522 #define	IF_ENQUEUE(ifq, m) do { \
523 	(m)->m_nextpkt = 0; \
524 	if ((ifq)->ifq_tail == 0) \
525 		(ifq)->ifq_head = m; \
526 	else \
527 		(ifq)->ifq_tail->m_nextpkt = m; \
528 	(ifq)->ifq_tail = m; \
529 	(ifq)->ifq_len++; \
530 } while (/*CONSTCOND*/0)
531 #define	IF_PREPEND(ifq, m) do { \
532 	(m)->m_nextpkt = (ifq)->ifq_head; \
533 	if ((ifq)->ifq_tail == 0) \
534 		(ifq)->ifq_tail = (m); \
535 	(ifq)->ifq_head = (m); \
536 	(ifq)->ifq_len++; \
537 } while (/*CONSTCOND*/0)
538 #define	IF_DEQUEUE(ifq, m) do { \
539 	(m) = (ifq)->ifq_head; \
540 	if (m) { \
541 		if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
542 			(ifq)->ifq_tail = 0; \
543 		(m)->m_nextpkt = 0; \
544 		(ifq)->ifq_len--; \
545 	} \
546 } while (/*CONSTCOND*/0)
547 #define	IF_POLL(ifq, m)		((m) = (ifq)->ifq_head)
548 #define	IF_PURGE(ifq)							\
549 do {									\
550 	struct mbuf *__m0;						\
551 									\
552 	for (;;) {							\
553 		IF_DEQUEUE((ifq), __m0);				\
554 		if (__m0 == NULL)					\
555 			break;						\
556 		else							\
557 			m_freem(__m0);					\
558 	}								\
559 } while (/*CONSTCOND*/ 0)
560 #define	IF_IS_EMPTY(ifq)	((ifq)->ifq_len == 0)
561 
562 #ifndef IFQ_MAXLEN
563 #define	IFQ_MAXLEN	256
564 #endif
565 #define	IFNET_SLOWHZ	1		/* granularity is 1 second */
566 
567 /*
568  * Structure defining statistics and other data kept regarding an address
569  * on a network interface.
570  */
571 struct ifaddr_data {
572 	int64_t	ifad_inbytes;
573 	int64_t	ifad_outbytes;
574 };
575 
576 /*
577  * The ifaddr structure contains information about one address
578  * of an interface.  They are maintained by the different address families,
579  * are allocated and attached when an address is set, and are linked
580  * together so all addresses for an interface can be located.
581  */
582 struct ifaddr {
583 	struct	sockaddr *ifa_addr;	/* address of interface */
584 	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
585 #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
586 	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
587 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
588 	TAILQ_ENTRY(ifaddr) ifa_list;	/* list of addresses for interface */
589 	struct	ifaddr_data	ifa_data;	/* statistics on the address */
590 	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
591 		        (int, struct rtentry *, const struct rt_addrinfo *);
592 	u_int	ifa_flags;		/* mostly rt_flags for cloning */
593 	int	ifa_refcnt;		/* count of references */
594 	int	ifa_metric;		/* cost of going out this interface */
595 	struct ifaddr	*(*ifa_getifa)(struct ifaddr *,
596 			               const struct sockaddr *);
597 	uint32_t	*ifa_seqno;
598 	int16_t	ifa_preference;	/* preference level for this address */
599 #ifdef _KERNEL
600 	struct pslist_entry     ifa_pslist_entry;
601 	struct psref_target	ifa_psref;
602 #endif
603 };
604 #define	IFA_ROUTE	RTF_UP	/* (0x01) route installed */
605 #define	IFA_DESTROYING	0x2
606 
607 /*
608  * Message format for use in obtaining information about interfaces from
609  * sysctl and the routing socket.  We need to force 64-bit alignment if we
610  * aren't using compatiblity definitons.
611  */
612 #if !defined(_KERNEL) || !defined(COMPAT_RTSOCK)
613 #define	__align64	__aligned(sizeof(uint64_t))
614 #else
615 #define	__align64
616 #endif
617 struct if_msghdr {
618 	u_short	ifm_msglen __align64;
619 				/* to skip over non-understood messages */
620 	u_char	ifm_version;	/* future binary compatibility */
621 	u_char	ifm_type;	/* message type */
622 	int	ifm_addrs;	/* like rtm_addrs */
623 	int	ifm_flags;	/* value of if_flags */
624 	u_short	ifm_index;	/* index for associated ifp */
625 	struct	if_data ifm_data __align64;
626 				/* statistics and other data about if */
627 };
628 
629 /*
630  * Message format for use in obtaining information about interface addresses
631  * from sysctl and the routing socket.
632  */
633 struct ifa_msghdr {
634 	u_short	ifam_msglen __align64;
635 				/* to skip over non-understood messages */
636 	u_char	ifam_version;	/* future binary compatibility */
637 	u_char	ifam_type;	/* message type */
638 	u_short	ifam_index;	/* index for associated ifp */
639 	int	ifam_flags;	/* value of ifa_flags */
640 	int	ifam_addrs;	/* like rtm_addrs */
641 	pid_t	ifam_pid;	/* identify sender */
642 	int	ifam_addrflags;	/* family specific address flags */
643 	int	ifam_metric;	/* value of ifa_metric */
644 };
645 
646 /*
647  * Message format announcing the arrival or departure of a network interface.
648  */
649 struct if_announcemsghdr {
650 	u_short	ifan_msglen __align64;
651 				/* to skip over non-understood messages */
652 	u_char	ifan_version;	/* future binary compatibility */
653 	u_char	ifan_type;	/* message type */
654 	u_short	ifan_index;	/* index for associated ifp */
655 	char	ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
656 	u_short	ifan_what;	/* what type of announcement */
657 };
658 
659 #define	IFAN_ARRIVAL	0	/* interface arrival */
660 #define	IFAN_DEPARTURE	1	/* interface departure */
661 
662 #undef __align64
663 
664 /*
665  * Interface request structure used for socket
666  * ioctl's.  All interface ioctl's must have parameter
667  * definitions which begin with ifr_name.  The
668  * remainder may be interface specific.
669  */
670 struct	ifreq {
671 	char	ifr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
672 	union {
673 		struct	sockaddr ifru_addr;
674 		struct	sockaddr ifru_dstaddr;
675 		struct	sockaddr ifru_broadaddr;
676 		struct	sockaddr_storage ifru_space;
677 		short	ifru_flags;
678 		int	ifru_addrflags;
679 		int	ifru_metric;
680 		int	ifru_mtu;
681 		int	ifru_dlt;
682 		u_int	ifru_value;
683 		void *	ifru_data;
684 		struct {
685 			uint32_t	b_buflen;
686 			void		*b_buf;
687 		} ifru_b;
688 	} ifr_ifru;
689 #define	ifr_addr	ifr_ifru.ifru_addr	/* address */
690 #define	ifr_dstaddr	ifr_ifru.ifru_dstaddr	/* other end of p-to-p link */
691 #define	ifr_broadaddr	ifr_ifru.ifru_broadaddr	/* broadcast address */
692 #define	ifr_space	ifr_ifru.ifru_space	/* sockaddr_storage */
693 #define	ifr_flags	ifr_ifru.ifru_flags	/* flags */
694 #define	ifr_addrflags	ifr_ifru.ifru_addrflags	/* addr flags */
695 #define	ifr_metric	ifr_ifru.ifru_metric	/* metric */
696 #define	ifr_mtu		ifr_ifru.ifru_mtu	/* mtu */
697 #define	ifr_dlt		ifr_ifru.ifru_dlt	/* data link type (DLT_*) */
698 #define	ifr_value	ifr_ifru.ifru_value	/* generic value */
699 #define	ifr_media	ifr_ifru.ifru_metric	/* media options (overload) */
700 #define	ifr_data	ifr_ifru.ifru_data	/* for use by interface
701 						 * XXX deprecated
702 						 */
703 #define	ifr_buf		ifr_ifru.ifru_b.b_buf	/* new interface ioctls */
704 #define	ifr_buflen	ifr_ifru.ifru_b.b_buflen
705 #define	ifr_index	ifr_ifru.ifru_value	/* interface index, BSD */
706 #define	ifr_ifindex	ifr_index		/* interface index, linux */
707 };
708 
709 #ifdef _KERNEL
710 #define	ifreq_setdstaddr	ifreq_setaddr
711 #define	ifreq_setbroadaddr	ifreq_setaddr
712 #define	ifreq_getdstaddr	ifreq_getaddr
713 #define	ifreq_getbroadaddr	ifreq_getaddr
714 
715 static inline const struct sockaddr *
716 /*ARGSUSED*/
717 ifreq_getaddr(u_long cmd, const struct ifreq *ifr)
718 {
719 	return &ifr->ifr_addr;
720 }
721 #endif /* _KERNEL */
722 
723 struct ifcapreq {
724 	char		ifcr_name[IFNAMSIZ];	/* if name, e.g. "en0" */
725 	uint64_t	ifcr_capabilities;	/* supported capabiliites */
726 	uint64_t	ifcr_capenable;		/* capabilities enabled */
727 };
728 
729 struct ifaliasreq {
730 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
731 	struct	sockaddr ifra_addr;
732 	struct	sockaddr ifra_dstaddr;
733 #define	ifra_broadaddr	ifra_dstaddr
734 	struct	sockaddr ifra_mask;
735 };
736 
737 struct ifdatareq {
738 	char	ifdr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
739 	struct	if_data ifdr_data;
740 };
741 
742 struct ifmediareq {
743 	char	ifm_name[IFNAMSIZ];		/* if name, e.g. "en0" */
744 	int	ifm_current;			/* current media options */
745 	int	ifm_mask;			/* don't care mask */
746 	int	ifm_status;			/* media status */
747 	int	ifm_active;			/* active options */
748 	int	ifm_count;			/* # entries in ifm_ulist
749 						   array */
750 	int	*ifm_ulist;			/* media words */
751 };
752 
753 
754 struct  ifdrv {
755 	char		ifd_name[IFNAMSIZ];	/* if name, e.g. "en0" */
756 	unsigned long	ifd_cmd;
757 	size_t		ifd_len;
758 	void		*ifd_data;
759 };
760 #define IFLINKSTR_QUERYLEN	0x01
761 #define IFLINKSTR_UNSET		0x02
762 
763 /*
764  * Structure used in SIOCGIFCONF request.
765  * Used to retrieve interface configuration
766  * for machine (useful for programs which
767  * must know all networks accessible).
768  */
769 struct	ifconf {
770 	int	ifc_len;		/* size of associated buffer */
771 	union {
772 		void *	ifcu_buf;
773 		struct	ifreq *ifcu_req;
774 	} ifc_ifcu;
775 #define	ifc_buf	ifc_ifcu.ifcu_buf	/* buffer address */
776 #define	ifc_req	ifc_ifcu.ifcu_req	/* array of structures returned */
777 };
778 
779 /*
780  * Structure for SIOC[AGD]LIFADDR
781  */
782 struct if_laddrreq {
783 	char iflr_name[IFNAMSIZ];
784 	unsigned int flags;
785 #define IFLR_PREFIX	0x8000	/* in: prefix given  out: kernel fills id */
786 #define IFLR_ACTIVE	0x4000	/* in/out: link-layer address activation */
787 #define IFLR_FACTORY	0x2000	/* in/out: factory link-layer address */
788 	unsigned int prefixlen;		/* in/out */
789 	struct sockaddr_storage addr;	/* in/out */
790 	struct sockaddr_storage dstaddr; /* out */
791 };
792 
793 /*
794  * Structure for SIOC[SG]IFADDRPREF
795  */
796 struct if_addrprefreq {
797 	char			ifap_name[IFNAMSIZ];
798 	int16_t			ifap_preference;	/* in/out */
799 	struct sockaddr_storage	ifap_addr;		/* in/out */
800 };
801 
802 #include <net/if_arp.h>
803 
804 #endif /* _NETBSD_SOURCE */
805 
806 #ifdef _KERNEL
807 #ifdef ALTQ
808 #define IFQ_ENQUEUE(ifq, m, err)					\
809 do {									\
810 	mutex_enter((ifq)->ifq_lock);					\
811 	if (ALTQ_IS_ENABLED((ifq)))					\
812 		ALTQ_ENQUEUE((ifq), (m), (err));			\
813 	else {								\
814 		if (IF_QFULL((ifq))) {					\
815 			m_freem((m));					\
816 			(err) = ENOBUFS;				\
817 		} else {						\
818 			IF_ENQUEUE((ifq), (m));				\
819 			(err) = 0;					\
820 		}							\
821 	}								\
822 	if ((err))							\
823 		(ifq)->ifq_drops++;					\
824 	mutex_exit((ifq)->ifq_lock);					\
825 } while (/*CONSTCOND*/ 0)
826 
827 #define IFQ_DEQUEUE(ifq, m)						\
828 do {									\
829 	mutex_enter((ifq)->ifq_lock);					\
830 	if (TBR_IS_ENABLED((ifq)))					\
831 		(m) = tbr_dequeue((ifq), ALTDQ_REMOVE);			\
832 	else if (ALTQ_IS_ENABLED((ifq)))				\
833 		ALTQ_DEQUEUE((ifq), (m));				\
834 	else								\
835 		IF_DEQUEUE((ifq), (m));					\
836 	mutex_exit((ifq)->ifq_lock);					\
837 } while (/*CONSTCOND*/ 0)
838 
839 #define	IFQ_POLL(ifq, m)						\
840 do {									\
841 	mutex_enter((ifq)->ifq_lock);					\
842 	if (TBR_IS_ENABLED((ifq)))					\
843 		(m) = tbr_dequeue((ifq), ALTDQ_POLL);			\
844 	else if (ALTQ_IS_ENABLED((ifq)))				\
845 		ALTQ_POLL((ifq), (m));					\
846 	else								\
847 		IF_POLL((ifq), (m));					\
848 	mutex_exit((ifq)->ifq_lock);					\
849 } while (/*CONSTCOND*/ 0)
850 
851 #define	IFQ_PURGE(ifq)							\
852 do {									\
853 	mutex_enter((ifq)->ifq_lock);					\
854 	if (ALTQ_IS_ENABLED((ifq)))					\
855 		ALTQ_PURGE((ifq));					\
856 	else								\
857 		IF_PURGE((ifq));					\
858 	mutex_exit((ifq)->ifq_lock);					\
859 } while (/*CONSTCOND*/ 0)
860 
861 #define	IFQ_SET_READY(ifq)						\
862 do {									\
863 	(ifq)->altq_flags |= ALTQF_READY;				\
864 } while (/*CONSTCOND*/ 0)
865 
866 #define	IFQ_CLASSIFY(ifq, m, af)					\
867 do {									\
868 	mutex_enter((ifq)->ifq_lock);					\
869 	if (ALTQ_IS_ENABLED((ifq))) {					\
870 		if (ALTQ_NEEDS_CLASSIFY((ifq)))				\
871 			m->m_pkthdr.pattr_class = (*(ifq)->altq_classify) \
872 				((ifq)->altq_clfier, (m), (af));	\
873 		m->m_pkthdr.pattr_af = (af);				\
874 		m->m_pkthdr.pattr_hdr = mtod((m), void *);		\
875 	}								\
876 	mutex_exit((ifq)->ifq_lock);					\
877 } while (/*CONSTCOND*/ 0)
878 #else /* ! ALTQ */
879 #define	IFQ_ENQUEUE(ifq, m, err)					\
880 do {									\
881 	mutex_enter((ifq)->ifq_lock);					\
882 	if (IF_QFULL((ifq))) {						\
883 		m_freem((m));						\
884 		(err) = ENOBUFS;					\
885 	} else {							\
886 		IF_ENQUEUE((ifq), (m));					\
887 		(err) = 0;						\
888 	}								\
889 	if ((err))							\
890 		(ifq)->ifq_drops++;					\
891 	mutex_exit((ifq)->ifq_lock);					\
892 } while (/*CONSTCOND*/ 0)
893 
894 #define	IFQ_DEQUEUE(ifq, m)						\
895 do {									\
896 	mutex_enter((ifq)->ifq_lock);					\
897 	IF_DEQUEUE((ifq), (m));						\
898 	mutex_exit((ifq)->ifq_lock);					\
899 } while (/*CONSTCOND*/ 0)
900 
901 #define	IFQ_POLL(ifq, m)						\
902 do {									\
903 	mutex_enter((ifq)->ifq_lock);					\
904 	IF_POLL((ifq), (m));						\
905 	mutex_exit((ifq)->ifq_lock);					\
906 } while (/*CONSTCOND*/ 0)
907 
908 #define	IFQ_PURGE(ifq)							\
909 do {									\
910 	mutex_enter((ifq)->ifq_lock);					\
911 	IF_PURGE((ifq));						\
912 	mutex_exit((ifq)->ifq_lock);					\
913 } while (/*CONSTCOND*/ 0)
914 
915 #define	IFQ_SET_READY(ifq)	/* nothing */
916 
917 #define	IFQ_CLASSIFY(ifq, m, af) /* nothing */
918 
919 #endif /* ALTQ */
920 
921 #define IFQ_LOCK_INIT(ifq)	(ifq)->ifq_lock =			\
922 	    mutex_obj_alloc(MUTEX_DEFAULT, IPL_NET)
923 #define IFQ_LOCK(ifq)		mutex_enter((ifq)->ifq_lock)
924 #define IFQ_UNLOCK(ifq)		mutex_exit((ifq)->ifq_lock)
925 
926 #define	IFQ_IS_EMPTY(ifq)		IF_IS_EMPTY((ifq))
927 #define	IFQ_INC_LEN(ifq)		((ifq)->ifq_len++)
928 #define	IFQ_DEC_LEN(ifq)		(--(ifq)->ifq_len)
929 #define	IFQ_INC_DROPS(ifq)		((ifq)->ifq_drops++)
930 #define	IFQ_SET_MAXLEN(ifq, len)	((ifq)->ifq_maxlen = (len))
931 
932 #include <sys/mallocvar.h>
933 MALLOC_DECLARE(M_IFADDR);
934 MALLOC_DECLARE(M_IFMADDR);
935 
936 int ifreq_setaddr(u_long, struct ifreq *, const struct sockaddr *);
937 
938 struct ifnet *if_alloc(u_char);
939 void if_free(struct ifnet *);
940 void if_initname(struct ifnet *, const char *, int);
941 struct ifaddr *if_dl_create(const struct ifnet *, const struct sockaddr_dl **);
942 void if_activate_sadl(struct ifnet *, struct ifaddr *,
943     const struct sockaddr_dl *);
944 void	if_set_sadl(struct ifnet *, const void *, u_char, bool);
945 void	if_alloc_sadl(struct ifnet *);
946 void	if_initialize(struct ifnet *);
947 void	if_register(struct ifnet *);
948 void	if_attach(struct ifnet *); /* Deprecated. Use if_initialize and if_register */
949 void	if_attachdomain(void);
950 void	if_deactivate(struct ifnet *);
951 bool	if_is_deactivated(const struct ifnet *);
952 void	if_purgeaddrs(struct ifnet *, int, void (*)(struct ifaddr *));
953 void	if_detach(struct ifnet *);
954 void	if_down(struct ifnet *);
955 void	if_link_state_change(struct ifnet *, int);
956 void	if_up(struct ifnet *);
957 void	ifinit(void);
958 void	ifinit1(void);
959 int	ifaddrpref_ioctl(struct socket *, u_long, void *, struct ifnet *);
960 extern int (*ifioctl)(struct socket *, u_long, void *, struct lwp *);
961 int	ifioctl_common(struct ifnet *, u_long, void *);
962 int	ifpromisc(struct ifnet *, int);
963 int	if_addr_init(ifnet_t *, struct ifaddr *, bool);
964 int	if_do_dad(struct ifnet *);
965 int	if_mcast_op(ifnet_t *, const unsigned long, const struct sockaddr *);
966 int	if_flags_set(struct ifnet *, const short);
967 int	if_clone_list(int, char *, int *);
968 
969 struct	ifnet *ifunit(const char *);
970 struct	ifnet *if_get(const char *, struct psref *);
971 ifnet_t *if_byindex(u_int);
972 ifnet_t *if_get_byindex(u_int, struct psref *);
973 void	if_put(const struct ifnet *, struct psref *);
974 void	if_acquire_NOMPSAFE(struct ifnet *, struct psref *);
975 
976 static inline if_index_t
977 if_get_index(const struct ifnet *ifp)
978 {
979 
980 	return ifp != NULL ? ifp->if_index : 0;
981 }
982 
983 bool	if_held(struct ifnet *);
984 
985 void	if_input(struct ifnet *, struct mbuf *);
986 
987 struct if_percpuq *
988 	if_percpuq_create(struct ifnet *);
989 void	if_percpuq_destroy(struct if_percpuq *);
990 void
991 	if_percpuq_enqueue(struct if_percpuq *, struct mbuf *);
992 
993 void	if_deferred_start_init(struct ifnet *, void (*)(struct ifnet *));
994 void	if_schedule_deferred_start(struct ifnet *);
995 
996 void ifa_insert(struct ifnet *, struct ifaddr *);
997 void ifa_remove(struct ifnet *, struct ifaddr *);
998 
999 void	ifa_psref_init(struct ifaddr *);
1000 void	ifa_acquire(struct ifaddr *, struct psref *);
1001 void	ifa_release(struct ifaddr *, struct psref *);
1002 bool	ifa_held(struct ifaddr *);
1003 bool	ifa_is_destroying(struct ifaddr *);
1004 
1005 void	ifaref(struct ifaddr *);
1006 void	ifafree(struct ifaddr *);
1007 
1008 struct	ifaddr *ifa_ifwithaddr(const struct sockaddr *);
1009 struct	ifaddr *ifa_ifwithaddr_psref(const struct sockaddr *, struct psref *);
1010 struct	ifaddr *ifa_ifwithaf(int);
1011 struct	ifaddr *ifa_ifwithdstaddr(const struct sockaddr *);
1012 struct	ifaddr *ifa_ifwithdstaddr_psref(const struct sockaddr *,
1013 	    struct psref *);
1014 struct	ifaddr *ifa_ifwithnet(const struct sockaddr *);
1015 struct	ifaddr *ifa_ifwithnet_psref(const struct sockaddr *, struct psref *);
1016 struct	ifaddr *ifa_ifwithladdr(const struct sockaddr *);
1017 struct	ifaddr *ifa_ifwithladdr_psref(const struct sockaddr *, struct psref *);
1018 struct	ifaddr *ifa_ifwithroute_psref(int, const struct sockaddr *,
1019 	    const struct sockaddr *, struct psref *);
1020 struct	ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *);
1021 struct	ifaddr *ifaof_ifpforaddr_psref(const struct sockaddr *, struct ifnet *,
1022 	    struct psref *);
1023 void	link_rtrequest(int, struct rtentry *, const struct rt_addrinfo *);
1024 void	p2p_rtrequest(int, struct rtentry *, const struct rt_addrinfo *);
1025 
1026 void	if_clone_attach(struct if_clone *);
1027 void	if_clone_detach(struct if_clone *);
1028 
1029 int	if_transmit_lock(struct ifnet *, struct mbuf *);
1030 
1031 int	ifq_enqueue(struct ifnet *, struct mbuf *);
1032 int	ifq_enqueue2(struct ifnet *, struct ifqueue *, struct mbuf *);
1033 
1034 int	loioctl(struct ifnet *, u_long, void *);
1035 void	loopattach(int);
1036 void	loopinit(void);
1037 int	looutput(struct ifnet *,
1038 	   struct mbuf *, const struct sockaddr *, const struct rtentry *);
1039 
1040 /*
1041  * These are exported because they're an easy way to tell if
1042  * an interface is going away without having to burn a flag.
1043  */
1044 int	if_nulloutput(struct ifnet *, struct mbuf *,
1045 	    const struct sockaddr *, const struct rtentry *);
1046 void	if_nullinput(struct ifnet *, struct mbuf *);
1047 void	if_nullstart(struct ifnet *);
1048 int	if_nulltransmit(struct ifnet *, struct mbuf *);
1049 int	if_nullioctl(struct ifnet *, u_long, void *);
1050 int	if_nullinit(struct ifnet *);
1051 void	if_nullstop(struct ifnet *, int);
1052 void	if_nullslowtimo(struct ifnet *);
1053 #define	if_nullwatchdog	if_nullslowtimo
1054 void	if_nulldrain(struct ifnet *);
1055 #else
1056 struct if_nameindex {
1057 	unsigned int	if_index;	/* 1, 2, ... */
1058 	char		*if_name;	/* null terminated name: "le0", ... */
1059 };
1060 
1061 #include <sys/cdefs.h>
1062 __BEGIN_DECLS
1063 unsigned int if_nametoindex(const char *);
1064 char *	if_indextoname(unsigned int, char *);
1065 struct	if_nameindex * if_nameindex(void);
1066 void	if_freenameindex(struct if_nameindex *);
1067 __END_DECLS
1068 #endif /* _KERNEL */ /* XXX really ALTQ? */
1069 
1070 #ifdef _KERNEL
1071 
1072 #define	IFADDR_FIRST(__ifp)		TAILQ_FIRST(&(__ifp)->if_addrlist)
1073 #define	IFADDR_NEXT(__ifa)		TAILQ_NEXT((__ifa), ifa_list)
1074 #define	IFADDR_FOREACH(__ifa, __ifp)	TAILQ_FOREACH(__ifa, \
1075 					    &(__ifp)->if_addrlist, ifa_list)
1076 #define	IFADDR_FOREACH_SAFE(__ifa, __ifp, __nifa) \
1077 					    TAILQ_FOREACH_SAFE(__ifa, \
1078 					    &(__ifp)->if_addrlist, ifa_list, __nifa)
1079 #define	IFADDR_EMPTY(__ifp)		TAILQ_EMPTY(&(__ifp)->if_addrlist)
1080 
1081 #define IFADDR_ENTRY_INIT(__ifa)					\
1082 	PSLIST_ENTRY_INIT((__ifa), ifa_pslist_entry)
1083 #define IFADDR_ENTRY_DESTROY(__ifa)					\
1084 	PSLIST_ENTRY_DESTROY((__ifa), ifa_pslist_entry)
1085 #define IFADDR_READER_EMPTY(__ifp)					\
1086 	(PSLIST_READER_FIRST(&(__ifp)->if_addr_pslist, struct ifaddr,	\
1087 	                     ifa_pslist_entry) == NULL)
1088 #define IFADDR_READER_FIRST(__ifp)					\
1089 	PSLIST_READER_FIRST(&(__ifp)->if_addr_pslist, struct ifaddr,	\
1090 	                    ifa_pslist_entry)
1091 #define IFADDR_READER_NEXT(__ifa)					\
1092 	PSLIST_READER_NEXT((__ifa), struct ifaddr, ifa_pslist_entry)
1093 #define IFADDR_READER_FOREACH(__ifa, __ifp)				\
1094 	PSLIST_READER_FOREACH((__ifa), &(__ifp)->if_addr_pslist, struct ifaddr,\
1095 	                      ifa_pslist_entry)
1096 #define IFADDR_WRITER_INSERT_HEAD(__ifp, __ifa)				\
1097 	PSLIST_WRITER_INSERT_HEAD(&(__ifp)->if_addr_pslist, (__ifa),	\
1098 	                          ifa_pslist_entry)
1099 #define IFADDR_WRITER_REMOVE(__ifa)					\
1100 	PSLIST_WRITER_REMOVE((__ifa), ifa_pslist_entry)
1101 #define IFADDR_WRITER_FOREACH(__ifa, __ifp)				\
1102 	PSLIST_WRITER_FOREACH((__ifa), &(__ifp)->if_addr_pslist, struct ifaddr,\
1103 	                      ifa_pslist_entry)
1104 #define IFADDR_WRITER_NEXT(__ifp)					\
1105 	PSLIST_WRITER_NEXT((__ifp), struct ifaddr, ifa_pslist_entry)
1106 #define IFADDR_WRITER_INSERT_AFTER(__ifp, __new)			\
1107 	PSLIST_WRITER_INSERT_AFTER((__ifp), (__new), ifa_pslist_entry)
1108 #define IFADDR_WRITER_EMPTY(__ifp)					\
1109 	(PSLIST_WRITER_FIRST(&(__ifp)->if_addr_pslist, struct ifaddr,	\
1110 	                     ifa_pslist_entry) == NULL)
1111 #define IFADDR_WRITER_INSERT_TAIL(__ifp, __new)				\
1112 	do {								\
1113 		if (IFADDR_WRITER_EMPTY((__ifp))) {			\
1114 			IFADDR_WRITER_INSERT_HEAD((__ifp), (__new));	\
1115 		} else {						\
1116 			struct ifaddr *__ifa;				\
1117 			IFADDR_WRITER_FOREACH(__ifa, (__ifp)) {		\
1118 				if (IFADDR_WRITER_NEXT(__ifa) == NULL) {\
1119 					IFADDR_WRITER_INSERT_AFTER(__ifa,\
1120 					    (__new));			\
1121 					break;				\
1122 				}					\
1123 			}						\
1124 		}							\
1125 	} while (0)
1126 
1127 #define	IFNET_LOCK()			mutex_enter(&ifnet_mtx)
1128 #define	IFNET_UNLOCK()			mutex_exit(&ifnet_mtx)
1129 #define	IFNET_LOCKED()			mutex_owned(&ifnet_mtx)
1130 
1131 #define IFNET_READER_EMPTY() \
1132 	(PSLIST_READER_FIRST(&ifnet_pslist, struct ifnet, if_pslist_entry) == NULL)
1133 #define IFNET_READER_FIRST() \
1134 	PSLIST_READER_FIRST(&ifnet_pslist, struct ifnet, if_pslist_entry)
1135 #define IFNET_READER_NEXT(__ifp) \
1136 	PSLIST_READER_NEXT((__ifp), struct ifnet, if_pslist_entry)
1137 #define IFNET_READER_FOREACH(__ifp) \
1138 	PSLIST_READER_FOREACH((__ifp), &ifnet_pslist, struct ifnet, \
1139 	                      if_pslist_entry)
1140 #define IFNET_WRITER_INSERT_HEAD(__ifp) \
1141 	PSLIST_WRITER_INSERT_HEAD(&ifnet_pslist, (__ifp), if_pslist_entry)
1142 #define IFNET_WRITER_REMOVE(__ifp) \
1143 	PSLIST_WRITER_REMOVE((__ifp), if_pslist_entry)
1144 #define IFNET_WRITER_FOREACH(__ifp) \
1145 	PSLIST_WRITER_FOREACH((__ifp), &ifnet_pslist, struct ifnet, \
1146 	                      if_pslist_entry)
1147 #define IFNET_WRITER_NEXT(__ifp) \
1148 	PSLIST_WRITER_NEXT((__ifp), struct ifnet, if_pslist_entry)
1149 #define IFNET_WRITER_INSERT_AFTER(__ifp, __new) \
1150 	PSLIST_WRITER_INSERT_AFTER((__ifp), (__new), if_pslist_entry)
1151 #define IFNET_WRITER_EMPTY() \
1152 	(PSLIST_WRITER_FIRST(&ifnet_pslist, struct ifnet, if_pslist_entry) == NULL)
1153 #define IFNET_WRITER_INSERT_TAIL(__new)					\
1154 	do {								\
1155 		if (IFNET_WRITER_EMPTY()) {				\
1156 			IFNET_WRITER_INSERT_HEAD((__new));		\
1157 		} else {						\
1158 			struct ifnet *__ifp;				\
1159 			IFNET_WRITER_FOREACH(__ifp) {			\
1160 				if (IFNET_WRITER_NEXT(__ifp) == NULL) {	\
1161 					IFNET_WRITER_INSERT_AFTER(__ifp,\
1162 					    (__new));			\
1163 					break;				\
1164 				}					\
1165 			}						\
1166 		}							\
1167 	} while (0)
1168 
1169 extern struct pslist_head ifnet_pslist;
1170 extern struct psref_class *ifnet_psref_class;
1171 extern kmutex_t ifnet_mtx;
1172 
1173 extern struct ifnet *lo0ifp;
1174 
1175 /*
1176  * ifq sysctl support
1177  */
1178 int	sysctl_ifq(int *name, u_int namelen, void *oldp,
1179 		       size_t *oldlenp, void *newp, size_t newlen,
1180 		       struct ifqueue *ifq);
1181 /* symbolic names for terminal (per-protocol) CTL_IFQ_ nodes */
1182 #define IFQCTL_LEN 1
1183 #define IFQCTL_MAXLEN 2
1184 #define IFQCTL_PEAK 3
1185 #define IFQCTL_DROPS 4
1186 #define IFQCTL_MAXID 5
1187 
1188 #endif /* _KERNEL */
1189 
1190 #ifdef _NETBSD_SOURCE
1191 /*
1192  * sysctl for ifq (per-protocol packet input queue variant of ifqueue)
1193  */
1194 #define CTL_IFQ_NAMES  { \
1195 	{ 0, 0 }, \
1196 	{ "len", CTLTYPE_INT }, \
1197 	{ "maxlen", CTLTYPE_INT }, \
1198 	{ "peak", CTLTYPE_INT }, \
1199 	{ "drops", CTLTYPE_INT }, \
1200 }
1201 #endif /* _NETBSD_SOURCE */
1202 #endif /* !_NET_IF_H_ */
1203