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 $
35 * $DragonFly: src/sys/net/if_var.h,v 1.71 2008/11/22 04:00:53 sephe Exp $
38 #ifndef _NET_IF_VAR_H_
39 #define _NET_IF_VAR_H_
41 #ifndef _SYS_SERIALIZE_H_
42 #include <sys/serialize.h>
49 * Structures defining a network interface, providing a packet
50 * transport mechanism (ala level 0 of the PUP protocols).
52 * Each interface accepts output datagrams of a specified maximum
53 * length, and provides higher level routines with input datagrams
54 * received from its medium.
56 * Output occurs when the routine if_output is called, with four parameters:
57 * ifp->if_output(ifp, m, dst, rt)
58 * Here m is the mbuf chain to be sent and dst is the destination address.
59 * The output routine encapsulates the supplied datagram if necessary,
60 * and then transmits it on its medium.
62 * On input, each interface unwraps the data received by it, and either
63 * places it on the input queue of a internetwork datagram routine
64 * and posts the associated software interrupt, or passes the datagram to
65 * the routine if_input. It is called with the mbuf chain as parameter:
66 * ifp->if_input(ifp, m)
67 * The input routine removes the protocol dependent header if necessary.
69 * Routines exist for locating interfaces by their addresses
70 * or for locating a interface on a certain network, as well as more general
71 * routing and gateway routines maintaining information used to locate
72 * interfaces. These routines live in the files if.c and route.c
76 * Forward structure declarations for function prototypes [sic].
86 struct lwkt_serialize;
87 struct ifaddr_container;
94 #include <sys/queue.h> /* get TAILQ macros */
96 #include <net/altq/if_altq.h>
99 #include <sys/eventhandler.h>
100 #include <sys/mbuf.h>
101 #include <sys/systm.h> /* XXX */
102 #include <sys/thread2.h>
105 #define IF_DUNIT_NONE -1
107 TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */
108 TAILQ_HEAD(ifaddrhead, ifaddr_container); /* instantiation is preserved in the list */
109 TAILQ_HEAD(ifprefixhead, ifprefix);
110 LIST_HEAD(ifmultihead, ifmultiaddr);
113 * Structure defining a queue for a network interface.
116 struct mbuf *ifq_head;
117 struct mbuf *ifq_tail;
124 * Note of DEVICE_POLLING
125 * 1) Any file(*.c) that depends on DEVICE_POLLING supports in this
126 * file should include opt_polling.h at its beginning.
127 * 2) When struct changes, which are conditioned by DEVICE_POLLING,
128 * are to be introduced, please keep the struct's size and layout
129 * same, no matter whether DEVICE_POLLING is defined or not.
130 * See ifnet.if_poll and ifnet.if_poll_unused for example.
133 #ifdef DEVICE_POLLING
134 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER,
139 * Structure defining a network interface.
141 * (Would like to call this struct ``if'', but C isn't PL/1.)
145 * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with
146 * one of these structures, typically held within an arpcom structure.
148 * struct <foo>_softc {
150 * struct ifnet ac_if;
156 * The assumption is used in a number of places, including many
157 * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
159 * Unfortunately devices' softc are opaque, so we depend on this layout
160 * to locate the struct ifnet from the softc in the generic code.
164 * ifnet is protected by if_serializer. ifnet.if_snd is protected by its
165 * own spinlock. Callers of if_ioctl, if_start, if_watchdog, if_init,
166 * if_resolvemulti, and if_poll hold if_serializer. Device drivers usually
167 * use the same serializer for their interrupt but this is not required.
168 * Caller of if_output must not hold if_serializer; if_output should hold
169 * if_serializer based on its own needs. However, the device driver must
170 * be holding if_serializer when it calls if_input. Note that the serializer
171 * may be temporarily released within if_input to avoid a deadlock (e.g. when
172 * fast-forwarding or bridging packets between interfaces).
174 * If a device driver installs the same serializer for its interrupt
175 * as for ifnet, then the driver only really needs to worry about further
176 * serialization in timeout based entry points. All other entry points
177 * will already be serialized. Older ISA drivers still using the old
178 * interrupt infrastructure will have to obtain and release the serializer
179 * in their interrupt routine themselves.
182 void *if_softc; /* pointer to driver state */
183 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */
184 char if_xname[IFNAMSIZ]; /* external name (name + unit) */
185 const char *if_dname; /* driver name */
186 int if_dunit; /* unit or IF_DUNIT_NONE */
187 void *if_vlantrunks; /* vlan trunks */
188 struct ifaddrhead *if_addrheads; /* array[NCPU] of TAILQs of addresses per if */
189 int if_pcount; /* number of promiscuous listeners */
190 void *if_carp; /* carp interfaces */
191 struct bpf_if *if_bpf; /* packet filter structure */
192 u_short if_index; /* numeric abbreviation for this if */
193 short if_timer; /* time 'til if_watchdog called */
194 int if_flags; /* up/down, broadcast, etc. */
195 int if_capabilities; /* interface capabilities */
196 int if_capenable; /* enabled features */
197 void *if_linkmib; /* link-type-specific MIB data */
198 size_t if_linkmiblen; /* length of above data */
199 struct if_data if_data;
200 struct ifmultihead if_multiaddrs; /* multicast addresses configured */
201 int if_amcount; /* number of all-multicast requests */
202 /* procedure handles */
203 int (*if_output) /* output routine (enqueue) */
204 (struct ifnet *, struct mbuf *, struct sockaddr *,
206 void (*if_input) /* input routine from hardware driver */
207 (struct ifnet *, struct mbuf *);
208 void (*if_start) /* initiate output routine */
210 int (*if_ioctl) /* ioctl routine */
211 (struct ifnet *, u_long, caddr_t, struct ucred *);
212 void (*if_watchdog) /* timer routine */
214 void (*if_init) /* Init routine */
216 int (*if_resolvemulti) /* validate/resolve multicast */
217 (struct ifnet *, struct sockaddr **, struct sockaddr *);
218 int (*if_start_cpuid) /* cpuid to run if_start */
220 #ifdef DEVICE_POLLING
221 void (*if_poll) /* IFF_POLLING support */
222 (struct ifnet *, enum poll_cmd, int);
226 void (*if_poll_unused)(void);
227 int if_poll_cpuid_used;
229 struct ifaltq if_snd; /* output queue (includes altq) */
230 struct ifprefixhead if_prefixhead; /* list of prefixes per if */
231 const uint8_t *if_broadcastaddr;
232 void *if_bridge; /* bridge glue */
233 void *if_afdata[AF_MAX];
234 struct ifaddr *if_lladdr;
235 struct lwkt_serialize *if_serializer; /* serializer or MP lock */
236 struct lwkt_serialize if_default_serializer; /* if not supplied */
238 struct netmsg *if_start_nmsg; /* percpu messages to schedule if_start */
240 typedef void if_init_f_t (void *);
242 #define if_mtu if_data.ifi_mtu
243 #define if_type if_data.ifi_type
244 #define if_physical if_data.ifi_physical
245 #define if_addrlen if_data.ifi_addrlen
246 #define if_hdrlen if_data.ifi_hdrlen
247 #define if_metric if_data.ifi_metric
248 #define if_link_state if_data.ifi_link_state
249 #define if_baudrate if_data.ifi_baudrate
250 #define if_hwassist if_data.ifi_hwassist
251 #define if_ipackets if_data.ifi_ipackets
252 #define if_ierrors if_data.ifi_ierrors
253 #define if_opackets if_data.ifi_opackets
254 #define if_oerrors if_data.ifi_oerrors
255 #define if_collisions if_data.ifi_collisions
256 #define if_ibytes if_data.ifi_ibytes
257 #define if_obytes if_data.ifi_obytes
258 #define if_imcasts if_data.ifi_imcasts
259 #define if_omcasts if_data.ifi_omcasts
260 #define if_iqdrops if_data.ifi_iqdrops
261 #define if_noproto if_data.ifi_noproto
262 #define if_lastchange if_data.ifi_lastchange
263 #define if_recvquota if_data.ifi_recvquota
264 #define if_xmitquota if_data.ifi_xmitquota
265 #define if_rawoutput(if, m, sa) if_output(if, m, sa, NULL)
267 /* for compatibility with other BSDs */
268 #define if_list if_link
272 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
273 * are queues of messages stored on ifqueue structures
274 * (defined above). Entries are added to and deleted from these structures
275 * by these macros, which should be called with ipl raised to splimp().
277 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
278 #define IF_DROP(ifq) ((ifq)->ifq_drops++)
279 #define IF_QLEN(ifq) ((ifq)->ifq_len)
280 #define IF_QEMPTY(ifq) (IF_QLEN(ifq) == 0)
281 #define IF_ENQUEUE(ifq, m) do { \
282 (m)->m_nextpkt = 0; \
283 if ((ifq)->ifq_tail == 0) \
284 (ifq)->ifq_head = m; \
286 (ifq)->ifq_tail->m_nextpkt = m; \
287 (ifq)->ifq_tail = m; \
290 #define IF_PREPEND(ifq, m) do { \
291 (m)->m_nextpkt = (ifq)->ifq_head; \
292 if ((ifq)->ifq_tail == 0) \
293 (ifq)->ifq_tail = (m); \
294 (ifq)->ifq_head = (m); \
297 #define IF_DEQUEUE(ifq, m) do { \
298 (m) = (ifq)->ifq_head; \
300 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
301 (ifq)->ifq_tail = 0; \
302 (m)->m_nextpkt = 0; \
307 #define IF_POLL(ifq, m) ((m) = (ifq)->ifq_head)
309 #define IF_DRAIN(ifq) do { \
312 IF_DEQUEUE(ifq, m); \
322 * DEPRECATED - should not be used by any new driver. This code uses the
323 * old queueing interface and if_start ABI and does not use the ifp's
326 #define IF_HANDOFF(ifq, m, ifp) if_handoff(ifq, m, ifp, 0)
327 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj) if_handoff(ifq, m, ifp, adj)
330 if_handoff(struct ifqueue *_ifq, struct mbuf *_m, struct ifnet *_ifp,
333 int _need_if_start = 0;
337 if (IF_QFULL(_ifq)) {
344 _ifp->if_obytes += _m->m_pkthdr.len + _adjust;
345 if (_m->m_flags & M_MCAST)
347 _need_if_start = !(_ifp->if_flags & IFF_OACTIVE);
349 IF_ENQUEUE(_ifq, _m);
350 if (_need_if_start) {
351 (*_ifp->if_start)(_ifp);
358 * 72 was chosen below because it is the size of a TCP/IP
359 * header (40) + the minimum mss (32).
362 #define IF_MAXMTU 65535
368 struct in_ifaddr_container {
369 struct in_ifaddr *ia;
370 LIST_ENTRY(in_ifaddr_container) ia_hash;
371 /* entry in bucket of inet addresses */
372 TAILQ_ENTRY(in_ifaddr_container) ia_link;
373 /* list of internet addresses */
374 struct ifaddr_container *ia_ifac; /* parent ifaddr_container */
377 struct ifaddr_container {
378 #define IFA_CONTAINER_MAGIC 0x19810219
379 #define IFA_CONTAINER_DEAD 0xc0dedead
380 uint32_t ifa_magic; /* IFA_CONTAINER_MAGIC */
382 TAILQ_ENTRY(ifaddr_container) ifa_link; /* queue macro glue */
383 u_int ifa_refcnt; /* references to this structure */
384 uint16_t ifa_listmask; /* IFA_LIST_ */
385 uint16_t ifa_prflags; /* protocol specific flags */
388 * Protocol specific states
391 struct in_ifaddr_container u_in_ifac;
395 #define IFA_LIST_IFADDRHEAD 0x01 /* on ifnet.if_addrheads[cpuid] */
396 #define IFA_LIST_IN_IFADDRHEAD 0x02 /* on in_ifaddrheads[cpuid] */
397 #define IFA_LIST_IN_IFADDRHASH 0x04 /* on in_ifaddrhashtbls[cpuid] */
399 #define IFA_PRF_FLAG0 0x01
400 #define IFA_PRF_FLAG1 0x02
401 #define IFA_PRF_FLAG2 0x04
402 #define IFA_PRF_FLAG3 0x08
405 * The ifaddr structure contains information about one address
406 * of an interface. They are maintained by the different address families,
407 * are allocated and attached when an address is set, and are linked
408 * together so all addresses for an interface can be located.
411 struct sockaddr *ifa_addr; /* address of interface */
412 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
413 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
414 struct sockaddr *ifa_netmask; /* used to determine subnet */
415 struct if_data if_data; /* not all members are meaningful */
416 struct ifnet *ifa_ifp; /* back-pointer to interface */
418 struct ifaddr_container *ifa_containers;
419 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
420 (int, struct rtentry *, struct rt_addrinfo *);
421 u_short ifa_flags; /* mostly rt_flags for cloning */
422 int ifa_ncnt; /* # of valid ifaddr_container */
423 int ifa_metric; /* cost of going out this interface */
425 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */
427 int (*ifa_claim_addr) /* check if an addr goes to this if */
428 (struct ifaddr *, struct sockaddr *);
431 #define IFA_ROUTE RTF_UP /* route installed */
433 /* for compatibility with other BSDs */
434 #define ifa_list ifa_link
437 * The prefix structure contains information about one prefix
438 * of an interface. They are maintained by the different address families,
439 * are allocated and attached when an prefix or an address is set,
440 * and are linked together so all prefixes for an interface can be located.
443 struct sockaddr *ifpr_prefix; /* prefix of interface */
444 struct ifnet *ifpr_ifp; /* back-pointer to interface */
445 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
446 u_char ifpr_plen; /* prefix length in bits */
447 u_char ifpr_type; /* protocol dependent prefix type */
451 * Multicast address structure. This is analogous to the ifaddr
452 * structure except that it keeps track of multicast addresses.
453 * Also, the reference count here is a count of requests for this
454 * address, not a count of pointers to this structure.
457 LIST_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
458 struct sockaddr *ifma_addr; /* address this membership is for */
459 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
460 struct ifnet *ifma_ifp; /* back-pointer to interface */
461 u_int ifma_refcount; /* reference count */
462 void *ifma_protospec; /* protocol-specific state, if any */
473 /* interface address change event */
474 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *,
475 enum ifaddr_event, struct ifaddr *);
476 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
477 /* new interface attach event */
478 typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *);
479 EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t);
480 /* interface detach event */
481 typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *);
482 EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t);
485 #define ASSERT_IFAC_VALID(ifac) do { \
486 KKASSERT((ifac)->ifa_magic == IFA_CONTAINER_MAGIC); \
487 KKASSERT((ifac)->ifa_refcnt > 0); \
490 #define ASSERT_IFAC_VALID(ifac) ((void)0)
494 _IFAREF(struct ifaddr *_ifa, int _cpu_id)
496 struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
499 ASSERT_IFAC_VALID(_ifac);
505 IFAREF(struct ifaddr *_ifa)
507 _IFAREF(_ifa, mycpuid);
510 #include <sys/malloc.h>
512 MALLOC_DECLARE(M_IFADDR);
513 MALLOC_DECLARE(M_IFMADDR);
515 void ifac_free(struct ifaddr_container *, int);
518 _IFAFREE(struct ifaddr *_ifa, int _cpu_id)
520 struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
523 ASSERT_IFAC_VALID(_ifac);
524 if (--_ifac->ifa_refcnt == 0)
525 ifac_free(_ifac, _cpu_id);
530 IFAFREE(struct ifaddr *_ifa)
532 _IFAFREE(_ifa, mycpuid);
535 struct lwkt_port *ifnet_portfn(int);
536 int ifnet_domsg(struct lwkt_msg *, int);
537 void ifnet_sendmsg(struct lwkt_msg *, int);
538 void ifnet_forwardmsg(struct lwkt_msg *, int);
541 ifa_domsg(struct lwkt_msg *_lmsg, int _cpu)
543 return ifnet_domsg(_lmsg, _cpu);
547 ifa_sendmsg(struct lwkt_msg *_lmsg, int _cpu)
549 ifnet_sendmsg(_lmsg, _cpu);
553 ifa_forwardmsg(struct lwkt_msg *_lmsg, int _nextcpu)
555 ifnet_forwardmsg(_lmsg, _nextcpu);
558 extern struct ifnethead ifnet;
559 extern struct ifnet **ifindex2ifnet;
560 extern int ifqmaxlen;
561 extern struct ifnet loif[];
564 void ether_ifattach(struct ifnet *, uint8_t *, struct lwkt_serialize *);
565 void ether_ifattach_bpf(struct ifnet *, uint8_t *, u_int, u_int,
566 struct lwkt_serialize *);
567 void ether_ifdetach(struct ifnet *);
568 void ether_demux_oncpu(struct ifnet *, struct mbuf *);
569 void ether_input_oncpu(struct ifnet *, struct mbuf *);
570 void ether_reinput_oncpu(struct ifnet *, struct mbuf *, int);
571 void ether_input_chain(struct ifnet *, struct mbuf *,
572 const struct pktinfo *, struct mbuf_chain *);
573 void ether_input_chain_init(struct mbuf_chain *);
574 void ether_input_dispatch(struct mbuf_chain *);
575 int ether_output_frame(struct ifnet *, struct mbuf *);
576 int ether_ioctl(struct ifnet *, int, caddr_t);
577 uint32_t ether_crc32_le(const uint8_t *, size_t);
578 uint32_t ether_crc32_be(const uint8_t *, size_t);
580 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
581 int if_allmulti(struct ifnet *, int);
582 void if_attach(struct ifnet *, struct lwkt_serialize *);
583 int if_delmulti(struct ifnet *, struct sockaddr *);
584 void if_purgeaddrs_nolink(struct ifnet *);
585 void if_detach(struct ifnet *);
586 void if_down(struct ifnet *);
587 void if_link_state_change(struct ifnet *);
588 void if_initname(struct ifnet *, const char *, int);
589 int if_getanyethermac(uint16_t *, int);
590 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
591 void if_route(struct ifnet *, int flag, int fam);
592 int if_setlladdr(struct ifnet *, const u_char *, int);
593 void if_unroute(struct ifnet *, int flag, int fam);
594 void if_up(struct ifnet *);
595 /*void ifinit(void);*/ /* declared in systm.h for main() */
596 int ifioctl(struct socket *, u_long, caddr_t, struct ucred *);
597 int ifpromisc(struct ifnet *, int);
598 struct ifnet *ifunit(const char *);
599 struct ifnet *if_withname(struct sockaddr *);
601 struct ifaddr *ifa_ifwithaddr(struct sockaddr *);
602 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
603 struct ifaddr *ifa_ifwithnet(struct sockaddr *);
604 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
605 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
607 void *ifa_create(int, int);
608 void ifa_destroy(struct ifaddr *);
609 void ifa_iflink(struct ifaddr *, struct ifnet *, int);
610 void ifa_ifunlink(struct ifaddr *, struct ifnet *);
612 struct ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
613 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
614 void if_devstart(struct ifnet *ifp);
616 #define IF_LLSOCKADDR(ifp) \
617 ((struct sockaddr_dl *)(ifp)->if_lladdr->ifa_addr)
618 #define IF_LLADDR(ifp) LLADDR(IF_LLSOCKADDR(ifp))
620 #ifdef DEVICE_POLLING
621 typedef void poll_handler_t (struct ifnet *ifp, enum poll_cmd cmd, int count);
622 int ether_poll_register(struct ifnet *);
623 int ether_poll_deregister(struct ifnet *);
624 int ether_pollcpu_register(struct ifnet *, int);
625 #endif /* DEVICE_POLLING */
628 #endif /* !_NET_IF_VAR_H_ */