2 * Copyright (c) 1982, 1986, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * From: @(#)if.h 8.1 (Berkeley) 6/10/93
33 #ifndef _NET_IF_VAR_H_
34 #define _NET_IF_VAR_H_
37 * Structures defining a network interface, providing a packet
38 * transport mechanism (ala level 0 of the PUP protocols).
40 * Each interface accepts output datagrams of a specified maximum
41 * length, and provides higher level routines with input datagrams
42 * received from its medium.
44 * Output occurs when the routine if_output is called, with three parameters:
45 * (*ifp->if_output)(ifp, m, dst, rt)
46 * Here m is the mbuf chain to be sent and dst is the destination address.
47 * The output routine encapsulates the supplied datagram if necessary,
48 * and then transmits it on its medium.
50 * On input, each interface unwraps the data received by it, and either
51 * places it on the input queue of an internetwork datagram routine
52 * and posts the associated software interrupt, or passes the datagram to a raw
53 * packet input routine.
55 * Routines exist for locating interfaces by their addresses
56 * or for locating an interface on a certain network, as well as more general
57 * routing and gateway routines maintaining information used to locate
58 * interfaces. These routines live in the files if.c and route.c
61 struct rtentry; /* ifa_rtrequest */
62 struct rt_addrinfo; /* ifa_rtrequest */
67 struct route; /* if_output */
70 struct netmap_adapter;
73 #include <sys/mbuf.h> /* ifqueue only? */
74 #include <sys/buf_ring.h>
77 #include <sys/counter.h>
78 #include <sys/lock.h> /* XXX */
79 #include <sys/mutex.h> /* struct ifqueue */
80 #include <sys/rwlock.h> /* XXX */
81 #include <sys/sx.h> /* XXX */
82 #include <sys/_task.h> /* if_link_task */
84 #define IF_DUNIT_NONE -1
86 #include <net/altq/if_altq.h>
88 TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */
89 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */
90 TAILQ_HEAD(ifmultihead, ifmultiaddr);
91 TAILQ_HEAD(ifgrouphead, ifg_group);
94 VNET_DECLARE(struct pfil_head, link_pfil_hook); /* packet filter hooks */
95 #define V_link_pfil_hook VNET(link_pfil_hook)
97 #define HHOOK_IPSEC_INET 0
98 #define HHOOK_IPSEC_INET6 1
99 #define HHOOK_IPSEC_COUNT 2
100 VNET_DECLARE(struct hhook_head *, ipsec_hhh_in[HHOOK_IPSEC_COUNT]);
101 VNET_DECLARE(struct hhook_head *, ipsec_hhh_out[HHOOK_IPSEC_COUNT]);
102 #define V_ipsec_hhh_in VNET(ipsec_hhh_in)
103 #define V_ipsec_hhh_out VNET(ipsec_hhh_out)
107 IFCOUNTER_IPACKETS = 0,
111 IFCOUNTER_COLLISIONS,
119 IFCOUNTERS /* Array size. */
122 typedef struct ifnet * if_t;
124 typedef void (*if_start_fn_t)(if_t);
125 typedef int (*if_ioctl_fn_t)(if_t, u_long, caddr_t);
126 typedef void (*if_init_fn_t)(void *);
127 typedef void (*if_qflush_fn_t)(if_t);
128 typedef int (*if_transmit_fn_t)(if_t, struct mbuf *);
129 typedef uint64_t (*if_get_counter_t)(if_t, ift_counter);
131 struct ifnet_hw_tsomax {
132 u_int tsomaxbytes; /* TSO total burst length limit in bytes */
133 u_int tsomaxsegcount; /* TSO maximum segment count */
134 u_int tsomaxsegsize; /* TSO maximum segment size in bytes */
137 /* Interface encap request types */
139 IFENCAP_LL = 1 /* pre-calculate link-layer header */
143 * The structure below allows to request various pre-calculated L2/L3 headers
144 * for different media. Requests varies by type (rtype field).
146 * IFENCAP_LL type: pre-calculates link header based on address family
147 * and destination lladdr.
150 * buf: pointer to destination buffer
151 * bufsize: buffer size
152 * flags: IFENCAP_FLAG_BROADCAST if destination is broadcast
153 * family: address family defined by AF_ constant.
154 * lladdr: pointer to link-layer address
155 * lladdr_len: length of link-layer address
156 * hdata: pointer to L3 header (optional, used for ARP requests).
157 * Output data fields:
158 * buf: encap data is stored here
159 * bufsize: resulting encap length is stored here
160 * lladdr_off: offset of link-layer address from encap hdr start
161 * hdata: L3 header may be altered if necessary
164 struct if_encap_req {
165 u_char *buf; /* Destination buffer (w) */
166 size_t bufsize; /* size of provided buffer (r) */
167 ife_type rtype; /* request type (r) */
168 uint32_t flags; /* Request flags (r) */
169 int family; /* Address family AF_* (r) */
170 int lladdr_off; /* offset from header start (w) */
171 int lladdr_len; /* lladdr length (r) */
172 char *lladdr; /* link-level address pointer (r) */
173 char *hdata; /* Upper layer header data (rw) */
176 #define IFENCAP_FLAG_BROADCAST 0x02 /* Destination is broadcast */
179 * Network interface send tag support. The storage of "struct
180 * m_snd_tag" comes from the network driver and it is free to allocate
181 * as much additional space as it wants for its own use.
185 #define IF_SND_TAG_TYPE_RATE_LIMIT 0
186 #define IF_SND_TAG_TYPE_UNLIMITED 1
187 #define IF_SND_TAG_TYPE_MAX 2
189 struct if_snd_tag_alloc_header {
190 uint32_t type; /* send tag type, see IF_SND_TAG_XXX */
191 uint32_t flowid; /* mbuf hash value */
192 uint32_t flowtype; /* mbuf hash type */
195 struct if_snd_tag_alloc_rate_limit {
196 struct if_snd_tag_alloc_header hdr;
197 uint64_t max_rate; /* in bytes/s */
200 struct if_snd_tag_rate_limit_params {
201 uint64_t max_rate; /* in bytes/s */
202 uint32_t queue_level; /* 0 (empty) .. 65535 (full) */
203 #define IF_SND_QUEUE_LEVEL_MIN 0
204 #define IF_SND_QUEUE_LEVEL_MAX 65535
205 uint32_t reserved; /* padding */
208 union if_snd_tag_alloc_params {
209 struct if_snd_tag_alloc_header hdr;
210 struct if_snd_tag_alloc_rate_limit rate_limit;
211 struct if_snd_tag_alloc_rate_limit unlimited;
214 union if_snd_tag_modify_params {
215 struct if_snd_tag_rate_limit_params rate_limit;
216 struct if_snd_tag_rate_limit_params unlimited;
219 union if_snd_tag_query_params {
220 struct if_snd_tag_rate_limit_params rate_limit;
221 struct if_snd_tag_rate_limit_params unlimited;
224 typedef int (if_snd_tag_alloc_t)(struct ifnet *, union if_snd_tag_alloc_params *,
225 struct m_snd_tag **);
226 typedef int (if_snd_tag_modify_t)(struct m_snd_tag *, union if_snd_tag_modify_params *);
227 typedef int (if_snd_tag_query_t)(struct m_snd_tag *, union if_snd_tag_query_params *);
228 typedef void (if_snd_tag_free_t)(struct m_snd_tag *);
231 * Structure defining a network interface.
234 /* General book keeping of interface lists. */
235 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */
236 LIST_ENTRY(ifnet) if_clones; /* interfaces of a cloner */
237 TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
238 /* protected by if_addr_lock */
239 u_char if_alloctype; /* if_type at time of allocation */
241 /* Driver and protocol specific information that remains stable. */
242 void *if_softc; /* pointer to driver state */
243 void *if_llsoftc; /* link layer softc */
244 void *if_l2com; /* pointer to protocol bits */
245 const char *if_dname; /* driver name */
246 int if_dunit; /* unit or IF_DUNIT_NONE */
247 u_short if_index; /* numeric abbreviation for this if */
248 short if_index_reserved; /* spare space to grow if_index */
249 char if_xname[IFNAMSIZ]; /* external name (name + unit) */
250 char *if_description; /* interface description */
252 /* Variable fields that are touched by the stack and drivers. */
253 int if_flags; /* up/down, broadcast, etc. */
254 int if_drv_flags; /* driver-managed status flags */
255 int if_capabilities; /* interface features & capabilities */
256 int if_capenable; /* enabled features & capabilities */
257 void *if_linkmib; /* link-type-specific MIB data */
258 size_t if_linkmiblen; /* length of above data */
259 u_int if_refcount; /* reference count */
261 /* These fields are shared with struct if_data. */
262 uint8_t if_type; /* ethernet, tokenring, etc */
263 uint8_t if_addrlen; /* media address length */
264 uint8_t if_hdrlen; /* media header length */
265 uint8_t if_link_state; /* current link state */
266 uint32_t if_mtu; /* maximum transmission unit */
267 uint32_t if_metric; /* routing metric (external only) */
268 uint64_t if_baudrate; /* linespeed */
269 uint64_t if_hwassist; /* HW offload capabilities, see IFCAP */
270 time_t if_epoch; /* uptime at attach or stat reset */
271 struct timeval if_lastchange; /* time of last administrative change */
273 struct ifaltq if_snd; /* output queue (includes altq) */
274 struct task if_linktask; /* task for link change events */
276 /* Addresses of different protocol families assigned to this if. */
277 struct rwlock if_addr_lock; /* lock to protect address lists */
279 * if_addrhead is the list of all addresses associated to
281 * Some code in the kernel assumes that first element
282 * of the list has type AF_LINK, and contains sockaddr_dl
283 * addresses which store the link-level address and the name
285 * However, access to the AF_LINK address through this
286 * field is deprecated. Use if_addr or ifaddr_byindex() instead.
288 struct ifaddrhead if_addrhead; /* linked list of addresses per if */
289 struct ifmultihead if_multiaddrs; /* multicast addresses configured */
290 int if_amcount; /* number of all-multicast requests */
291 struct ifaddr *if_addr; /* pointer to link-level address */
292 void *if_hw_addr; /* hardware link-level address */
293 const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
294 struct rwlock if_afdata_lock;
295 void *if_afdata[AF_MAX];
296 int if_afdata_initialized;
298 /* Additional features hung off the interface. */
299 u_int if_fib; /* interface FIB */
300 struct vnet *if_vnet; /* pointer to network stack instance */
301 struct vnet *if_home_vnet; /* where this ifnet originates from */
302 struct ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */
303 struct bpf_if *if_bpf; /* packet filter structure */
304 int if_pcount; /* number of promiscuous listeners */
305 void *if_bridge; /* bridge glue */
306 void *if_lagg; /* lagg glue */
307 void *if_pf_kif; /* pf glue */
308 struct carp_if *if_carp; /* carp interface structure */
309 struct label *if_label; /* interface MAC label */
310 struct netmap_adapter *if_netmap; /* netmap(4) softc */
312 /* Various procedures of the layer2 encapsulation and drivers. */
313 int (*if_output) /* output routine (enqueue) */
314 (struct ifnet *, struct mbuf *, const struct sockaddr *,
316 void (*if_input) /* input routine (from h/w driver) */
317 (struct ifnet *, struct mbuf *);
318 if_start_fn_t if_start; /* initiate output routine */
319 if_ioctl_fn_t if_ioctl; /* ioctl routine */
320 if_init_fn_t if_init; /* Init routine */
321 int (*if_resolvemulti) /* validate/resolve multicast */
322 (struct ifnet *, struct sockaddr **, struct sockaddr *);
323 if_qflush_fn_t if_qflush; /* flush any queue */
324 if_transmit_fn_t if_transmit; /* initiate output routine */
326 void (*if_reassign) /* reassign to vnet routine */
327 (struct ifnet *, struct vnet *, char *);
328 if_get_counter_t if_get_counter; /* get counter values */
329 int (*if_requestencap) /* make link header from request */
330 (struct ifnet *, struct if_encap_req *);
333 counter_u64_t if_counters[IFCOUNTERS];
335 /* Stuff that's only temporary and doesn't belong here. */
338 * Network adapter TSO limits:
339 * ===========================
341 * If the "if_hw_tsomax" field is zero the maximum segment
342 * length limit does not apply. If the "if_hw_tsomaxsegcount"
343 * or the "if_hw_tsomaxsegsize" field is zero the TSO segment
344 * count limit does not apply. If all three fields are zero,
345 * there is no TSO limit.
347 * NOTE: The TSO limits should reflect the values used in the
348 * BUSDMA tag a network adapter is using to load a mbuf chain
349 * for transmission. The TCP/IP network stack will subtract
350 * space for all linklevel and protocol level headers and
351 * ensure that the full mbuf chain passed to the network
352 * adapter fits within the given limits.
354 u_int if_hw_tsomax; /* TSO maximum size in bytes */
355 u_int if_hw_tsomaxsegcount; /* TSO maximum segment count */
356 u_int if_hw_tsomaxsegsize; /* TSO maximum segment size in bytes */
359 * Network adapter send tag support:
361 if_snd_tag_alloc_t *if_snd_tag_alloc;
362 if_snd_tag_modify_t *if_snd_tag_modify;
363 if_snd_tag_query_t *if_snd_tag_query;
364 if_snd_tag_free_t *if_snd_tag_free;
367 * Spare fields to be added before branching a stable branch, so
368 * that structure can be enhanced without changing the kernel
371 int if_ispare[4]; /* general use */
374 /* for compatibility with other BSDs */
375 #define if_name(ifp) ((ifp)->if_xname)
378 * Locks for address lists on the network interface.
380 #define IF_ADDR_LOCK_INIT(if) rw_init(&(if)->if_addr_lock, "if_addr_lock")
381 #define IF_ADDR_LOCK_DESTROY(if) rw_destroy(&(if)->if_addr_lock)
382 #define IF_ADDR_WLOCK(if) rw_wlock(&(if)->if_addr_lock)
383 #define IF_ADDR_WUNLOCK(if) rw_wunlock(&(if)->if_addr_lock)
384 #define IF_ADDR_RLOCK(if) rw_rlock(&(if)->if_addr_lock)
385 #define IF_ADDR_RUNLOCK(if) rw_runlock(&(if)->if_addr_lock)
386 #define IF_ADDR_LOCK_ASSERT(if) rw_assert(&(if)->if_addr_lock, RA_LOCKED)
387 #define IF_ADDR_WLOCK_ASSERT(if) rw_assert(&(if)->if_addr_lock, RA_WLOCKED)
390 * Function variations on locking macros intended to be used by loadable
391 * kernel modules in order to divorce them from the internals of address list
394 void if_addr_rlock(struct ifnet *ifp); /* if_addrhead */
395 void if_addr_runlock(struct ifnet *ifp); /* if_addrhead */
396 void if_maddr_rlock(if_t ifp); /* if_multiaddrs */
397 void if_maddr_runlock(if_t ifp); /* if_multiaddrs */
400 #ifdef _SYS_EVENTHANDLER_H_
401 /* interface link layer address change event */
402 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
403 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
404 /* interface address change event */
405 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
406 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
407 /* new interface arrival event */
408 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
409 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
410 /* interface departure event */
411 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
412 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
413 /* Interface link state change event */
414 typedef void (*ifnet_link_event_handler_t)(void *, struct ifnet *, int);
415 EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t);
416 /* Interface up/down event */
417 #define IFNET_EVENT_UP 0
418 #define IFNET_EVENT_DOWN 1
419 typedef void (*ifnet_event_fn)(void *, struct ifnet *ifp, int event);
420 EVENTHANDLER_DECLARE(ifnet_event, ifnet_event_fn);
421 #endif /* _SYS_EVENTHANDLER_H_ */
427 char ifg_group[IFNAMSIZ];
430 TAILQ_HEAD(, ifg_member) ifg_members;
431 TAILQ_ENTRY(ifg_group) ifg_next;
435 TAILQ_ENTRY(ifg_member) ifgm_next;
436 struct ifnet *ifgm_ifp;
440 struct ifg_group *ifgl_group;
441 TAILQ_ENTRY(ifg_list) ifgl_next;
444 #ifdef _SYS_EVENTHANDLER_H_
445 /* group attach event */
446 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
447 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
448 /* group detach event */
449 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
450 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
451 /* group change event */
452 typedef void (*group_change_event_handler_t)(void *, const char *);
453 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
454 #endif /* _SYS_EVENTHANDLER_H_ */
456 #define IF_AFDATA_LOCK_INIT(ifp) \
457 rw_init(&(ifp)->if_afdata_lock, "if_afdata")
459 #define IF_AFDATA_WLOCK(ifp) rw_wlock(&(ifp)->if_afdata_lock)
460 #define IF_AFDATA_RLOCK(ifp) rw_rlock(&(ifp)->if_afdata_lock)
461 #define IF_AFDATA_WUNLOCK(ifp) rw_wunlock(&(ifp)->if_afdata_lock)
462 #define IF_AFDATA_RUNLOCK(ifp) rw_runlock(&(ifp)->if_afdata_lock)
463 #define IF_AFDATA_LOCK(ifp) IF_AFDATA_WLOCK(ifp)
464 #define IF_AFDATA_UNLOCK(ifp) IF_AFDATA_WUNLOCK(ifp)
465 #define IF_AFDATA_TRYLOCK(ifp) rw_try_wlock(&(ifp)->if_afdata_lock)
466 #define IF_AFDATA_DESTROY(ifp) rw_destroy(&(ifp)->if_afdata_lock)
468 #define IF_AFDATA_LOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_LOCKED)
469 #define IF_AFDATA_RLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_RLOCKED)
470 #define IF_AFDATA_WLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_WLOCKED)
471 #define IF_AFDATA_UNLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_UNLOCKED)
474 * 72 was chosen below because it is the size of a TCP/IP
475 * header (40) + the minimum mss (32).
478 #define IF_MAXMTU 65535
480 #define TOEDEV(ifp) ((ifp)->if_llsoftc)
483 * The ifaddr structure contains information about one address
484 * of an interface. They are maintained by the different address families,
485 * are allocated and attached when an address is set, and are linked
486 * together so all addresses for an interface can be located.
488 * NOTE: a 'struct ifaddr' is always at the beginning of a larger
489 * chunk of malloc'ed memory, where we store the three addresses
490 * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
493 struct sockaddr *ifa_addr; /* address of interface */
494 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
495 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
496 struct sockaddr *ifa_netmask; /* used to determine subnet */
497 struct ifnet *ifa_ifp; /* back-pointer to interface */
498 struct carp_softc *ifa_carp; /* pointer to CARP data */
499 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */
500 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
501 (int, struct rtentry *, struct rt_addrinfo *);
502 u_short ifa_flags; /* mostly rt_flags for cloning */
503 #define IFA_ROUTE RTF_UP /* route installed */
504 #define IFA_RTSELF RTF_HOST /* loopback route to self installed */
505 u_int ifa_refcnt; /* references to this structure */
507 counter_u64_t ifa_ipackets;
508 counter_u64_t ifa_opackets;
509 counter_u64_t ifa_ibytes;
510 counter_u64_t ifa_obytes;
513 struct ifaddr * ifa_alloc(size_t size, int flags);
514 void ifa_free(struct ifaddr *ifa);
515 void ifa_ref(struct ifaddr *ifa);
518 * Multicast address structure. This is analogous to the ifaddr
519 * structure except that it keeps track of multicast addresses.
522 TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
523 struct sockaddr *ifma_addr; /* address this membership is for */
524 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
525 struct ifnet *ifma_ifp; /* back-pointer to interface */
526 u_int ifma_refcount; /* reference count */
527 void *ifma_protospec; /* protocol-specific state, if any */
528 struct ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
531 extern struct rwlock ifnet_rwlock;
532 extern struct sx ifnet_sxlock;
534 #define IFNET_WLOCK() do { \
535 sx_xlock(&ifnet_sxlock); \
536 rw_wlock(&ifnet_rwlock); \
539 #define IFNET_WUNLOCK() do { \
540 rw_wunlock(&ifnet_rwlock); \
541 sx_xunlock(&ifnet_sxlock); \
545 * To assert the ifnet lock, you must know not only whether it's for read or
546 * write, but also whether it was acquired with sleep support or not.
548 #define IFNET_RLOCK_ASSERT() sx_assert(&ifnet_sxlock, SA_SLOCKED)
549 #define IFNET_RLOCK_NOSLEEP_ASSERT() rw_assert(&ifnet_rwlock, RA_RLOCKED)
550 #define IFNET_WLOCK_ASSERT() do { \
551 sx_assert(&ifnet_sxlock, SA_XLOCKED); \
552 rw_assert(&ifnet_rwlock, RA_WLOCKED); \
555 #define IFNET_RLOCK() sx_slock(&ifnet_sxlock)
556 #define IFNET_RLOCK_NOSLEEP() rw_rlock(&ifnet_rwlock)
557 #define IFNET_RUNLOCK() sx_sunlock(&ifnet_sxlock)
558 #define IFNET_RUNLOCK_NOSLEEP() rw_runlock(&ifnet_rwlock)
561 * Look up an ifnet given its index; the _ref variant also acquires a
562 * reference that must be freed using if_rele(). It is almost always a bug
563 * to call ifnet_byindex() instead of ifnet_byindex_ref().
565 struct ifnet *ifnet_byindex(u_short idx);
566 struct ifnet *ifnet_byindex_locked(u_short idx);
567 struct ifnet *ifnet_byindex_ref(u_short idx);
570 * Given the index, ifaddr_byindex() returns the one and only
571 * link-level ifaddr for the interface. You are not supposed to use
572 * it to traverse the list of addresses associated to the interface.
574 struct ifaddr *ifaddr_byindex(u_short idx);
576 VNET_DECLARE(struct ifnethead, ifnet);
577 VNET_DECLARE(struct ifgrouphead, ifg_head);
578 VNET_DECLARE(int, if_index);
579 VNET_DECLARE(struct ifnet *, loif); /* first loopback interface */
581 #define V_ifnet VNET(ifnet)
582 #define V_ifg_head VNET(ifg_head)
583 #define V_if_index VNET(if_index)
584 #define V_loif VNET(loif)
586 int if_addgroup(struct ifnet *, const char *);
587 int if_delgroup(struct ifnet *, const char *);
588 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
589 int if_allmulti(struct ifnet *, int);
590 struct ifnet* if_alloc(u_char);
591 void if_attach(struct ifnet *);
592 void if_dead(struct ifnet *);
593 int if_delmulti(struct ifnet *, struct sockaddr *);
594 void if_delmulti_ifma(struct ifmultiaddr *);
595 void if_detach(struct ifnet *);
596 void if_purgeaddrs(struct ifnet *);
597 void if_delallmulti(struct ifnet *);
598 void if_down(struct ifnet *);
600 if_findmulti(struct ifnet *, const struct sockaddr *);
601 void if_free(struct ifnet *);
602 void if_initname(struct ifnet *, const char *, int);
603 void if_link_state_change(struct ifnet *, int);
604 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
605 void if_ref(struct ifnet *);
606 void if_rele(struct ifnet *);
607 int if_setlladdr(struct ifnet *, const u_char *, int);
608 void if_up(struct ifnet *);
609 int ifioctl(struct socket *, u_long, caddr_t, struct thread *);
610 int ifpromisc(struct ifnet *, int);
611 struct ifnet *ifunit(const char *);
612 struct ifnet *ifunit_ref(const char *);
614 int ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
615 int ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
616 int ifa_switch_loopback_route(struct ifaddr *, struct sockaddr *);
618 struct ifaddr *ifa_ifwithaddr(const struct sockaddr *);
619 int ifa_ifwithaddr_check(const struct sockaddr *);
620 struct ifaddr *ifa_ifwithbroadaddr(const struct sockaddr *, int);
621 struct ifaddr *ifa_ifwithdstaddr(const struct sockaddr *, int);
622 struct ifaddr *ifa_ifwithnet(const struct sockaddr *, int, int);
623 struct ifaddr *ifa_ifwithroute(int, const struct sockaddr *, struct sockaddr *,
625 struct ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *);
626 int ifa_preferred(struct ifaddr *, struct ifaddr *);
628 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
630 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
631 typedef void if_com_free_t(void *com, u_char type);
632 void if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
633 void if_deregister_com_alloc(u_char type);
634 void if_data_copy(struct ifnet *, struct if_data *);
635 uint64_t if_get_counter_default(struct ifnet *, ift_counter);
636 void if_inc_counter(struct ifnet *, ift_counter, int64_t);
638 #define IF_LLADDR(ifp) \
639 LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr))
641 uint64_t if_setbaudrate(if_t ifp, uint64_t baudrate);
642 uint64_t if_getbaudrate(if_t ifp);
643 int if_setcapabilities(if_t ifp, int capabilities);
644 int if_setcapabilitiesbit(if_t ifp, int setbit, int clearbit);
645 int if_getcapabilities(if_t ifp);
646 int if_togglecapenable(if_t ifp, int togglecap);
647 int if_setcapenable(if_t ifp, int capenable);
648 int if_setcapenablebit(if_t ifp, int setcap, int clearcap);
649 int if_getcapenable(if_t ifp);
650 const char *if_getdname(if_t ifp);
651 int if_setdev(if_t ifp, void *dev);
652 int if_setdrvflagbits(if_t ifp, int if_setflags, int clear_flags);
653 int if_getdrvflags(if_t ifp);
654 int if_setdrvflags(if_t ifp, int flags);
655 int if_clearhwassist(if_t ifp);
656 int if_sethwassistbits(if_t ifp, int toset, int toclear);
657 int if_sethwassist(if_t ifp, int hwassist_bit);
658 int if_gethwassist(if_t ifp);
659 int if_setsoftc(if_t ifp, void *softc);
660 void *if_getsoftc(if_t ifp);
661 int if_setflags(if_t ifp, int flags);
662 int if_gethwaddr(if_t ifp, struct ifreq *);
663 int if_setmtu(if_t ifp, int mtu);
664 int if_getmtu(if_t ifp);
665 int if_getmtu_family(if_t ifp, int family);
666 int if_setflagbits(if_t ifp, int set, int clear);
667 int if_getflags(if_t ifp);
668 int if_sendq_empty(if_t ifp);
669 int if_setsendqready(if_t ifp);
670 int if_setsendqlen(if_t ifp, int tx_desc_count);
671 int if_sethwtsomax(if_t ifp, u_int if_hw_tsomax);
672 int if_sethwtsomaxsegcount(if_t ifp, u_int if_hw_tsomaxsegcount);
673 int if_sethwtsomaxsegsize(if_t ifp, u_int if_hw_tsomaxsegsize);
674 u_int if_gethwtsomax(if_t ifp);
675 u_int if_gethwtsomaxsegcount(if_t ifp);
676 u_int if_gethwtsomaxsegsize(if_t ifp);
677 int if_input(if_t ifp, struct mbuf* sendmp);
678 int if_sendq_prepend(if_t ifp, struct mbuf *m);
679 struct mbuf *if_dequeue(if_t ifp);
680 int if_setifheaderlen(if_t ifp, int len);
681 void if_setrcvif(struct mbuf *m, if_t ifp);
682 void if_setvtag(struct mbuf *m, u_int16_t tag);
683 u_int16_t if_getvtag(struct mbuf *m);
684 int if_vlantrunkinuse(if_t ifp);
685 caddr_t if_getlladdr(if_t ifp);
686 void *if_gethandle(u_char);
687 void if_bpfmtap(if_t ifp, struct mbuf *m);
688 void if_etherbpfmtap(if_t ifp, struct mbuf *m);
689 void if_vlancap(if_t ifp);
691 int if_setupmultiaddr(if_t ifp, void *mta, int *cnt, int max);
692 int if_multiaddr_array(if_t ifp, void *mta, int *cnt, int max);
693 int if_multiaddr_count(if_t ifp, int max);
695 int if_multi_apply(struct ifnet *ifp, int (*filter)(void *, struct ifmultiaddr *, int), void *arg);
696 int if_getamcount(if_t ifp);
697 struct ifaddr * if_getifaddr(if_t ifp);
700 void if_setinitfn(if_t ifp, void (*)(void *));
701 void if_setioctlfn(if_t ifp, int (*)(if_t, u_long, caddr_t));
702 void if_setstartfn(if_t ifp, void (*)(if_t));
703 void if_settransmitfn(if_t ifp, if_transmit_fn_t);
704 void if_setqflushfn(if_t ifp, if_qflush_fn_t);
705 void if_setgetcounterfn(if_t ifp, if_get_counter_t);
707 /* Revisit the below. These are inline functions originally */
708 int drbr_inuse_drv(if_t ifp, struct buf_ring *br);
709 struct mbuf* drbr_dequeue_drv(if_t ifp, struct buf_ring *br);
710 int drbr_needs_enqueue_drv(if_t ifp, struct buf_ring *br);
711 int drbr_enqueue_drv(if_t ifp, struct buf_ring *br, struct mbuf *m);
714 void if_hw_tsomax_common(if_t ifp, struct ifnet_hw_tsomax *);
715 int if_hw_tsomax_update(if_t ifp, struct ifnet_hw_tsomax *);
717 #ifdef DEVICE_POLLING
718 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS };
720 typedef int poll_handler_t(if_t ifp, enum poll_cmd cmd, int count);
721 int ether_poll_register(poll_handler_t *h, if_t ifp);
722 int ether_poll_deregister(if_t ifp);
723 #endif /* DEVICE_POLLING */
727 #include <net/ifq.h> /* XXXAO: temporary unconditional include */
729 #endif /* !_NET_IF_VAR_H_ */