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. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * From: @(#)if.h 8.1 (Berkeley) 6/10/93
34 * $FreeBSD: src/sys/net/if_var.h,v 1.18.2.16 2003/04/15 18:11:19 fjoe Exp $
37 #ifndef _NET_IF_VAR_H_
38 #define _NET_IF_VAR_H_
40 #ifndef _SYS_SERIALIZE_H_
41 #include <sys/serialize.h>
47 #include <sys/mutex.h>
51 * Structures defining a network interface, providing a packet
52 * transport mechanism (ala level 0 of the PUP protocols).
54 * Each interface accepts output datagrams of a specified maximum
55 * length, and provides higher level routines with input datagrams
56 * received from its medium.
58 * Output occurs when the routine if_output is called, with four parameters:
60 * ifp->if_output(ifp, m, dst, rt)
62 * Here m is the mbuf chain to be sent and dst is the destination address.
63 * The output routine encapsulates the supplied datagram if necessary,
64 * and then transmits it on its medium.
66 * On input, each interface unwraps the data received by it, and either
67 * places it on the input queue of a internetwork datagram routine
68 * and posts the associated software interrupt, or passes the datagram to
69 * the routine if_input. It is called with four parameters:
71 * ifp->if_input(ifp, m, pi, cpuid)
73 * Here m is the mbuf chain to be received. The input routine removes the
74 * protocol dependent header if necessary. A driver may also call using
75 * custom struct pktinfo reference pi and a cpuid to take advantage of
76 * hardware supplied information. Otherwise, the defaults for pi and cpuid
79 * ifp->if_input(ifp, m, NULL, -1);
81 * Routines exist for locating interfaces by their addresses
82 * or for locating a interface on a certain network, as well as more general
83 * routing and gateway routines maintaining information used to locate
84 * interfaces. These routines live in the files if.c and route.c
88 * Forward structure declarations for function prototypes [sic].
97 struct lwkt_serialize;
98 struct ifaddr_container;
107 #include <sys/queue.h> /* get TAILQ macros */
109 #include <net/altq/if_altq.h>
112 #include <sys/eventhandler.h>
113 #include <sys/mbuf.h>
114 #include <sys/systm.h> /* XXX */
115 #include <sys/thread2.h>
118 #define IF_DUNIT_NONE -1
120 TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */
121 TAILQ_HEAD(ifaddrhead, ifaddr_container); /* instantiation is preserved in the list */
122 TAILQ_HEAD(ifmultihead, ifmultiaddr);
125 * Structure defining a mbuf queue.
128 struct mbuf *ifq_head;
129 struct mbuf *ifq_tail;
136 * Note of IFPOLL_ENABLE
137 * 1) Any file(*.c) that depends on IFPOLL_ENABLE supports in this
138 * file should include opt_ifpoll.h at its beginning.
139 * 2) When struct changes, which are conditioned by IFPOLL_ENABLE,
140 * are to be introduced, please keep the struct's size and layout
141 * same, no matter whether IFPOLL_ENABLE is defined or not.
142 * See ifnet.if_npoll and ifnet.if_npoll_unused for example.
146 * Network serialize/deserialize types
148 enum ifnet_serialize {
149 IFNET_SERIALIZE_ALL /* all serializers */
152 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
155 * Structure defining a network interface.
157 * (Would like to call this struct ``if'', but C isn't PL/1.)
161 * NB: For DragonFlyBSD, it is assumed that each NIC driver's softc starts
162 * with one of these structures, typically held within an arpcom structure.
164 * struct <foo>_softc {
166 * struct ifnet ac_if;
172 * The assumption is used in a number of places, including many
173 * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
175 * Unfortunately devices' softc are opaque, so we depend on this layout
176 * to locate the struct ifnet from the softc in the generic code.
182 * ifnet is protected by calling if_serialize, if_tryserialize and
183 * if_deserialize serialize functions with the ifnet_serialize parameter.
184 * Callers of if_ioctl, if_watchdog, if_init, if_resolvemulti, and if_npoll
185 * should call the ifnet serialize functions with IFNET_SERIALIZE_ALL.
187 * if_snd subqueues are protected by its own serializers. Callers of
188 * if_start should call ifsq_serialiize_hw(), ifsq_deserialize_hw() and
189 * ifsq_tryserialize_hw() to properly serialize hardware for transmission.
191 * Caller of if_output MUST NOT serialize ifnet or if_snd by calling
192 * the related serialize functions.
194 * For better tranmission performance, driver should setup if_snd subqueue
195 * owner cpuid properly using ifsq_set_cpuid() (or ifq_set_cpuid(), if not
196 * multiple transmit queue capable). Normally, the if_snd subqueue owner
197 * cpu is the one that processing the transmission interrupt. And in driver,
198 * direct call of if_start should be avoided, use ifsq_devstart() or
199 * ifsq_devstart_sched() instead (or if_devstart()/if_devstart_sched(), if
200 * not multiple transmit queue capable).
206 * if_data is no longer used to hold per interface statistics, so DO NOT use
207 * the old style ifp->if_ipackets++ to update statistics; instead IFNET_STAT_
208 * macros should be used.
212 * SINGLE SERIALIZER MODE:
214 * In this mode, driver MUST NOT setup if_serialize, if_deserialize,
215 * if_tryserialize or if_serialize_assert. Driver could supply its own
216 * serializer to be used (through the type specific attach function, e.g.
217 * ether_ifattach()) or it could depend on the default serializer. In this
218 * mode if_serializer will be setup properly.
220 * If a device driver installs the same serializer for its interrupt
221 * as for ifnet, then the driver only really needs to worry about further
222 * serialization in timeout based entry points and device_method_t entry
223 * points. All other entry points will already be serialized.
227 * MULTI SERIALIZERS MODE:
229 * In this mode, driver MUST setup if_serialize, if_deserialize,
230 * if_tryserialize and if_serialize_assert. Driver MUST NOT supply its own
231 * serializer to be used. In this mode, if_serializer will be left as NULL.
232 * And driver MUST setup if_snd subqueues' hardware serailizer properly by
233 * calling ifsq_set_hw_serialize().
237 * MULTIPLE TRANSMIT QUEUES:
239 * This should be implemented in "MULTI SERIALIZERS MODE". Legacy if_watchdog
240 * method SHOULD NOT be used.
244 * Before the type specific attach, e.g. ether_ifattach(), driver should
245 * setup the transmit queue count and cpuid to subqueue mapping method
246 * properly (assume QCOUNT is power of 2):
248 * ifq_set_subq_cnt(&ifp->if_snd, QCOUNT);
249 * ifp->if_mapsubq = ifq_mapsubq_mask;
250 * ifq_set_subq_mask(&ifp->if_snd, QCOUNT - 1);
252 * After the type specific attach, driver should setup the subqueues owner
253 * cpu, serializer and watchdog properly:
255 * for (i = 0; i < QCOUNT, ++i) {
256 * struct ifaltq_subque *ifsq = ifq_get_subq(&ifp->if_snd, i);
258 * ifsq_set_cpuid(ifsq, Q_CPUID);
259 * ifsq_set_hw_serialize(ifsq, Q_SLIZE);
260 * ifsq_watchdog_init(Q_WDOG, ifsq, Q_WDOG_FUNC);
263 * Q_CPUID, the cpu which handles the hardware transmit queue interrupt
264 * Q_SLIZE, the serializer protects the hardware transmit queue
265 * Q_WDOG, per hardware transmit queue watchdog handler, struct ifsubq_watchdog
266 * Q_WDOG_FUNC, watchdog function, probably should reset hardware
270 * Make sure per hardware transmit queue watchdog is stopped and oactive is
273 * for (i = 0; i < QCOUNT, ++i) {
274 * ifsq_clr_oactive(ifsq);
275 * ifsq_watchdog_stop(Q_WDOG);
280 * Make sure per hardware transmit queue watchdog is started and oactive is
283 * for (i = 0; i < QCOUNT, ++i) {
284 * ifsq_clr_oactive(ifsq);
285 * ifsq_watchdog_start(Q_WDOG);
290 * if_start takes subqueue as parameter, so instead of using ifq_ functions
291 * ifsq_ functions should be used. If device could not be programmed to
292 * transmit when no media link is not up, MAKE SURE to purge the subqueue:
294 * if ((ifp->if_flags & IFF_RUNNING) == 0 || ifsq_is_oactive(ifsq))
301 * if (NO_FREE_DESC) {
302 * ifsq_set_oactive(ifsq);
305 * m = ifsq_dequeue(ifsq);
308 * Q_WDOG.wd_timer = WDOG_TIMEOUT;
311 * 5) Transmission done, e.g. transmit queue interrupt processing
313 * Same as if_start, ifsq_ functions should be used:
315 * DRIVER_COLLECT_DESC();
317 * ifsq_clr_oactive(ifsq);
318 * if (NO_PENDING_DESC)
319 * Q_WDOG.wd_timer = 0;
320 * if (!ifsq_is_empty(ifsq))
321 * ifsq_devstart(ifsq);
324 void *if_softc; /* pointer to driver state */
325 void *if_l2com; /* pointer to protocol bits */
326 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */
327 char if_xname[IFNAMSIZ]; /* external name (name + unit) */
328 const char *if_dname; /* driver name */
329 int if_dunit; /* unit or IF_DUNIT_NONE */
330 void *if_vlantrunks; /* vlan trunks */
331 struct ifaddrhead *if_addrheads; /* per-cpu per-if addresses */
332 int if_pcount; /* number of promiscuous listeners */
333 void *if_carp; /* carp interfaces */
334 struct bpf_if *if_bpf; /* packet filter structure */
335 u_short if_index; /* numeric abbreviation for this if */
336 short if_timer; /* time 'til if_watchdog called */
337 int if_flags; /* up/down, broadcast, etc. */
338 int if_capabilities; /* interface capabilities */
339 int if_capenable; /* enabled features */
340 void *if_linkmib; /* link-type-specific MIB data */
341 size_t if_linkmiblen; /* length of above data */
342 struct if_data if_data; /* NOTE: stats are in if_data_pcpu */
343 struct ifmultihead if_multiaddrs; /* multicast addresses configured */
344 int if_amcount; /* number of all-multicast requests */
345 /* procedure handles */
346 int (*if_output) /* output routine (enqueue) */
347 (struct ifnet *, struct mbuf *, struct sockaddr *,
349 void (*if_input) /* input routine from hardware driver */
350 (struct ifnet *, struct mbuf *,
351 const struct pktinfo *pi, int cpuid);
352 void (*if_start) /* initiate output routine */
353 (struct ifnet *, struct ifaltq_subque *);
354 int (*if_ioctl) /* ioctl routine */
355 (struct ifnet *, u_long, caddr_t, struct ucred *);
356 void (*if_watchdog) /* timer routine */
358 void (*if_init) /* init routine */
360 int (*if_resolvemulti) /* validate/resolve multicast */
361 (struct ifnet *, struct sockaddr **, struct sockaddr *);
363 TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
364 int (*if_mapsubq) /* cpuid to if_snd subqueue map */
365 (struct ifaltq *, int);
369 * ifnet serialize functions
372 (struct ifnet *, enum ifnet_serialize);
373 void (*if_deserialize)
374 (struct ifnet *, enum ifnet_serialize);
375 int (*if_tryserialize)
376 (struct ifnet *, enum ifnet_serialize);
378 void (*if_serialize_assert)
379 (struct ifnet *, enum ifnet_serialize, boolean_t);
382 void (*if_serialize_unused)(void);
386 void (*if_npoll) /* polling config */
387 (struct ifnet *, struct ifpoll_info *);
390 void (*if_npoll_unused)(void);
392 int if_tsolen; /* max TSO length */
393 struct ifaltq if_snd; /* output subqueues */
394 const uint8_t *if_broadcastaddr;
395 void *if_bridge; /* bridge glue */
396 void *if_lagg; /* lagg glue */
397 void *if_afdata[AF_MAX];
398 struct ifaddr *if_lladdr;
400 /* serializer, in single serializer mode */
401 struct lwkt_serialize *if_serializer;
403 * default serializer, in single serializer mode,
404 * if driver does not supply one
406 struct lwkt_serialize if_default_serializer;
409 struct ifdata_pcpu *if_data_pcpu; /* per-cpu stats */
410 void *if_pf_kif; /* pf interface */
413 typedef void if_init_f_t (void *);
415 #define if_mtu if_data.ifi_mtu
416 #define if_type if_data.ifi_type
417 #define if_physical if_data.ifi_physical
418 #define if_addrlen if_data.ifi_addrlen
419 #define if_hdrlen if_data.ifi_hdrlen
420 #define if_metric if_data.ifi_metric
421 #define if_link_state if_data.ifi_link_state
422 #define if_baudrate if_data.ifi_baudrate
423 #define if_hwassist if_data.ifi_hwassist
424 #define if_ipackets if_data.ifi_ipackets
425 #define if_ierrors if_data.ifi_ierrors
426 #define if_opackets if_data.ifi_opackets
427 #define if_oerrors if_data.ifi_oerrors
428 #define if_collisions if_data.ifi_collisions
429 #define if_ibytes if_data.ifi_ibytes
430 #define if_obytes if_data.ifi_obytes
431 #define if_imcasts if_data.ifi_imcasts
432 #define if_omcasts if_data.ifi_omcasts
433 #define if_iqdrops if_data.ifi_iqdrops
434 #define if_noproto if_data.ifi_noproto
435 #define if_lastchange if_data.ifi_lastchange
436 #define if_recvquota if_data.ifi_recvquota
437 #define if_xmitquota if_data.ifi_xmitquota
438 #define if_rawoutput(if, m, sa) if_output(if, m, sa, NULL)
440 /* for compatibility with other BSDs */
441 #define if_list if_link
444 * Per-cpu interface statistics
447 u_long ifd_ipackets; /* packets received on interface */
448 u_long ifd_ierrors; /* input errors on interface */
449 u_long ifd_opackets; /* packets sent on interface */
450 u_long ifd_oerrors; /* output errors on interface */
451 u_long ifd_collisions; /* collisions on csma interfaces */
452 u_long ifd_ibytes; /* total number of octets received */
453 u_long ifd_obytes; /* total number of octets sent */
454 u_long ifd_imcasts; /* packets received via multicast */
455 u_long ifd_omcasts; /* packets sent via multicast */
456 u_long ifd_iqdrops; /* dropped on input, this interface */
457 u_long ifd_noproto; /* destined for unsupported protocol */
460 #endif /* _KERNEL || _KERNEL_STRUCTURES */
463 * ifqueue operation macros
465 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
466 #define IF_DROP(ifq) ((ifq)->ifq_drops++)
467 #define IF_QLEN(ifq) ((ifq)->ifq_len)
468 #define IF_QEMPTY(ifq) (IF_QLEN(ifq) == 0)
470 #define IF_ENQUEUE(ifq, m) do { \
471 (m)->m_nextpkt = NULL; \
472 if ((ifq)->ifq_tail == NULL) \
473 (ifq)->ifq_head = m; \
475 (ifq)->ifq_tail->m_nextpkt = m; \
476 (ifq)->ifq_tail = m; \
480 #define IF_PREPEND(ifq, m) do { \
481 (m)->m_nextpkt = (ifq)->ifq_head; \
482 if ((ifq)->ifq_tail == NULL) \
483 (ifq)->ifq_tail = (m); \
484 (ifq)->ifq_head = (m); \
488 #define IF_DEQUEUE(ifq, m) do { \
489 (m) = (ifq)->ifq_head; \
491 if (((ifq)->ifq_head = (m)->m_nextpkt) == NULL) \
492 (ifq)->ifq_tail = NULL; \
493 (m)->m_nextpkt = NULL; \
498 #define IF_POLL(ifq, m) ((m) = (ifq)->ifq_head)
500 #define IF_DRAIN(ifq) do { \
503 IF_DEQUEUE(ifq, m); \
512 /* interface link layer address change event */
513 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
514 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
517 #define ASSERT_IFNET_SERIALIZED_ALL(ifp) \
518 (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, TRUE)
519 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp) \
520 (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, FALSE)
522 #define ASSERT_IFNET_SERIALIZED_ALL(ifp) ((void)0)
523 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp) ((void)0)
527 ifnet_serialize_all(struct ifnet *_ifp)
529 _ifp->if_serialize(_ifp, IFNET_SERIALIZE_ALL);
533 ifnet_deserialize_all(struct ifnet *_ifp)
535 _ifp->if_deserialize(_ifp, IFNET_SERIALIZE_ALL);
539 ifnet_tryserialize_all(struct ifnet *_ifp)
541 return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_ALL);
545 * 72 was chosen below because it is the size of a TCP/IP
546 * header (40) + the minimum mss (32).
549 #define IF_MAXMTU 65535
555 struct in_ifaddr_container {
556 struct in_ifaddr *ia;
557 LIST_ENTRY(in_ifaddr_container) ia_hash;
558 /* entry in bucket of inet addresses */
559 TAILQ_ENTRY(in_ifaddr_container) ia_link;
560 /* list of internet addresses */
561 struct ifaddr_container *ia_ifac; /* parent ifaddr_container */
565 * Per-cpu ifaddr container:
566 * - per-cpu ifaddr reference count
567 * - linkage to per-cpu addresses lists
568 * - per-cpu ifaddr statistics
570 struct ifaddr_container {
571 #define IFA_CONTAINER_MAGIC 0x19810219
572 #define IFA_CONTAINER_DEAD 0xc0dedead
573 uint32_t ifa_magic; /* IFA_CONTAINER_MAGIC */
575 TAILQ_ENTRY(ifaddr_container) ifa_link; /* queue macro glue */
576 u_int ifa_refcnt; /* references to this structure */
577 uint16_t ifa_listmask; /* IFA_LIST_ */
578 uint16_t ifa_prflags; /* protocol specific flags */
580 u_long ifa_ipackets; /* packets received on addr */
581 u_long ifa_ibytes; /* bytes received on addr */
582 u_long ifa_opackets; /* packets sent on addr */
583 u_long ifa_obytes; /* bytes sent on addr */
586 * Protocol specific states
589 struct in_ifaddr_container u_in_ifac;
593 #define IFA_LIST_IFADDRHEAD 0x01 /* on ifnet.if_addrheads[cpuid] */
594 #define IFA_LIST_IN_IFADDRHEAD 0x02 /* on in_ifaddrheads[cpuid] */
595 #define IFA_LIST_IN_IFADDRHASH 0x04 /* on in_ifaddrhashtbls[cpuid] */
597 #define IFA_PRF_FLAG0 0x01
598 #define IFA_PRF_FLAG1 0x02
599 #define IFA_PRF_FLAG2 0x04
600 #define IFA_PRF_FLAG3 0x08
603 * The ifaddr structure contains information about one address
604 * of an interface. They are maintained by the different address families,
605 * are allocated and attached when an address is set, and are linked
606 * together so all addresses for an interface can be located.
609 * Statistics are no longer stored in if_data, instead, they are stored
610 * in the per-cpu ifaddr_container. So don't use the old style
611 * ifa->if_ipackets++ to update statistics, use IFA_STAT_ macros.
614 struct sockaddr *ifa_addr; /* address of interface */
615 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
616 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
617 struct sockaddr *ifa_netmask; /* used to determine subnet */
618 struct if_data if_data; /* not all members are meaningful */
619 struct ifnet *ifa_ifp; /* back-pointer to interface */
621 struct ifaddr_container *ifa_containers; /* per-cpu data */
622 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
623 (int, struct rtentry *);
624 u_short ifa_flags; /* mostly rt_flags for cloning */
625 int ifa_ncnt; /* # of valid ifaddr_container */
626 int ifa_metric; /* cost of going out this interface */
628 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */
630 int (*ifa_claim_addr) /* check if an addr goes to this if */
631 (struct ifaddr *, struct sockaddr *);
634 #define IFA_ROUTE RTF_UP /* route installed */
636 /* for compatibility with other BSDs */
637 #define ifa_list ifa_link
640 * Multicast address structure. This is analogous to the ifaddr
641 * structure except that it keeps track of multicast addresses.
642 * Also, the reference count here is a count of requests for this
643 * address, not a count of pointers to this structure.
646 TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
647 struct sockaddr *ifma_addr; /* address this membership is for */
648 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
649 struct ifnet *ifma_ifp; /* back-pointer to interface */
650 u_int ifma_refcount; /* reference count */
651 void *ifma_protospec; /* protocol-specific state, if any */
656 struct ifaddr_marker {
658 struct ifaddr_container ifac;
659 struct sockaddr addr;
660 struct sockaddr netmask;
661 struct sockaddr dstaddr;
665 * ifaddr statistics update macro
667 #define IFA_STAT_INC(ifa, name, v) \
669 (ifa)->ifa_containers[mycpuid].ifa_##name += (v); \
673 * Interface (ifnet) statistics update macros
675 #define IFNET_STAT_INC(ifp, name, v) \
677 (ifp)->if_data_pcpu[mycpuid].ifd_##name += (v); \
680 #define IFNET_STAT_SET(ifp, name, v) \
683 (ifp)->if_data_pcpu[0].ifd_##name = (v); \
684 for (_cpu = 1; _cpu < ncpus; ++_cpu) \
685 (ifp)->if_data_pcpu[_cpu].ifd_##name = 0; \
688 #define IFNET_STAT_GET(ifp, name, v) \
691 (v) = (ifp)->if_data_pcpu[0].ifd_##name; \
692 for (_cpu = 1; _cpu < ncpus; ++_cpu) \
693 (v) += (ifp)->if_data_pcpu[_cpu].ifd_##name; \
696 #ifndef _SYS_SERIALIZE2_H_
697 #include <sys/serialize2.h>
706 /* interface address change event */
707 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *,
708 enum ifaddr_event, struct ifaddr *);
709 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
710 /* new interface attach event */
711 typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *);
712 EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t);
713 /* interface detach event */
714 typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *);
715 EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t);
717 /* Array of all ifnets in the system */
719 int ifnet_count; /* # of elem. in ifnet_arr */
720 int ifnet_pad; /* explicit */
721 struct ifnet *ifnet_arr[];
728 char ifg_group[IFNAMSIZ];
731 int ifg_carp_demoted;
732 TAILQ_HEAD(, ifg_member) ifg_members;
733 TAILQ_ENTRY(ifg_group) ifg_next;
737 TAILQ_ENTRY(ifg_member) ifgm_next;
738 struct ifnet *ifgm_ifp;
742 struct ifg_group *ifgl_group;
743 TAILQ_ENTRY(ifg_list) ifgl_next;
746 /* group attach event */
747 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
748 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
749 /* group detach event */
750 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
751 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
752 /* group change event */
753 typedef void (*group_change_event_handler_t)(void *, const char *);
754 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
758 #define ASSERT_IFAC_VALID(ifac) do { \
759 KKASSERT((ifac)->ifa_magic == IFA_CONTAINER_MAGIC); \
760 KKASSERT((ifac)->ifa_refcnt > 0); \
763 #define ASSERT_IFAC_VALID(ifac) ((void)0)
767 _IFAREF(struct ifaddr *_ifa, int _cpu_id)
769 struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
772 ASSERT_IFAC_VALID(_ifac);
778 IFAREF(struct ifaddr *_ifa)
780 _IFAREF(_ifa, mycpuid);
783 #include <sys/malloc.h>
785 MALLOC_DECLARE(M_IFADDR);
786 MALLOC_DECLARE(M_IFMADDR);
787 MALLOC_DECLARE(M_IFNET);
789 void ifac_free(struct ifaddr_container *, int);
792 _IFAFREE(struct ifaddr *_ifa, int _cpu_id)
794 struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
797 ASSERT_IFAC_VALID(_ifac);
798 if (--_ifac->ifa_refcnt == 0)
799 ifac_free(_ifac, _cpu_id);
804 IFAFREE(struct ifaddr *_ifa)
806 _IFAFREE(_ifa, mycpuid);
809 struct lwkt_port *ifnet_portfn(int);
810 int ifnet_domsg(struct lwkt_msg *, int);
811 void ifnet_sendmsg(struct lwkt_msg *, int);
812 void ifnet_forwardmsg(struct lwkt_msg *, int);
815 ifa_domsg(struct lwkt_msg *_lmsg, int _cpu)
817 return ifnet_domsg(_lmsg, _cpu);
821 ifa_sendmsg(struct lwkt_msg *_lmsg, int _cpu)
823 ifnet_sendmsg(_lmsg, _cpu);
827 ifa_forwardmsg(struct lwkt_msg *_lmsg, int _nextcpu)
829 ifnet_forwardmsg(_lmsg, _nextcpu);
833 ifnet_serialize_array_enter(lwkt_serialize_t *_arr, int _arrcnt,
834 enum ifnet_serialize _slz)
836 KKASSERT(_slz == IFNET_SERIALIZE_ALL);
837 lwkt_serialize_array_enter(_arr, _arrcnt, 0);
841 ifnet_serialize_array_exit(lwkt_serialize_t *_arr, int _arrcnt,
842 enum ifnet_serialize _slz)
844 KKASSERT(_slz == IFNET_SERIALIZE_ALL);
845 lwkt_serialize_array_exit(_arr, _arrcnt, 0);
849 ifnet_serialize_array_try(lwkt_serialize_t *_arr, int _arrcnt,
850 enum ifnet_serialize _slz)
852 KKASSERT(_slz == IFNET_SERIALIZE_ALL);
853 return lwkt_serialize_array_try(_arr, _arrcnt, 0);
859 ifnet_serialize_array_assert(lwkt_serialize_t *_arr, int _arrcnt,
860 enum ifnet_serialize _slz, boolean_t _serialized)
864 KKASSERT(_slz == IFNET_SERIALIZE_ALL);
866 for (_i = 0; _i < _arrcnt; ++_i)
867 ASSERT_SERIALIZED(_arr[_i]);
869 for (_i = 0; _i < _arrcnt; ++_i)
870 ASSERT_NOT_SERIALIZED(_arr[_i]);
874 #endif /* INVARIANTS */
876 #define REINPUT_KEEPRCVIF 0x0001 /* ether_reinput_oncpu() */
877 #define REINPUT_RUNBPF 0x0002 /* ether_reinput_oncpu() */
880 * MPSAFE NOTE for ifnet queue (ifnet), ifnet array, ifunit() and
883 * - ifnet queue must only be accessed by non-netisr threads and
884 * ifnet lock must be held (by ifnet_lock()).
885 * - If accessing ifnet queue is needed in netisrs, ifnet array
886 * (obtained through ifnet_array_get()) must be used instead.
887 * There is no need to (must not, actually) hold ifnet lock for
888 * ifnet array accessing.
889 * - ifindex2ifnet could be accessed by both non-netisr threads and
890 * netisrs. Accessing ifindex2ifnet in non-netisr threads must be
891 * protected by ifnet lock (by ifnet_lock()). Accessing
892 * ifindex2ifnet in netisrs is lockless MPSAFE and ifnet lock must
893 * not be held. However, ifindex2ifnet should be saved in a stack
894 * variable to get a consistent view of ifindex2ifnet, if
895 * ifindex2ifnet is accessed multiple times from a function in
897 * - ifunit() must only be called in non-netisr threads and ifnet
898 * lock must be held before calling this function and for the
899 * accessing of the ifp returned by this function.
900 * - If ifunit() is needed in netisr, ifunit_netisr() must be used
901 * instead. There is no need to (must not, actually) hold ifnet
902 * lock for ifunit_netisr() and the returned ifp.
904 extern struct ifnethead ifnet;
905 #define ifnetlist ifnet /* easily distinguished ifnet alias */
907 extern struct ifnet **ifindex2ifnet;
910 struct ifnet *ifunit(const char *);
911 struct ifnet *ifunit_netisr(const char *);
912 const struct ifnet_array *ifnet_array_get(void);
913 int ifnet_array_isempty(void);
915 extern int ifqmaxlen;
916 extern struct ifnet loif[];
921 void ether_ifattach(struct ifnet *, const uint8_t *,
922 struct lwkt_serialize *);
923 void ether_ifattach_bpf(struct ifnet *, const uint8_t *, u_int, u_int,
924 struct lwkt_serialize *);
925 void ether_ifdetach(struct ifnet *);
926 void ether_demux(struct mbuf *);
927 void ether_demux_oncpu(struct ifnet *, struct mbuf *);
928 void ether_reinput_oncpu(struct ifnet *, struct mbuf *, int);
929 void ether_input(struct ifnet *, struct mbuf *,
930 const struct pktinfo *, int);
931 int ether_output_frame(struct ifnet *, struct mbuf *);
932 int ether_ioctl(struct ifnet *, u_long, caddr_t);
933 u_char *kether_aton(const char *, u_char *);
934 char *kether_ntoa(const u_char *, char *);
935 struct ifnet *ether_bridge_interface(struct ifnet *ifp);
936 uint32_t ether_crc32_le(const uint8_t *, size_t);
937 uint32_t ether_crc32_be(const uint8_t *, size_t);
939 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
940 int if_addmulti_serialized(struct ifnet *, struct sockaddr *,
941 struct ifmultiaddr **);
942 int if_allmulti(struct ifnet *, int);
943 void if_attach(struct ifnet *, struct lwkt_serialize *);
944 int if_delmulti(struct ifnet *, struct sockaddr *);
945 void if_delallmulti_serialized(struct ifnet *ifp);
946 void if_purgeaddrs_nolink(struct ifnet *);
947 void if_detach(struct ifnet *);
948 void if_down(struct ifnet *);
949 void if_link_state_change(struct ifnet *);
950 void if_initname(struct ifnet *, const char *, int);
951 int if_getanyethermac(uint16_t *, int);
952 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
953 struct ifnet *if_alloc(uint8_t);
954 void if_free(struct ifnet *);
955 void if_route(struct ifnet *, int flag, int fam);
956 int if_setlladdr(struct ifnet *, const u_char *, int);
957 void if_unroute(struct ifnet *, int flag, int fam);
958 void if_up(struct ifnet *);
959 /*void ifinit(void);*/ /* declared in systm.h for main() */
960 int ifioctl(struct socket *, u_long, caddr_t, struct ucred *);
961 int ifpromisc(struct ifnet *, int);
963 struct ifg_group *if_creategroup(const char *);
964 int if_addgroup(struct ifnet *, const char *);
965 int if_delgroup(struct ifnet *, const char *);
966 int if_getgroup(caddr_t, struct ifnet *);
967 int if_getgroupmembers(caddr_t);
969 struct ifaddr *ifa_ifwithaddr(struct sockaddr *);
970 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
971 struct ifaddr *ifa_ifwithnet(struct sockaddr *);
972 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
973 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
975 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
976 typedef void if_com_free_t(void *com, u_char type);
977 void if_register_com_alloc(u_char, if_com_alloc_t *a, if_com_free_t *);
978 void if_deregister_com_alloc(u_char);
980 void *ifa_create(int, int);
981 void ifa_destroy(struct ifaddr *);
982 void ifa_iflink(struct ifaddr *, struct ifnet *, int);
983 void ifa_ifunlink(struct ifaddr *, struct ifnet *);
984 void ifa_marker_init(struct ifaddr_marker *, struct ifnet *);
986 struct ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
987 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
988 void if_devstart(struct ifnet *ifp); /* COMPAT */
989 void if_devstart_sched(struct ifnet *ifp); /* COMPAT */
990 int if_ring_count2(int cnt, int cnt_max);
992 void ifnet_lock(void);
993 void ifnet_unlock(void);
995 #define IF_LLSOCKADDR(ifp) \
996 ((struct sockaddr_dl *)(ifp)->if_lladdr->ifa_addr)
997 #define IF_LLADDR(ifp) LLADDR(IF_LLSOCKADDR(ifp))
1000 int ifpoll_register(struct ifnet *);
1001 int ifpoll_deregister(struct ifnet *);
1002 #endif /* IFPOLL_ENABLE */
1004 #endif /* _KERNEL */
1006 #endif /* !_NET_IF_VAR_H_ */