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