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 * 4. 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 */
71 #include <sys/mbuf.h> /* ifqueue only? */
72 #include <sys/buf_ring.h>
75 #include <sys/counter.h>
76 #include <sys/lock.h> /* XXX */
77 #include <sys/mutex.h> /* struct ifqueue */
78 #include <sys/rwlock.h> /* XXX */
79 #include <sys/sx.h> /* XXX */
80 #include <sys/_task.h> /* if_link_task */
82 #define IF_DUNIT_NONE -1
84 #include <altq/if_altq.h>
86 TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */
87 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */
88 TAILQ_HEAD(ifmultihead, ifmultiaddr);
89 TAILQ_HEAD(ifgrouphead, ifg_group);
92 VNET_DECLARE(struct pfil_head, link_pfil_hook); /* packet filter hooks */
93 #define V_link_pfil_hook VNET(link_pfil_hook)
97 * Structure defining a network interface.
99 * Size ILP32: 592 (approx)
100 * LP64: 1048 (approx)
103 /* General book keeping of interface lists. */
104 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */
105 LIST_ENTRY(ifnet) if_clones; /* interfaces of a cloner */
106 TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
107 /* protected by if_addr_lock */
108 u_char if_alloctype; /* if_type at time of allocation */
110 /* Driver and protocol specific information that remains stable. */
111 void *if_softc; /* pointer to driver state */
112 void *if_llsoftc; /* link layer softc */
113 void *if_l2com; /* pointer to protocol bits */
114 const char *if_dname; /* driver name */
115 int if_dunit; /* unit or IF_DUNIT_NONE */
116 u_short if_index; /* numeric abbreviation for this if */
117 short if_index_reserved; /* spare space to grow if_index */
118 char if_xname[IFNAMSIZ]; /* external name (name + unit) */
119 char *if_description; /* interface description */
121 /* Variable fields that are touched by the stack and drivers. */
122 int if_flags; /* up/down, broadcast, etc. */
123 int if_capabilities; /* interface features & capabilities */
124 int if_capenable; /* enabled features & capabilities */
125 void *if_linkmib; /* link-type-specific MIB data */
126 size_t if_linkmiblen; /* length of above data */
127 int if_drv_flags; /* driver-managed status flags */
128 u_int if_refcount; /* reference count */
129 struct ifaltq if_snd; /* output queue (includes altq) */
130 struct if_data if_data; /* type information and statistics */
131 struct task if_linktask; /* task for link change events */
133 /* Addresses of different protocol families assigned to this if. */
134 struct rwlock if_addr_lock; /* lock to protect address lists */
136 * if_addrhead is the list of all addresses associated to
138 * Some code in the kernel assumes that first element
139 * of the list has type AF_LINK, and contains sockaddr_dl
140 * addresses which store the link-level address and the name
142 * However, access to the AF_LINK address through this
143 * field is deprecated. Use if_addr or ifaddr_byindex() instead.
145 struct ifaddrhead if_addrhead; /* linked list of addresses per if */
146 struct ifmultihead if_multiaddrs; /* multicast addresses configured */
147 int if_amcount; /* number of all-multicast requests */
148 struct ifaddr *if_addr; /* pointer to link-level address */
149 const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
150 struct rwlock if_afdata_lock;
151 void *if_afdata[AF_MAX];
152 int if_afdata_initialized;
154 /* Additional features hung off the interface. */
155 u_int if_fib; /* interface FIB */
156 struct vnet *if_vnet; /* pointer to network stack instance */
157 struct vnet *if_home_vnet; /* where this ifnet originates from */
158 struct ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */
159 struct bpf_if *if_bpf; /* packet filter structure */
160 int if_pcount; /* number of promiscuous listeners */
161 void *if_bridge; /* bridge glue */
162 void *if_lagg; /* lagg glue */
163 void *if_pf_kif; /* pf glue */
164 struct carp_if *if_carp; /* carp interface structure */
165 struct label *if_label; /* interface MAC label */
167 /* Various procedures of the layer2 encapsulation and drivers. */
168 int (*if_output) /* output routine (enqueue) */
169 (struct ifnet *, struct mbuf *, const struct sockaddr *,
171 void (*if_input) /* input routine (from h/w driver) */
172 (struct ifnet *, struct mbuf *);
173 void (*if_start) /* initiate output routine */
175 int (*if_ioctl) /* ioctl routine */
176 (struct ifnet *, u_long, caddr_t);
177 void (*if_init) /* Init routine */
179 int (*if_resolvemulti) /* validate/resolve multicast */
180 (struct ifnet *, struct sockaddr **, struct sockaddr *);
181 void (*if_qflush) /* flush any queues */
183 int (*if_transmit) /* initiate output routine */
184 (struct ifnet *, struct mbuf *);
185 void (*if_reassign) /* reassign to vnet routine */
186 (struct ifnet *, struct vnet *, char *);
188 /* Stuff that's only temporary and doesn't belong here. */
189 u_int if_hw_tsomax; /* tso burst length limit, the minimum
190 * is (IP_MAXPACKET / 8).
191 * XXXAO: Have to find a better place
192 * for it eventually. */
194 * Spare fields are added so that we can modify sensitive data
195 * structures without changing the kernel binary interface, and must
196 * be used with care where binary compatibility is required.
201 void *if_pspare[8]; /* 1 netmap, 7 TDB */
204 #include <net/ifq.h> /* XXXAO: temporary unconditional include */
207 * XXX These aliases are terribly dangerous because they could apply
210 #define if_mtu if_data.ifi_mtu
211 #define if_type if_data.ifi_type
212 #define if_physical if_data.ifi_physical
213 #define if_addrlen if_data.ifi_addrlen
214 #define if_hdrlen if_data.ifi_hdrlen
215 #define if_metric if_data.ifi_metric
216 #define if_link_state if_data.ifi_link_state
217 #define if_baudrate if_data.ifi_baudrate
218 #define if_hwassist if_data.ifi_hwassist
219 #define if_ipackets if_data.ifi_ipackets
220 #define if_ierrors if_data.ifi_ierrors
221 #define if_opackets if_data.ifi_opackets
222 #define if_oerrors if_data.ifi_oerrors
223 #define if_collisions if_data.ifi_collisions
224 #define if_ibytes if_data.ifi_ibytes
225 #define if_obytes if_data.ifi_obytes
226 #define if_imcasts if_data.ifi_imcasts
227 #define if_omcasts if_data.ifi_omcasts
228 #define if_iqdrops if_data.ifi_iqdrops
229 #define if_noproto if_data.ifi_noproto
230 #define if_lastchange if_data.ifi_lastchange
232 /* for compatibility with other BSDs */
233 #define if_addrlist if_addrhead
234 #define if_list if_link
235 #define if_name(ifp) ((ifp)->if_xname)
238 * Locks for address lists on the network interface.
240 #define IF_ADDR_LOCK_INIT(if) rw_init(&(if)->if_addr_lock, "if_addr_lock")
241 #define IF_ADDR_LOCK_DESTROY(if) rw_destroy(&(if)->if_addr_lock)
242 #define IF_ADDR_WLOCK(if) rw_wlock(&(if)->if_addr_lock)
243 #define IF_ADDR_WUNLOCK(if) rw_wunlock(&(if)->if_addr_lock)
244 #define IF_ADDR_RLOCK(if) rw_rlock(&(if)->if_addr_lock)
245 #define IF_ADDR_RUNLOCK(if) rw_runlock(&(if)->if_addr_lock)
246 #define IF_ADDR_LOCK_ASSERT(if) rw_assert(&(if)->if_addr_lock, RA_LOCKED)
247 #define IF_ADDR_WLOCK_ASSERT(if) rw_assert(&(if)->if_addr_lock, RA_WLOCKED)
250 * Function variations on locking macros intended to be used by loadable
251 * kernel modules in order to divorce them from the internals of address list
254 void if_addr_rlock(struct ifnet *ifp); /* if_addrhead */
255 void if_addr_runlock(struct ifnet *ifp); /* if_addrhead */
256 void if_maddr_rlock(struct ifnet *ifp); /* if_multiaddrs */
257 void if_maddr_runlock(struct ifnet *ifp); /* if_multiaddrs */
260 #ifdef _SYS_EVENTHANDLER_H_
261 /* interface link layer address change event */
262 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
263 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
264 /* interface address change event */
265 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
266 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
267 /* new interface arrival event */
268 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
269 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
270 /* interface departure event */
271 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
272 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
273 /* Interface link state change event */
274 typedef void (*ifnet_link_event_handler_t)(void *, struct ifnet *, int);
275 EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t);
276 #endif /* _SYS_EVENTHANDLER_H_ */
282 char ifg_group[IFNAMSIZ];
285 TAILQ_HEAD(, ifg_member) ifg_members;
286 TAILQ_ENTRY(ifg_group) ifg_next;
290 TAILQ_ENTRY(ifg_member) ifgm_next;
291 struct ifnet *ifgm_ifp;
295 struct ifg_group *ifgl_group;
296 TAILQ_ENTRY(ifg_list) ifgl_next;
299 #ifdef _SYS_EVENTHANDLER_H_
300 /* group attach event */
301 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
302 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
303 /* group detach event */
304 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
305 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
306 /* group change event */
307 typedef void (*group_change_event_handler_t)(void *, const char *);
308 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
309 #endif /* _SYS_EVENTHANDLER_H_ */
311 #define IF_AFDATA_LOCK_INIT(ifp) \
312 rw_init(&(ifp)->if_afdata_lock, "if_afdata")
314 #define IF_AFDATA_WLOCK(ifp) rw_wlock(&(ifp)->if_afdata_lock)
315 #define IF_AFDATA_RLOCK(ifp) rw_rlock(&(ifp)->if_afdata_lock)
316 #define IF_AFDATA_WUNLOCK(ifp) rw_wunlock(&(ifp)->if_afdata_lock)
317 #define IF_AFDATA_RUNLOCK(ifp) rw_runlock(&(ifp)->if_afdata_lock)
318 #define IF_AFDATA_LOCK(ifp) IF_AFDATA_WLOCK(ifp)
319 #define IF_AFDATA_UNLOCK(ifp) IF_AFDATA_WUNLOCK(ifp)
320 #define IF_AFDATA_TRYLOCK(ifp) rw_try_wlock(&(ifp)->if_afdata_lock)
321 #define IF_AFDATA_DESTROY(ifp) rw_destroy(&(ifp)->if_afdata_lock)
323 #define IF_AFDATA_LOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_LOCKED)
324 #define IF_AFDATA_RLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_RLOCKED)
325 #define IF_AFDATA_WLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_WLOCKED)
326 #define IF_AFDATA_UNLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_UNLOCKED)
329 * 72 was chosen below because it is the size of a TCP/IP
330 * header (40) + the minimum mss (32).
333 #define IF_MAXMTU 65535
335 #define TOEDEV(ifp) ((ifp)->if_llsoftc)
340 * The ifaddr structure contains information about one address
341 * of an interface. They are maintained by the different address families,
342 * are allocated and attached when an address is set, and are linked
343 * together so all addresses for an interface can be located.
345 * NOTE: a 'struct ifaddr' is always at the beginning of a larger
346 * chunk of malloc'ed memory, where we store the three addresses
347 * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
349 #if defined(_KERNEL) || defined(_WANT_IFADDR)
351 struct sockaddr *ifa_addr; /* address of interface */
352 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
353 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
354 struct sockaddr *ifa_netmask; /* used to determine subnet */
355 struct ifnet *ifa_ifp; /* back-pointer to interface */
356 struct carp_softc *ifa_carp; /* pointer to CARP data */
357 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */
358 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
359 (int, struct rtentry *, struct rt_addrinfo *);
360 u_short ifa_flags; /* mostly rt_flags for cloning */
361 u_int ifa_refcnt; /* references to this structure */
362 int ifa_metric; /* cost of going out this interface */
363 int (*ifa_claim_addr) /* check if an addr goes to this if */
364 (struct ifaddr *, struct sockaddr *);
366 counter_u64_t ifa_ipackets;
367 counter_u64_t ifa_opackets;
368 counter_u64_t ifa_ibytes;
369 counter_u64_t ifa_obytes;
374 #define IFA_ROUTE RTF_UP /* route installed */
375 #define IFA_RTSELF RTF_HOST /* loopback route to self installed */
377 /* For compatibility with other BSDs. SCTP uses it. */
378 #define ifa_list ifa_link
380 struct ifaddr * ifa_alloc(size_t size, int flags);
381 void ifa_free(struct ifaddr *ifa);
382 void ifa_ref(struct ifaddr *ifa);
386 * Multicast address structure. This is analogous to the ifaddr
387 * structure except that it keeps track of multicast addresses.
390 TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
391 struct sockaddr *ifma_addr; /* address this membership is for */
392 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
393 struct ifnet *ifma_ifp; /* back-pointer to interface */
394 u_int ifma_refcount; /* reference count */
395 void *ifma_protospec; /* protocol-specific state, if any */
396 struct ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
401 extern struct rwlock ifnet_rwlock;
402 extern struct sx ifnet_sxlock;
404 #define IFNET_LOCK_INIT() do { \
405 rw_init_flags(&ifnet_rwlock, "ifnet_rw", RW_RECURSE); \
406 sx_init_flags(&ifnet_sxlock, "ifnet_sx", SX_RECURSE); \
409 #define IFNET_WLOCK() do { \
410 sx_xlock(&ifnet_sxlock); \
411 rw_wlock(&ifnet_rwlock); \
414 #define IFNET_WUNLOCK() do { \
415 rw_wunlock(&ifnet_rwlock); \
416 sx_xunlock(&ifnet_sxlock); \
420 * To assert the ifnet lock, you must know not only whether it's for read or
421 * write, but also whether it was acquired with sleep support or not.
423 #define IFNET_RLOCK_ASSERT() sx_assert(&ifnet_sxlock, SA_SLOCKED)
424 #define IFNET_RLOCK_NOSLEEP_ASSERT() rw_assert(&ifnet_rwlock, RA_RLOCKED)
425 #define IFNET_WLOCK_ASSERT() do { \
426 sx_assert(&ifnet_sxlock, SA_XLOCKED); \
427 rw_assert(&ifnet_rwlock, RA_WLOCKED); \
430 #define IFNET_RLOCK() sx_slock(&ifnet_sxlock)
431 #define IFNET_RLOCK_NOSLEEP() rw_rlock(&ifnet_rwlock)
432 #define IFNET_RUNLOCK() sx_sunlock(&ifnet_sxlock)
433 #define IFNET_RUNLOCK_NOSLEEP() rw_runlock(&ifnet_rwlock)
436 * Look up an ifnet given its index; the _ref variant also acquires a
437 * reference that must be freed using if_rele(). It is almost always a bug
438 * to call ifnet_byindex() instead if ifnet_byindex_ref().
440 struct ifnet *ifnet_byindex(u_short idx);
441 struct ifnet *ifnet_byindex_locked(u_short idx);
442 struct ifnet *ifnet_byindex_ref(u_short idx);
445 * Given the index, ifaddr_byindex() returns the one and only
446 * link-level ifaddr for the interface. You are not supposed to use
447 * it to traverse the list of addresses associated to the interface.
449 struct ifaddr *ifaddr_byindex(u_short idx);
451 VNET_DECLARE(struct ifnethead, ifnet);
452 VNET_DECLARE(struct ifgrouphead, ifg_head);
453 VNET_DECLARE(int, if_index);
454 VNET_DECLARE(struct ifnet *, loif); /* first loopback interface */
456 #define V_ifnet VNET(ifnet)
457 #define V_ifg_head VNET(ifg_head)
458 #define V_if_index VNET(if_index)
459 #define V_loif VNET(loif)
461 int if_addgroup(struct ifnet *, const char *);
462 int if_delgroup(struct ifnet *, const char *);
463 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
464 int if_allmulti(struct ifnet *, int);
465 struct ifnet* if_alloc(u_char);
466 void if_attach(struct ifnet *);
467 void if_dead(struct ifnet *);
468 int if_delmulti(struct ifnet *, struct sockaddr *);
469 void if_delmulti_ifma(struct ifmultiaddr *);
470 void if_detach(struct ifnet *);
471 void if_vmove(struct ifnet *, struct vnet *);
472 void if_purgeaddrs(struct ifnet *);
473 void if_delallmulti(struct ifnet *);
474 void if_down(struct ifnet *);
476 if_findmulti(struct ifnet *, struct sockaddr *);
477 void if_free(struct ifnet *);
478 void if_initname(struct ifnet *, const char *, int);
479 void if_link_state_change(struct ifnet *, int);
480 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
481 void if_ref(struct ifnet *);
482 void if_rele(struct ifnet *);
483 int if_setlladdr(struct ifnet *, const u_char *, int);
484 void if_up(struct ifnet *);
485 int ifioctl(struct socket *, u_long, caddr_t, struct thread *);
486 int ifpromisc(struct ifnet *, int);
487 struct ifnet *ifunit(const char *);
488 struct ifnet *ifunit_ref(const char *);
490 int ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
491 int ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
492 int ifa_switch_loopback_route(struct ifaddr *, struct sockaddr *);
494 struct ifaddr *ifa_ifwithaddr(struct sockaddr *);
495 int ifa_ifwithaddr_check(struct sockaddr *);
496 struct ifaddr *ifa_ifwithbroadaddr(struct sockaddr *);
497 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
498 struct ifaddr *ifa_ifwithnet(struct sockaddr *, int);
499 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
500 struct ifaddr *ifa_ifwithroute_fib(int, struct sockaddr *, struct sockaddr *, u_int);
501 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
502 int ifa_preferred(struct ifaddr *, struct ifaddr *);
504 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
506 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
507 typedef void if_com_free_t(void *com, u_char type);
508 void if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
509 void if_deregister_com_alloc(u_char type);
511 #define IF_LLADDR(ifp) \
512 LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr))
515 #endif /* !_NET_IF_VAR_H_ */