2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1982, 1986, 1989, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * From: @(#)if.h 8.1 (Berkeley) 6/10/93
35 #ifndef _NET_IF_VAR_H_
36 #define _NET_IF_VAR_H_
39 * Structures defining a network interface, providing a packet
40 * transport mechanism (ala level 0 of the PUP protocols).
42 * Each interface accepts output datagrams of a specified maximum
43 * length, and provides higher level routines with input datagrams
44 * received from its medium.
46 * Output occurs when the routine if_output is called, with three parameters:
47 * (*ifp->if_output)(ifp, m, dst, ro)
48 * Here m is the mbuf chain to be sent and dst is the destination address.
49 * The output routine encapsulates the supplied datagram if necessary,
50 * and then transmits it on its medium.
52 * On input, each interface unwraps the data received by it, and either
53 * places it on the input queue of an internetwork datagram routine
54 * and posts the associated software interrupt, or passes the datagram to a raw
55 * packet input routine.
57 * Routines exist for locating interfaces by their addresses
58 * or for locating an interface on a certain network, as well as more general
59 * routing and gateway routines maintaining information used to locate
60 * interfaces. These routines live in the files if.c and route.c
63 struct rtentry; /* ifa_rtrequest */
64 struct nhop_object; /* ifa_rtrequest */
65 struct rt_addrinfo; /* ifa_rtrequest */
70 struct route; /* if_output */
73 struct netmap_adapter;
74 struct debugnet_methods;
77 #include <sys/_eventhandler.h>
78 #include <sys/mbuf.h> /* ifqueue only? */
79 #include <sys/buf_ring.h>
83 #include <sys/counter.h>
84 #include <sys/epoch.h>
85 #include <sys/lock.h> /* XXX */
86 #include <sys/mutex.h> /* struct ifqueue */
87 #include <sys/rwlock.h> /* XXX */
88 #include <sys/sx.h> /* XXX */
89 #include <sys/_task.h> /* if_link_task */
90 #define IF_DUNIT_NONE -1
92 #include <net/altq/if_altq.h>
94 CK_STAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */
95 CK_STAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */
96 CK_STAILQ_HEAD(ifmultihead, ifmultiaddr);
97 CK_STAILQ_HEAD(ifgrouphead, ifg_group);
100 VNET_DECLARE(struct pfil_head *, link_pfil_head);
101 #define V_link_pfil_head VNET(link_pfil_head)
102 #define PFIL_ETHER_NAME "ethernet"
104 #define HHOOK_IPSEC_INET 0
105 #define HHOOK_IPSEC_INET6 1
106 #define HHOOK_IPSEC_COUNT 2
107 VNET_DECLARE(struct hhook_head *, ipsec_hhh_in[HHOOK_IPSEC_COUNT]);
108 VNET_DECLARE(struct hhook_head *, ipsec_hhh_out[HHOOK_IPSEC_COUNT]);
109 #define V_ipsec_hhh_in VNET(ipsec_hhh_in)
110 #define V_ipsec_hhh_out VNET(ipsec_hhh_out)
114 IFCOUNTER_IPACKETS = 0,
118 IFCOUNTER_COLLISIONS,
126 IFCOUNTERS /* Array size. */
129 typedef struct ifnet * if_t;
131 typedef void (*if_start_fn_t)(if_t);
132 typedef int (*if_ioctl_fn_t)(if_t, u_long, caddr_t);
133 typedef void (*if_init_fn_t)(void *);
134 typedef void (*if_qflush_fn_t)(if_t);
135 typedef int (*if_transmit_fn_t)(if_t, struct mbuf *);
136 typedef uint64_t (*if_get_counter_t)(if_t, ift_counter);
138 struct ifnet_hw_tsomax {
139 u_int tsomaxbytes; /* TSO total burst length limit in bytes */
140 u_int tsomaxsegcount; /* TSO maximum segment count */
141 u_int tsomaxsegsize; /* TSO maximum segment size in bytes */
144 /* Interface encap request types */
146 IFENCAP_LL = 1 /* pre-calculate link-layer header */
150 * The structure below allows to request various pre-calculated L2/L3 headers
151 * for different media. Requests varies by type (rtype field).
153 * IFENCAP_LL type: pre-calculates link header based on address family
154 * and destination lladdr.
157 * buf: pointer to destination buffer
158 * bufsize: buffer size
159 * flags: IFENCAP_FLAG_BROADCAST if destination is broadcast
160 * family: address family defined by AF_ constant.
161 * lladdr: pointer to link-layer address
162 * lladdr_len: length of link-layer address
163 * hdata: pointer to L3 header (optional, used for ARP requests).
164 * Output data fields:
165 * buf: encap data is stored here
166 * bufsize: resulting encap length is stored here
167 * lladdr_off: offset of link-layer address from encap hdr start
168 * hdata: L3 header may be altered if necessary
171 struct if_encap_req {
172 u_char *buf; /* Destination buffer (w) */
173 size_t bufsize; /* size of provided buffer (r) */
174 ife_type rtype; /* request type (r) */
175 uint32_t flags; /* Request flags (r) */
176 int family; /* Address family AF_* (r) */
177 int lladdr_off; /* offset from header start (w) */
178 int lladdr_len; /* lladdr length (r) */
179 char *lladdr; /* link-level address pointer (r) */
180 char *hdata; /* Upper layer header data (rw) */
183 #define IFENCAP_FLAG_BROADCAST 0x02 /* Destination is broadcast */
186 * Network interface send tag support. The storage of "struct
187 * m_snd_tag" comes from the network driver and it is free to allocate
188 * as much additional space as it wants for its own use.
193 #define IF_SND_TAG_TYPE_RATE_LIMIT 0
194 #define IF_SND_TAG_TYPE_UNLIMITED 1
195 #define IF_SND_TAG_TYPE_TLS 2
196 #define IF_SND_TAG_TYPE_MAX 3
198 struct if_snd_tag_alloc_header {
199 uint32_t type; /* send tag type, see IF_SND_TAG_XXX */
200 uint32_t flowid; /* mbuf hash value */
201 uint32_t flowtype; /* mbuf hash type */
202 uint8_t numa_domain; /* numa domain of associated inp */
205 struct if_snd_tag_alloc_rate_limit {
206 struct if_snd_tag_alloc_header hdr;
207 uint64_t max_rate; /* in bytes/s */
208 uint32_t flags; /* M_NOWAIT or M_WAITOK */
209 uint32_t reserved; /* alignment */
212 struct if_snd_tag_alloc_tls {
213 struct if_snd_tag_alloc_header hdr;
215 const struct ktls_session *tls;
218 struct if_snd_tag_rate_limit_params {
219 uint64_t max_rate; /* in bytes/s */
220 uint32_t queue_level; /* 0 (empty) .. 65535 (full) */
221 #define IF_SND_QUEUE_LEVEL_MIN 0
222 #define IF_SND_QUEUE_LEVEL_MAX 65535
223 uint32_t flags; /* M_NOWAIT or M_WAITOK */
226 union if_snd_tag_alloc_params {
227 struct if_snd_tag_alloc_header hdr;
228 struct if_snd_tag_alloc_rate_limit rate_limit;
229 struct if_snd_tag_alloc_rate_limit unlimited;
230 struct if_snd_tag_alloc_tls tls;
233 union if_snd_tag_modify_params {
234 struct if_snd_tag_rate_limit_params rate_limit;
235 struct if_snd_tag_rate_limit_params unlimited;
238 union if_snd_tag_query_params {
239 struct if_snd_tag_rate_limit_params rate_limit;
240 struct if_snd_tag_rate_limit_params unlimited;
243 /* Query return flags */
244 #define RT_NOSUPPORT 0x00000000 /* Not supported */
245 #define RT_IS_INDIRECT 0x00000001 /*
246 * Interface like a lagg, select
247 * the actual interface for
250 #define RT_IS_SELECTABLE 0x00000002 /*
251 * No rate table, you select
252 * rates and the first
253 * number_of_rates are created.
255 #define RT_IS_FIXED_TABLE 0x00000004 /* A fixed table is attached */
256 #define RT_IS_UNUSABLE 0x00000008 /* It is not usable for this */
257 #define RT_IS_SETUP_REQ 0x00000010 /* The interface setup must be called before use */
259 struct if_ratelimit_query_results {
260 const uint64_t *rate_table; /* Pointer to table if present */
261 uint32_t flags; /* Flags indicating results */
262 uint32_t max_flows; /* Max flows using, 0=unlimited */
263 uint32_t number_of_rates; /* How many unique rates can be created */
264 uint32_t min_segment_burst; /* The amount the adapter bursts at each send */
267 typedef int (if_snd_tag_alloc_t)(struct ifnet *, union if_snd_tag_alloc_params *,
268 struct m_snd_tag **);
269 typedef int (if_snd_tag_modify_t)(struct m_snd_tag *, union if_snd_tag_modify_params *);
270 typedef int (if_snd_tag_query_t)(struct m_snd_tag *, union if_snd_tag_query_params *);
271 typedef void (if_snd_tag_free_t)(struct m_snd_tag *);
272 typedef void (if_ratelimit_query_t)(struct ifnet *,
273 struct if_ratelimit_query_results *);
274 typedef int (if_ratelimit_setup_t)(struct ifnet *, uint64_t, uint32_t);
277 * Structure defining a network interface.
280 /* General book keeping of interface lists. */
281 CK_STAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained (CK_) */
282 LIST_ENTRY(ifnet) if_clones; /* interfaces of a cloner */
283 CK_STAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if (CK_) */
284 /* protected by if_addr_lock */
285 u_char if_alloctype; /* if_type at time of allocation */
286 uint8_t if_numa_domain; /* NUMA domain of device */
287 /* Driver and protocol specific information that remains stable. */
288 void *if_softc; /* pointer to driver state */
289 void *if_llsoftc; /* link layer softc */
290 void *if_l2com; /* pointer to protocol bits */
291 const char *if_dname; /* driver name */
292 int if_dunit; /* unit or IF_DUNIT_NONE */
293 u_short if_index; /* numeric abbreviation for this if */
294 short if_index_reserved; /* spare space to grow if_index */
295 char if_xname[IFNAMSIZ]; /* external name (name + unit) */
296 char *if_description; /* interface description */
298 /* Variable fields that are touched by the stack and drivers. */
299 int if_flags; /* up/down, broadcast, etc. */
300 int if_drv_flags; /* driver-managed status flags */
301 int if_capabilities; /* interface features & capabilities */
302 int if_capenable; /* enabled features & capabilities */
303 void *if_linkmib; /* link-type-specific MIB data */
304 size_t if_linkmiblen; /* length of above data */
305 u_int if_refcount; /* reference count */
307 /* These fields are shared with struct if_data. */
308 uint8_t if_type; /* ethernet, tokenring, etc */
309 uint8_t if_addrlen; /* media address length */
310 uint8_t if_hdrlen; /* media header length */
311 uint8_t if_link_state; /* current link state */
312 uint32_t if_mtu; /* maximum transmission unit */
313 uint32_t if_metric; /* routing metric (external only) */
314 uint64_t if_baudrate; /* linespeed */
315 uint64_t if_hwassist; /* HW offload capabilities, see IFCAP */
316 time_t if_epoch; /* uptime at attach or stat reset */
317 struct timeval if_lastchange; /* time of last administrative change */
319 struct ifaltq if_snd; /* output queue (includes altq) */
320 struct task if_linktask; /* task for link change events */
321 struct task if_addmultitask; /* task for SIOCADDMULTI */
323 /* Addresses of different protocol families assigned to this if. */
324 struct mtx if_addr_lock; /* lock to protect address lists */
326 * if_addrhead is the list of all addresses associated to
328 * Some code in the kernel assumes that first element
329 * of the list has type AF_LINK, and contains sockaddr_dl
330 * addresses which store the link-level address and the name
332 * However, access to the AF_LINK address through this
333 * field is deprecated. Use if_addr or ifaddr_byindex() instead.
335 struct ifaddrhead if_addrhead; /* linked list of addresses per if */
336 struct ifmultihead if_multiaddrs; /* multicast addresses configured */
337 int if_amcount; /* number of all-multicast requests */
338 struct ifaddr *if_addr; /* pointer to link-level address */
339 void *if_hw_addr; /* hardware link-level address */
340 const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
341 struct mtx if_afdata_lock;
342 void *if_afdata[AF_MAX];
343 int if_afdata_initialized;
345 /* Additional features hung off the interface. */
346 u_int if_fib; /* interface FIB */
347 struct vnet *if_vnet; /* pointer to network stack instance */
348 struct vnet *if_home_vnet; /* where this ifnet originates from */
349 struct ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */
350 struct bpf_if *if_bpf; /* packet filter structure */
351 int if_pcount; /* number of promiscuous listeners */
352 void *if_bridge; /* bridge glue */
353 void *if_lagg; /* lagg glue */
354 void *if_pf_kif; /* pf glue */
355 struct carp_if *if_carp; /* carp interface structure */
356 struct label *if_label; /* interface MAC label */
357 struct netmap_adapter *if_netmap; /* netmap(4) softc */
359 /* Various procedures of the layer2 encapsulation and drivers. */
360 int (*if_output) /* output routine (enqueue) */
361 (struct ifnet *, struct mbuf *, const struct sockaddr *,
363 void (*if_input) /* input routine (from h/w driver) */
364 (struct ifnet *, struct mbuf *);
365 struct mbuf *(*if_bridge_input)(struct ifnet *, struct mbuf *);
366 int (*if_bridge_output)(struct ifnet *, struct mbuf *, struct sockaddr *,
368 void (*if_bridge_linkstate)(struct ifnet *ifp);
369 if_start_fn_t if_start; /* initiate output routine */
370 if_ioctl_fn_t if_ioctl; /* ioctl routine */
371 if_init_fn_t if_init; /* Init routine */
372 int (*if_resolvemulti) /* validate/resolve multicast */
373 (struct ifnet *, struct sockaddr **, struct sockaddr *);
374 if_qflush_fn_t if_qflush; /* flush any queue */
375 if_transmit_fn_t if_transmit; /* initiate output routine */
377 void (*if_reassign) /* reassign to vnet routine */
378 (struct ifnet *, struct vnet *, char *);
379 if_get_counter_t if_get_counter; /* get counter values */
380 int (*if_requestencap) /* make link header from request */
381 (struct ifnet *, struct if_encap_req *);
384 counter_u64_t if_counters[IFCOUNTERS];
386 /* Stuff that's only temporary and doesn't belong here. */
389 * Network adapter TSO limits:
390 * ===========================
392 * If the "if_hw_tsomax" field is zero the maximum segment
393 * length limit does not apply. If the "if_hw_tsomaxsegcount"
394 * or the "if_hw_tsomaxsegsize" field is zero the TSO segment
395 * count limit does not apply. If all three fields are zero,
396 * there is no TSO limit.
398 * NOTE: The TSO limits should reflect the values used in the
399 * BUSDMA tag a network adapter is using to load a mbuf chain
400 * for transmission. The TCP/IP network stack will subtract
401 * space for all linklevel and protocol level headers and
402 * ensure that the full mbuf chain passed to the network
403 * adapter fits within the given limits.
405 u_int if_hw_tsomax; /* TSO maximum size in bytes */
406 u_int if_hw_tsomaxsegcount; /* TSO maximum segment count */
407 u_int if_hw_tsomaxsegsize; /* TSO maximum segment size in bytes */
410 * Network adapter send tag support:
412 if_snd_tag_alloc_t *if_snd_tag_alloc;
413 if_snd_tag_modify_t *if_snd_tag_modify;
414 if_snd_tag_query_t *if_snd_tag_query;
415 if_snd_tag_free_t *if_snd_tag_free;
416 if_ratelimit_query_t *if_ratelimit_query;
417 if_ratelimit_setup_t *if_ratelimit_setup;
423 * Debugnet (Netdump) hooks to be called while in db/panic.
425 struct debugnet_methods *if_debugnet_methods;
426 struct epoch_context if_epoch_ctx;
429 * Spare fields to be added before branching a stable branch, so
430 * that structure can be enhanced without changing the kernel
433 int if_ispare[4]; /* general use */
436 /* for compatibility with other BSDs */
437 #define if_name(ifp) ((ifp)->if_xname)
441 * Locks for address lists on the network interface.
443 #define IF_ADDR_LOCK_INIT(if) mtx_init(&(if)->if_addr_lock, "if_addr_lock", NULL, MTX_DEF)
444 #define IF_ADDR_LOCK_DESTROY(if) mtx_destroy(&(if)->if_addr_lock)
446 #define IF_ADDR_WLOCK(if) mtx_lock(&(if)->if_addr_lock)
447 #define IF_ADDR_WUNLOCK(if) mtx_unlock(&(if)->if_addr_lock)
448 #define IF_ADDR_LOCK_ASSERT(if) MPASS(in_epoch(net_epoch_preempt) || mtx_owned(&(if)->if_addr_lock))
449 #define IF_ADDR_WLOCK_ASSERT(if) mtx_assert(&(if)->if_addr_lock, MA_OWNED)
452 /* interface link layer address change event */
453 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
454 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
455 /* interface address change event */
456 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
457 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
458 typedef void (*ifaddr_event_ext_handler_t)(void *, struct ifnet *,
459 struct ifaddr *, int);
460 EVENTHANDLER_DECLARE(ifaddr_event_ext, ifaddr_event_ext_handler_t);
461 #define IFADDR_EVENT_ADD 0
462 #define IFADDR_EVENT_DEL 1
463 /* new interface arrival event */
464 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
465 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
466 /* interface departure event */
467 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
468 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
469 /* Interface link state change event */
470 typedef void (*ifnet_link_event_handler_t)(void *, struct ifnet *, int);
471 EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t);
472 /* Interface up/down event */
473 #define IFNET_EVENT_UP 0
474 #define IFNET_EVENT_DOWN 1
475 #define IFNET_EVENT_PCP 2 /* priority code point, PCP */
477 typedef void (*ifnet_event_fn)(void *, struct ifnet *ifp, int event);
478 EVENTHANDLER_DECLARE(ifnet_event, ifnet_event_fn);
484 char ifg_group[IFNAMSIZ];
487 CK_STAILQ_HEAD(, ifg_member) ifg_members; /* (CK_) */
488 CK_STAILQ_ENTRY(ifg_group) ifg_next; /* (CK_) */
492 CK_STAILQ_ENTRY(ifg_member) ifgm_next; /* (CK_) */
493 struct ifnet *ifgm_ifp;
497 struct ifg_group *ifgl_group;
498 CK_STAILQ_ENTRY(ifg_list) ifgl_next; /* (CK_) */
501 #ifdef _SYS_EVENTHANDLER_H_
502 /* group attach event */
503 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
504 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
505 /* group detach event */
506 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
507 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
508 /* group change event */
509 typedef void (*group_change_event_handler_t)(void *, const char *);
510 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
511 #endif /* _SYS_EVENTHANDLER_H_ */
513 #define IF_AFDATA_LOCK_INIT(ifp) \
514 mtx_init(&(ifp)->if_afdata_lock, "if_afdata", NULL, MTX_DEF)
516 #define IF_AFDATA_WLOCK(ifp) mtx_lock(&(ifp)->if_afdata_lock)
517 #define IF_AFDATA_WUNLOCK(ifp) mtx_unlock(&(ifp)->if_afdata_lock)
518 #define IF_AFDATA_LOCK(ifp) IF_AFDATA_WLOCK(ifp)
519 #define IF_AFDATA_UNLOCK(ifp) IF_AFDATA_WUNLOCK(ifp)
520 #define IF_AFDATA_TRYLOCK(ifp) mtx_trylock(&(ifp)->if_afdata_lock)
521 #define IF_AFDATA_DESTROY(ifp) mtx_destroy(&(ifp)->if_afdata_lock)
523 #define IF_AFDATA_LOCK_ASSERT(ifp) MPASS(in_epoch(net_epoch_preempt) || mtx_owned(&(ifp)->if_afdata_lock))
524 #define IF_AFDATA_WLOCK_ASSERT(ifp) mtx_assert(&(ifp)->if_afdata_lock, MA_OWNED)
525 #define IF_AFDATA_UNLOCK_ASSERT(ifp) mtx_assert(&(ifp)->if_afdata_lock, MA_NOTOWNED)
528 * 72 was chosen below because it is the size of a TCP/IP
529 * header (40) + the minimum mss (32).
532 #define IF_MAXMTU 65535
534 #define TOEDEV(ifp) ((ifp)->if_llsoftc)
537 * The ifaddr structure contains information about one address
538 * of an interface. They are maintained by the different address families,
539 * are allocated and attached when an address is set, and are linked
540 * together so all addresses for an interface can be located.
542 * NOTE: a 'struct ifaddr' is always at the beginning of a larger
543 * chunk of malloc'ed memory, where we store the three addresses
544 * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
547 struct sockaddr *ifa_addr; /* address of interface */
548 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
549 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
550 struct sockaddr *ifa_netmask; /* used to determine subnet */
551 struct ifnet *ifa_ifp; /* back-pointer to interface */
552 struct carp_softc *ifa_carp; /* pointer to CARP data */
553 CK_STAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */
554 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
555 (int, struct rtentry *, struct nhop_object *,
556 struct rt_addrinfo *);
557 u_short ifa_flags; /* mostly rt_flags for cloning */
558 #define IFA_ROUTE RTF_UP /* route installed */
559 #define IFA_RTSELF RTF_HOST /* loopback route to self installed */
560 u_int ifa_refcnt; /* references to this structure */
562 counter_u64_t ifa_ipackets;
563 counter_u64_t ifa_opackets;
564 counter_u64_t ifa_ibytes;
565 counter_u64_t ifa_obytes;
566 struct epoch_context ifa_epoch_ctx;
569 struct ifaddr * ifa_alloc(size_t size, int flags);
570 void ifa_free(struct ifaddr *ifa);
571 void ifa_ref(struct ifaddr *ifa);
574 * Multicast address structure. This is analogous to the ifaddr
575 * structure except that it keeps track of multicast addresses.
577 #define IFMA_F_ENQUEUED 0x1
579 CK_STAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
580 struct sockaddr *ifma_addr; /* address this membership is for */
581 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
582 struct ifnet *ifma_ifp; /* back-pointer to interface */
583 u_int ifma_refcount; /* reference count */
585 void *ifma_protospec; /* protocol-specific state, if any */
586 struct ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
587 struct epoch_context ifma_epoch_ctx;
590 extern struct rwlock ifnet_rwlock;
591 extern struct sx ifnet_sxlock;
593 #define IFNET_WLOCK() do { \
594 sx_xlock(&ifnet_sxlock); \
595 rw_wlock(&ifnet_rwlock); \
598 #define IFNET_WUNLOCK() do { \
599 rw_wunlock(&ifnet_rwlock); \
600 sx_xunlock(&ifnet_sxlock); \
604 * To assert the ifnet lock, you must know not only whether it's for read or
605 * write, but also whether it was acquired with sleep support or not.
607 #define IFNET_RLOCK_ASSERT() sx_assert(&ifnet_sxlock, SA_SLOCKED)
608 #define IFNET_WLOCK_ASSERT() do { \
609 sx_assert(&ifnet_sxlock, SA_XLOCKED); \
610 rw_assert(&ifnet_rwlock, RA_WLOCKED); \
613 #define IFNET_RLOCK() sx_slock(&ifnet_sxlock)
614 #define IFNET_RUNLOCK() sx_sunlock(&ifnet_sxlock)
617 * Look up an ifnet given its index; the _ref variant also acquires a
618 * reference that must be freed using if_rele(). It is almost always a bug
619 * to call ifnet_byindex() instead of ifnet_byindex_ref().
621 struct ifnet *ifnet_byindex(u_short idx);
622 struct ifnet *ifnet_byindex_ref(u_short idx);
625 * Given the index, ifaddr_byindex() returns the one and only
626 * link-level ifaddr for the interface. You are not supposed to use
627 * it to traverse the list of addresses associated to the interface.
629 struct ifaddr *ifaddr_byindex(u_short idx);
631 VNET_DECLARE(struct ifnethead, ifnet);
632 VNET_DECLARE(struct ifgrouphead, ifg_head);
633 VNET_DECLARE(int, if_index);
634 VNET_DECLARE(struct ifnet *, loif); /* first loopback interface */
636 #define V_ifnet VNET(ifnet)
637 #define V_ifg_head VNET(ifg_head)
638 #define V_if_index VNET(if_index)
639 #define V_loif VNET(loif)
642 #define MCDPRINTF printf
644 #define MCDPRINTF(...)
647 int if_addgroup(struct ifnet *, const char *);
648 int if_delgroup(struct ifnet *, const char *);
649 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
650 int if_allmulti(struct ifnet *, int);
651 struct ifnet* if_alloc(u_char);
652 struct ifnet* if_alloc_dev(u_char, device_t dev);
653 struct ifnet* if_alloc_domain(u_char, int numa_domain);
654 void if_attach(struct ifnet *);
655 void if_dead(struct ifnet *);
656 int if_delmulti(struct ifnet *, struct sockaddr *);
657 void if_delmulti_ifma(struct ifmultiaddr *);
658 void if_delmulti_ifma_flags(struct ifmultiaddr *, int flags);
659 void if_detach(struct ifnet *);
660 void if_purgeaddrs(struct ifnet *);
661 void if_delallmulti(struct ifnet *);
662 void if_down(struct ifnet *);
664 if_findmulti(struct ifnet *, const struct sockaddr *);
665 void if_freemulti(struct ifmultiaddr *ifma);
666 void if_free(struct ifnet *);
667 void if_initname(struct ifnet *, const char *, int);
668 void if_link_state_change(struct ifnet *, int);
669 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
670 void if_ref(struct ifnet *);
671 void if_rele(struct ifnet *);
672 int if_setlladdr(struct ifnet *, const u_char *, int);
673 int if_tunnel_check_nesting(struct ifnet *, struct mbuf *, uint32_t, int);
674 void if_up(struct ifnet *);
675 int ifioctl(struct socket *, u_long, caddr_t, struct thread *);
676 int ifpromisc(struct ifnet *, int);
677 struct ifnet *ifunit(const char *);
678 struct ifnet *ifunit_ref(const char *);
680 int ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
681 int ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
682 int ifa_switch_loopback_route(struct ifaddr *, struct sockaddr *);
684 struct ifaddr *ifa_ifwithaddr(const struct sockaddr *);
685 int ifa_ifwithaddr_check(const struct sockaddr *);
686 struct ifaddr *ifa_ifwithbroadaddr(const struct sockaddr *, int);
687 struct ifaddr *ifa_ifwithdstaddr(const struct sockaddr *, int);
688 struct ifaddr *ifa_ifwithnet(const struct sockaddr *, int, int);
689 struct ifaddr *ifa_ifwithroute(int, const struct sockaddr *,
690 const struct sockaddr *, u_int);
691 struct ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *);
692 int ifa_preferred(struct ifaddr *, struct ifaddr *);
694 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
696 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
697 typedef void if_com_free_t(void *com, u_char type);
698 void if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
699 void if_deregister_com_alloc(u_char type);
700 void if_data_copy(struct ifnet *, struct if_data *);
701 uint64_t if_get_counter_default(struct ifnet *, ift_counter);
702 void if_inc_counter(struct ifnet *, ift_counter, int64_t);
704 #define IF_LLADDR(ifp) \
705 LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr))
707 uint64_t if_setbaudrate(if_t ifp, uint64_t baudrate);
708 uint64_t if_getbaudrate(if_t ifp);
709 int if_setcapabilities(if_t ifp, int capabilities);
710 int if_setcapabilitiesbit(if_t ifp, int setbit, int clearbit);
711 int if_getcapabilities(if_t ifp);
712 int if_togglecapenable(if_t ifp, int togglecap);
713 int if_setcapenable(if_t ifp, int capenable);
714 int if_setcapenablebit(if_t ifp, int setcap, int clearcap);
715 int if_getcapenable(if_t ifp);
716 const char *if_getdname(if_t ifp);
717 int if_setdev(if_t ifp, void *dev);
718 int if_setdrvflagbits(if_t ifp, int if_setflags, int clear_flags);
719 int if_getdrvflags(if_t ifp);
720 int if_setdrvflags(if_t ifp, int flags);
721 int if_clearhwassist(if_t ifp);
722 int if_sethwassistbits(if_t ifp, int toset, int toclear);
723 int if_sethwassist(if_t ifp, int hwassist_bit);
724 int if_gethwassist(if_t ifp);
725 int if_setsoftc(if_t ifp, void *softc);
726 void *if_getsoftc(if_t ifp);
727 int if_setflags(if_t ifp, int flags);
728 int if_gethwaddr(if_t ifp, struct ifreq *);
729 int if_setmtu(if_t ifp, int mtu);
730 int if_getmtu(if_t ifp);
731 int if_getmtu_family(if_t ifp, int family);
732 int if_setflagbits(if_t ifp, int set, int clear);
733 int if_getflags(if_t ifp);
734 int if_sendq_empty(if_t ifp);
735 int if_setsendqready(if_t ifp);
736 int if_setsendqlen(if_t ifp, int tx_desc_count);
737 int if_sethwtsomax(if_t ifp, u_int if_hw_tsomax);
738 int if_sethwtsomaxsegcount(if_t ifp, u_int if_hw_tsomaxsegcount);
739 int if_sethwtsomaxsegsize(if_t ifp, u_int if_hw_tsomaxsegsize);
740 u_int if_gethwtsomax(if_t ifp);
741 u_int if_gethwtsomaxsegcount(if_t ifp);
742 u_int if_gethwtsomaxsegsize(if_t ifp);
743 int if_input(if_t ifp, struct mbuf* sendmp);
744 int if_sendq_prepend(if_t ifp, struct mbuf *m);
745 struct mbuf *if_dequeue(if_t ifp);
746 int if_setifheaderlen(if_t ifp, int len);
747 void if_setrcvif(struct mbuf *m, if_t ifp);
748 void if_setvtag(struct mbuf *m, u_int16_t tag);
749 u_int16_t if_getvtag(struct mbuf *m);
750 int if_vlantrunkinuse(if_t ifp);
751 caddr_t if_getlladdr(if_t ifp);
752 void *if_gethandle(u_char);
753 void if_bpfmtap(if_t ifp, struct mbuf *m);
754 void if_etherbpfmtap(if_t ifp, struct mbuf *m);
755 void if_vlancap(if_t ifp);
758 * Traversing through interface address lists.
761 typedef u_int iflladdr_cb_t(void *, struct sockaddr_dl *, u_int);
762 u_int if_foreach_lladdr(if_t, iflladdr_cb_t, void *);
763 u_int if_foreach_llmaddr(if_t, iflladdr_cb_t, void *);
764 u_int if_lladdr_count(if_t);
765 u_int if_llmaddr_count(if_t);
767 int if_getamcount(if_t ifp);
768 struct ifaddr * if_getifaddr(if_t ifp);
771 void if_setinitfn(if_t ifp, void (*)(void *));
772 void if_setioctlfn(if_t ifp, int (*)(if_t, u_long, caddr_t));
773 void if_setstartfn(if_t ifp, void (*)(if_t));
774 void if_settransmitfn(if_t ifp, if_transmit_fn_t);
775 void if_setqflushfn(if_t ifp, if_qflush_fn_t);
776 void if_setgetcounterfn(if_t ifp, if_get_counter_t);
778 /* Revisit the below. These are inline functions originally */
779 int drbr_inuse_drv(if_t ifp, struct buf_ring *br);
780 struct mbuf* drbr_dequeue_drv(if_t ifp, struct buf_ring *br);
781 int drbr_needs_enqueue_drv(if_t ifp, struct buf_ring *br);
782 int drbr_enqueue_drv(if_t ifp, struct buf_ring *br, struct mbuf *m);
785 void if_hw_tsomax_common(if_t ifp, struct ifnet_hw_tsomax *);
786 int if_hw_tsomax_update(if_t ifp, struct ifnet_hw_tsomax *);
788 /* accessors for struct ifreq */
789 void *ifr_data_get_ptr(void *ifrp);
790 void *ifr_buffer_get_buffer(void *data);
791 size_t ifr_buffer_get_length(void *data);
793 int ifhwioctl(u_long, struct ifnet *, caddr_t, struct thread *);
795 #ifdef DEVICE_POLLING
796 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS };
798 typedef int poll_handler_t(if_t ifp, enum poll_cmd cmd, int count);
799 int ether_poll_register(poll_handler_t *h, if_t ifp);
800 int ether_poll_deregister(if_t ifp);
801 #endif /* DEVICE_POLLING */
805 #include <net/ifq.h> /* XXXAO: temporary unconditional include */
807 #endif /* !_NET_IF_VAR_H_ */