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.22 2005/02/01 16:09:37 hrs Exp $
38 #ifndef _NET_IF_VAR_H_
39 #define _NET_IF_VAR_H_
42 * Structures defining a network interface, providing a packet
43 * transport mechanism (ala level 0 of the PUP protocols).
45 * Each interface accepts output datagrams of a specified maximum
46 * length, and provides higher level routines with input datagrams
47 * received from its medium.
49 * Output occurs when the routine if_output is called, with three parameters:
50 * (*ifp->if_output)(ifp, m, dst, rt)
51 * Here m is the mbuf chain to be sent and dst is the destination address.
52 * The output routine encapsulates the supplied datagram if necessary,
53 * and then transmits it on its medium.
55 * On input, each interface unwraps the data received by it, and either
56 * places it on the input queue of a internetwork datagram routine
57 * and posts the associated software interrupt, or passes the datagram to
58 * the routine if_input. It is called with the mbuf chain as parameter:
59 * (*ifp->if_input)(ifp, m)
60 * The input routine removes the protocol dependent header if necessary.
62 * Routines exist for locating interfaces by their addresses
63 * or for locating a interface on a certain network, as well as more general
64 * routing and gateway routines maintaining information used to locate
65 * interfaces. These routines live in the files if.c and route.c
70 * Forward structure declarations for function prototypes [sic].
81 #include <sys/queue.h> /* get TAILQ macros */
84 #include <sys/eventhandler.h>
86 #include <sys/systm.h> /* XXX */
89 #define IF_DUNIT_NONE -1
91 TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */
92 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */
93 TAILQ_HEAD(ifprefixhead, ifprefix);
94 LIST_HEAD(ifmultihead, ifmultiaddr);
97 * Structure defining a queue for a network interface.
100 struct mbuf *ifq_head;
101 struct mbuf *ifq_tail;
108 * Structure defining a network interface.
110 * (Would like to call this struct ``if'', but C isn't PL/1.)
114 * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with
115 * one of these structures, typically held within an arpcom structure.
117 * struct <foo>_softc {
119 * struct ifnet ac_if;
125 * The assumption is used in a number of places, including many
126 * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
128 * Unfortunately devices' softc are opaque, so we depend on this layout
129 * to locate the struct ifnet from the softc in the generic code.
131 * Note that not all fields are used by drivers in the FreeBSD source
132 * tree. However, who knows what third party software does with fields
133 * marked as "unused", such as if_ipending, if_done, and if_poll*,
134 * so any attemt to redefine their meaning might end up in binary
135 * compatibility problems, even if the size of struct ifnet, and
136 * the size and position of its fields do not change.
137 * We just have to live with that.
140 void *if_softc; /* pointer to driver state */
141 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */
142 char if_xname[IFNAMSIZ]; /* external name (name + unit) */
143 const char *if_dname; /* driver name */
144 int if_dunit; /* unit or IF_DUNIT_NONE */
145 struct ifaddrhead if_addrhead; /* linked list of addresses per if */
146 int if_pcount; /* number of promiscuous listeners */
147 struct bpf_if *if_bpf; /* packet filter structure */
148 u_short if_index; /* numeric abbreviation for this if */
149 short if_timer; /* time 'til if_watchdog called */
150 int if_flags; /* up/down, broadcast, etc. */
151 int if_capabilities; /* interface capabilities */
152 int if_capenable; /* enabled features */
153 void *if_linkmib; /* link-type-specific MIB data */
154 size_t if_linkmiblen; /* length of above data */
155 struct if_data if_data;
156 struct ifmultihead if_multiaddrs; /* multicast addresses configured */
157 int if_amcount; /* number of all-multicast requests */
158 /* procedure handles */
159 int (*if_output) /* output routine (enqueue) */
160 (struct ifnet *, struct mbuf *, struct sockaddr *,
162 void (*if_input) /* input routine from hardware driver */
163 (struct ifnet *, struct mbuf *);
164 void (*if_start) /* initiate output routine */
166 int (*if_ioctl) /* ioctl routine */
167 (struct ifnet *, u_long, caddr_t, struct ucred *);
168 void (*if_watchdog) /* timer routine */
170 void (*if_init) /* Init routine */
172 int (*if_resolvemulti) /* validate/resolve multicast */
173 (struct ifnet *, struct sockaddr **, struct sockaddr *);
174 struct ifqueue if_snd; /* output queue */
175 struct ifprefixhead if_prefixhead; /* list of prefixes per if */
176 const uint8_t *if_broadcastaddr;
177 void *if_afdata[AF_MAX];
179 typedef void if_init_f_t (void *);
181 #define if_mtu if_data.ifi_mtu
182 #define if_type if_data.ifi_type
183 #define if_physical if_data.ifi_physical
184 #define if_addrlen if_data.ifi_addrlen
185 #define if_hdrlen if_data.ifi_hdrlen
186 #define if_metric if_data.ifi_metric
187 #define if_baudrate if_data.ifi_baudrate
188 #define if_hwassist if_data.ifi_hwassist
189 #define if_ipackets if_data.ifi_ipackets
190 #define if_ierrors if_data.ifi_ierrors
191 #define if_opackets if_data.ifi_opackets
192 #define if_oerrors if_data.ifi_oerrors
193 #define if_collisions if_data.ifi_collisions
194 #define if_ibytes if_data.ifi_ibytes
195 #define if_obytes if_data.ifi_obytes
196 #define if_imcasts if_data.ifi_imcasts
197 #define if_omcasts if_data.ifi_omcasts
198 #define if_iqdrops if_data.ifi_iqdrops
199 #define if_noproto if_data.ifi_noproto
200 #define if_lastchange if_data.ifi_lastchange
201 #define if_recvquota if_data.ifi_recvquota
202 #define if_xmitquota if_data.ifi_xmitquota
203 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0)
205 /* for compatibility with other BSDs */
206 #define if_addrlist if_addrhead
207 #define if_list if_link
210 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
211 * are queues of messages stored on ifqueue structures
212 * (defined above). Entries are added to and deleted from these structures
213 * by these macros, which should be called with ipl raised to splimp().
215 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
216 #define IF_DROP(ifq) ((ifq)->ifq_drops++)
217 #define IF_QLEN(ifq) ((ifq)->ifq_len)
218 #define IF_QEMPTY(ifq) (IF_QLEN(ifq) == 0)
219 #define IF_ENQUEUE(ifq, m) { \
220 (m)->m_nextpkt = 0; \
221 if ((ifq)->ifq_tail == 0) \
222 (ifq)->ifq_head = m; \
224 (ifq)->ifq_tail->m_nextpkt = m; \
225 (ifq)->ifq_tail = m; \
228 #define IF_PREPEND(ifq, m) { \
229 (m)->m_nextpkt = (ifq)->ifq_head; \
230 if ((ifq)->ifq_tail == 0) \
231 (ifq)->ifq_tail = (m); \
232 (ifq)->ifq_head = (m); \
235 #define IF_DEQUEUE(ifq, m) { \
236 (m) = (ifq)->ifq_head; \
238 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
239 (ifq)->ifq_tail = 0; \
240 (m)->m_nextpkt = 0; \
245 #define IF_POLL(ifq, m) ((m) = (ifq)->ifq_head)
247 #define IF_DRAIN(ifq) do { \
250 IF_DEQUEUE(ifq, m); \
259 #define IF_HANDOFF(ifq, m, ifp) if_handoff(ifq, m, ifp, 0)
260 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj) if_handoff(ifq, m, ifp, adj)
263 if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp, int adjust)
265 int need_if_start = 0;
275 ifp->if_obytes += m->m_pkthdr.len + adjust;
276 if (m->m_flags & M_MCAST)
278 need_if_start = !(ifp->if_flags & IFF_OACTIVE);
282 (*ifp->if_start)(ifp);
287 #define IFQ_ENQUEUE(ifq, m, err) \
289 if (IF_QFULL(ifq)) { \
293 IF_ENQUEUE(ifq, m); \
297 (ifq)->ifq_drops++; \
300 #define IFQ_DEQUEUE(ifq, m) IF_DEQUEUE(ifq, m)
301 #define IFQ_POLL(ifq, m) IF_POLL(ifq, m)
302 #define IFQ_PURGE(ifq) IF_DRAIN(ifq)
304 #define IFQ_SET_READY(ifq) /* nothing */
306 #define IFQ_IS_EMPTY(ifq) ((ifq)->ifq_len == 0)
307 #define IFQ_INC_LEN(ifq) ((ifq)->ifq_len++)
308 #define IFQ_DEC_LEN(ifq) (--(ifq)->ifq_len)
309 #define IFQ_INC_DROPS(ifq) ((ifq)->ifq_drops++)
310 #define IFQ_SET_MAXLEN(ifq, len) ((ifq)->ifq_maxlen = (len))
312 #define IFQ_HANDOFF_ADJ(ifp, m, adj, err) \
317 len = (m)->m_pkthdr.len; \
318 mflags = (m)->m_flags; \
319 IFQ_ENQUEUE(&(ifp)->if_snd, m, err); \
321 (ifp)->if_obytes += len + (adj); \
322 if (mflags & M_MCAST) \
323 (ifp)->if_omcasts++; \
324 if (((ifp)->if_flags & IFF_OACTIVE) == 0) \
325 (*(ifp)->if_start)(ifp); \
329 #define IFQ_HANDOFF(ifp, m, err) \
330 IFQ_HANDOFF_ADJ(ifp, m, 0, err)
332 #define IFQ_DRV_DEQUEUE(ifq, m) \
334 (m) = (ifq)->ifq_drv_head; \
336 if (((ifq)->ifq_drv_head = (m)->m_nextpkt) == NULL) \
337 (ifq)->ifq_drv_tail = NULL; \
338 (m)->m_nextpkt = NULL; \
339 (ifq)->ifq_drv_len--; \
341 IFQ_DEQUEUE(ifq, m); \
342 while ((ifq)->ifq_drv_len < (ifq)->ifq_drv_maxlen) { \
344 IFQ_DEQUEUE(ifq, m0); \
347 m0->m_nextpkt = NULL; \
348 if ((ifq)->ifq_drv_tail == NULL) \
349 (ifq)->ifq_drv_head = m0; \
351 (ifq)->ifq_drv_tail->m_nextpkt = m0; \
352 (ifq)->ifq_drv_tail = m0; \
353 (ifq)->ifq_drv_len++; \
358 #define IFQ_DRV_PREPEND(ifq, m) \
360 (m)->m_nextpkt = (ifq)->ifq_drv_head; \
361 if ((ifq)->ifq_tail == NULL) \
362 (ifq)->ifq_tail = (m); \
363 (ifq)->ifq_drv_head = (m); \
364 (ifq)->ifq_drv_len++; \
367 #define IFQ_DRV_IS_EMPTY(ifq) \
368 (((ifq)->ifq_drv_len == 0) && ((ifq)->ifq_len == 0))
370 #define IFQ_DRV_PURGE(ifq) \
372 struct mbuf *m = (ifq)->ifq_drv_head; \
377 (ifq)->ifq_drv_head = (ifq)->ifq_drv_tail = NULL; \
378 (ifq)->ifq_drv_len = 0; \
383 * 72 was chosen below because it is the size of a TCP/IP
384 * header (40) + the minimum mss (32).
387 #define IF_MAXMTU 65535
392 * The ifaddr structure contains information about one address
393 * of an interface. They are maintained by the different address families,
394 * are allocated and attached when an address is set, and are linked
395 * together so all addresses for an interface can be located.
398 struct sockaddr *ifa_addr; /* address of interface */
399 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
400 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
401 struct sockaddr *ifa_netmask; /* used to determine subnet */
402 struct if_data if_data; /* not all members are meaningful */
403 struct ifnet *ifa_ifp; /* back-pointer to interface */
404 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */
405 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
406 (int, struct rtentry *, struct rt_addrinfo *);
407 u_short ifa_flags; /* mostly rt_flags for cloning */
408 u_int ifa_refcnt; /* references to this structure */
409 int ifa_metric; /* cost of going out this interface */
411 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */
413 int (*ifa_claim_addr) /* check if an addr goes to this if */
414 (struct ifaddr *, struct sockaddr *);
417 #define IFA_ROUTE RTF_UP /* route installed */
419 /* for compatibility with other BSDs */
420 #define ifa_list ifa_link
423 * The prefix structure contains information about one prefix
424 * of an interface. They are maintained by the different address families,
425 * are allocated and attached when an prefix or an address is set,
426 * and are linked together so all prefixes for an interface can be located.
429 struct sockaddr *ifpr_prefix; /* prefix of interface */
430 struct ifnet *ifpr_ifp; /* back-pointer to interface */
431 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
432 u_char ifpr_plen; /* prefix length in bits */
433 u_char ifpr_type; /* protocol dependent prefix type */
437 * Multicast address structure. This is analogous to the ifaddr
438 * structure except that it keeps track of multicast addresses.
439 * Also, the reference count here is a count of requests for this
440 * address, not a count of pointers to this structure.
443 LIST_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
444 struct sockaddr *ifma_addr; /* address this membership is for */
445 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
446 struct ifnet *ifma_ifp; /* back-pointer to interface */
447 u_int ifma_refcount; /* reference count */
448 void *ifma_protospec; /* protocol-specific state, if any */
452 /* interface address change event */
453 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
454 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
455 /* new interface attach event */
456 typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *);
457 EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t);
458 /* interface detach event */
459 typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *);
460 EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t);
461 /* interface clone event */
462 typedef void (*if_clone_event_handler_t)(void *, struct if_clone *);
463 EVENTHANDLER_DECLARE(if_clone_event, if_clone_event_handler_t);
466 IFAREF(struct ifaddr *ifa)
471 #include <sys/malloc.h>
473 MALLOC_DECLARE(M_IFADDR);
474 MALLOC_DECLARE(M_IFMADDR);
477 IFAFREE(struct ifaddr *ifa)
479 if (ifa->ifa_refcnt <= 0)
485 extern struct ifnethead ifnet;
486 extern struct ifnet **ifindex2ifnet;
487 extern int ifqmaxlen;
488 extern struct ifnet loif[];
490 extern struct ifaddr **ifnet_addrs;
492 void ether_ifattach(struct ifnet *, uint8_t *);
493 void ether_ifattach_bpf(struct ifnet *, uint8_t *, u_int, u_int);
494 void ether_ifdetach(struct ifnet *);
495 void ether_input(struct ifnet *, struct ether_header *, struct mbuf *);
496 void ether_demux(struct ifnet *, struct ether_header *, struct mbuf *);
497 int ether_output_frame(struct ifnet *, struct mbuf *);
498 int ether_ioctl(struct ifnet *, int, caddr_t);
499 uint32_t ether_crc32_le(const uint8_t *, size_t);
500 uint32_t ether_crc32_be(const uint8_t *, size_t);
502 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
503 int if_allmulti(struct ifnet *, int);
504 void if_attach(struct ifnet *);
505 int if_delmulti(struct ifnet *, struct sockaddr *);
506 void if_detach(struct ifnet *);
507 void if_down(struct ifnet *);
508 void if_initname(struct ifnet *, const char *, int);
509 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
510 void if_route(struct ifnet *, int flag, int fam);
511 int if_setlladdr(struct ifnet *, const u_char *, int);
512 void if_unroute(struct ifnet *, int flag, int fam);
513 void if_up(struct ifnet *);
514 /*void ifinit(void);*/ /* declared in systm.h for main() */
515 int ifioctl(struct socket *, u_long, caddr_t, struct thread *);
516 int ifpromisc(struct ifnet *, int);
517 struct ifnet *ifunit(const char *);
518 struct ifnet *if_withname(struct sockaddr *);
520 struct ifaddr *ifa_ifwithaddr(struct sockaddr *);
521 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
522 struct ifaddr *ifa_ifwithnet(struct sockaddr *);
523 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
524 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
526 struct ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
527 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
529 void if_clone_attach(struct if_clone *);
530 void if_clone_detach(struct if_clone *);
532 int if_clone_create(char *, int);
533 int if_clone_destroy(const char *);
535 #define IF_LLADDR(ifp) \
536 LLADDR((struct sockaddr_dl *) ifnet_addrs[ifp->if_index - 1]->ifa_addr)
538 #ifdef DEVICE_POLLING
539 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER };
541 typedef void poll_handler_t (struct ifnet *ifp,
542 enum poll_cmd cmd, int count);
543 int ether_poll_register(poll_handler_t *h, struct ifnet *ifp);
544 int ether_poll_deregister(struct ifnet *ifp);
545 void emergency_poll_enable(const char *name);
546 #endif /* DEVICE_POLLING */
549 #endif /* !_NET_IF_VAR_H_ */