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.18 2004/09/15 19:33:36 joerg 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;
178 typedef void if_init_f_t (void *);
180 #define if_mtu if_data.ifi_mtu
181 #define if_type if_data.ifi_type
182 #define if_physical if_data.ifi_physical
183 #define if_addrlen if_data.ifi_addrlen
184 #define if_hdrlen if_data.ifi_hdrlen
185 #define if_metric if_data.ifi_metric
186 #define if_baudrate if_data.ifi_baudrate
187 #define if_hwassist if_data.ifi_hwassist
188 #define if_ipackets if_data.ifi_ipackets
189 #define if_ierrors if_data.ifi_ierrors
190 #define if_opackets if_data.ifi_opackets
191 #define if_oerrors if_data.ifi_oerrors
192 #define if_collisions if_data.ifi_collisions
193 #define if_ibytes if_data.ifi_ibytes
194 #define if_obytes if_data.ifi_obytes
195 #define if_imcasts if_data.ifi_imcasts
196 #define if_omcasts if_data.ifi_omcasts
197 #define if_iqdrops if_data.ifi_iqdrops
198 #define if_noproto if_data.ifi_noproto
199 #define if_lastchange if_data.ifi_lastchange
200 #define if_recvquota if_data.ifi_recvquota
201 #define if_xmitquota if_data.ifi_xmitquota
202 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0)
204 /* for compatibility with other BSDs */
205 #define if_addrlist if_addrhead
206 #define if_list if_link
209 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
210 * are queues of messages stored on ifqueue structures
211 * (defined above). Entries are added to and deleted from these structures
212 * by these macros, which should be called with ipl raised to splimp().
214 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
215 #define IF_DROP(ifq) ((ifq)->ifq_drops++)
216 #define IF_QLEN(ifq) ((ifq)->ifq_len)
217 #define IF_ENQUEUE(ifq, m) { \
218 (m)->m_nextpkt = 0; \
219 if ((ifq)->ifq_tail == 0) \
220 (ifq)->ifq_head = m; \
222 (ifq)->ifq_tail->m_nextpkt = m; \
223 (ifq)->ifq_tail = m; \
226 #define IF_PREPEND(ifq, m) { \
227 (m)->m_nextpkt = (ifq)->ifq_head; \
228 if ((ifq)->ifq_tail == 0) \
229 (ifq)->ifq_tail = (m); \
230 (ifq)->ifq_head = (m); \
233 #define IF_DEQUEUE(ifq, m) { \
234 (m) = (ifq)->ifq_head; \
236 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
237 (ifq)->ifq_tail = 0; \
238 (m)->m_nextpkt = 0; \
243 #define IF_POLL(ifq, m) ((m) = (ifq)->ifq_head)
245 #define IF_DRAIN(ifq) do { \
248 IF_DEQUEUE(ifq, m); \
258 * #define _IF_QFULL for compatibility with -current
260 #define _IF_QFULL(ifq) IF_QFULL(ifq)
262 #define IF_HANDOFF(ifq, m, ifp) if_handoff(ifq, m, ifp, 0)
263 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj) if_handoff(ifq, m, ifp, adj)
266 if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp, int adjust)
268 int need_if_start = 0;
278 ifp->if_obytes += m->m_pkthdr.len + adjust;
279 if (m->m_flags & M_MCAST)
281 need_if_start = !(ifp->if_flags & IFF_OACTIVE);
285 (*ifp->if_start)(ifp);
290 #define IFQ_ENQUEUE(ifq, m, err) \
292 if (_IF_QFULL(ifq)) { \
296 _IF_ENQUEUE(ifq, m); \
300 (ifq)->ifq_drops++; \
303 #define IFQ_DEQUEUE(ifq, m) IF_DEQUEUE(ifq, m)
304 #define IFQ_POLL(ifq, m) IF_POLL(ifq, m)
305 #define IFQ_PURGE(ifq) IF_DRAIN(ifq)
307 #define IFQ_SET_READY(ifq) /* nothing */
309 #define IFQ_IS_EMPTY(ifq) ((ifq)->ifq_len == 0)
310 #define IFQ_INC_LEN(ifq) ((ifq)->ifq_len++)
311 #define IFQ_DEC_LEN(ifq) (--(ifq)->ifq_len)
312 #define IFQ_INC_DROPS(ifq) ((ifq)->ifq_drops++)
313 #define IFQ_SET_MAXLEN(ifq, len) ((ifq)->ifq_maxlen = (len))
315 #define IFQ_HANDOFF_ADJ(ifp, m, adj, err) \
320 len = (m)->m_pkthdr.len; \
321 mflags = (m)->m_flags; \
322 IFQ_ENQUEUE(&(ifp)->if_snd, m, err); \
324 (ifp)->if_obytes += len + (adj); \
325 if (mflags & M_MCAST) \
326 (ifp)->if_omcasts++; \
327 if (((ifp)->if_flags & IFF_OACTIVE) == 0) \
328 (*(ifp)->if_start)(ifp); \
332 #define IFQ_HANDOFF(ifp, m, err) \
333 IFQ_HANDOFF_ADJ(ifp, m, 0, err)
335 #define IFQ_DRV_DEQUEUE(ifq, m) \
337 (m) = (ifq)->ifq_drv_head; \
339 if (((ifq)->ifq_drv_head = (m)->m_nextpkt) == NULL) \
340 (ifq)->ifq_drv_tail = NULL; \
341 (m)->m_nextpkt = NULL; \
342 (ifq)->ifq_drv_len--; \
344 IFQ_DEQUEUE(ifq, m); \
345 while ((ifq)->ifq_drv_len < (ifq)->ifq_drv_maxlen) { \
347 IFQ_DEQUEUE(ifq, m0); \
350 m0->m_nextpkt = NULL; \
351 if ((ifq)->ifq_drv_tail == NULL) \
352 (ifq)->ifq_drv_head = m0; \
354 (ifq)->ifq_drv_tail->m_nextpkt = m0; \
355 (ifq)->ifq_drv_tail = m0; \
356 (ifq)->ifq_drv_len++; \
361 #define IFQ_DRV_PREPEND(ifq, m) \
363 (m)->m_nextpkt = (ifq)->ifq_drv_head; \
364 if ((ifq)->ifq_tail == NULL) \
365 (ifq)->ifq_tail = (m); \
366 (ifq)->ifq_drv_head = (m); \
367 (ifq)->ifq_drv_len++; \
370 #define IFQ_DRV_IS_EMPTY(ifq) \
371 (((ifq)->ifq_drv_len == 0) && ((ifq)->ifq_len == 0))
373 #define IFQ_DRV_PURGE(ifq) \
375 struct mbuf *m = (ifq)->ifq_drv_head; \
380 (ifq)->ifq_drv_head = (ifq)->ifq_drv_tail = NULL; \
381 (ifq)->ifq_drv_len = 0; \
386 * 72 was chosen below because it is the size of a TCP/IP
387 * header (40) + the minimum mss (32).
390 #define IF_MAXMTU 65535
395 * The ifaddr structure contains information about one address
396 * of an interface. They are maintained by the different address families,
397 * are allocated and attached when an address is set, and are linked
398 * together so all addresses for an interface can be located.
401 struct sockaddr *ifa_addr; /* address of interface */
402 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
403 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
404 struct sockaddr *ifa_netmask; /* used to determine subnet */
405 struct if_data if_data; /* not all members are meaningful */
406 struct ifnet *ifa_ifp; /* back-pointer to interface */
407 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */
408 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
409 (int, struct rtentry *, struct rt_addrinfo *);
410 u_short ifa_flags; /* mostly rt_flags for cloning */
411 u_int ifa_refcnt; /* references to this structure */
412 int ifa_metric; /* cost of going out this interface */
414 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */
416 int (*ifa_claim_addr) /* check if an addr goes to this if */
417 (struct ifaddr *, struct sockaddr *);
420 #define IFA_ROUTE RTF_UP /* route installed */
422 /* for compatibility with other BSDs */
423 #define ifa_list ifa_link
426 * The prefix structure contains information about one prefix
427 * of an interface. They are maintained by the different address families,
428 * are allocated and attached when an prefix or an address is set,
429 * and are linked together so all prefixes for an interface can be located.
432 struct sockaddr *ifpr_prefix; /* prefix of interface */
433 struct ifnet *ifpr_ifp; /* back-pointer to interface */
434 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
435 u_char ifpr_plen; /* prefix length in bits */
436 u_char ifpr_type; /* protocol dependent prefix type */
440 * Multicast address structure. This is analogous to the ifaddr
441 * structure except that it keeps track of multicast addresses.
442 * Also, the reference count here is a count of requests for this
443 * address, not a count of pointers to this structure.
446 LIST_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
447 struct sockaddr *ifma_addr; /* address this membership is for */
448 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
449 struct ifnet *ifma_ifp; /* back-pointer to interface */
450 u_int ifma_refcount; /* reference count */
451 void *ifma_protospec; /* protocol-specific state, if any */
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 /* new interface attach event */
459 typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *);
460 EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t);
461 /* interface detach event */
462 typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *);
463 EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t);
464 /* interface clone event */
465 typedef void (*if_clone_event_handler_t)(void *, struct if_clone *);
466 EVENTHANDLER_DECLARE(if_clone_event, if_clone_event_handler_t);
468 #define IFAFREE(ifa) \
470 if ((ifa)->ifa_refcnt <= 0) \
473 (ifa)->ifa_refcnt--; \
476 extern struct ifnethead ifnet;
477 extern struct ifnet **ifindex2ifnet;
478 extern int ifqmaxlen;
479 extern struct ifnet loif[];
481 extern struct ifaddr **ifnet_addrs;
483 void ether_ifattach(struct ifnet *, uint8_t *);
484 void ether_ifattach_bpf(struct ifnet *, uint8_t *, u_int, u_int);
485 void ether_ifdetach(struct ifnet *);
486 void ether_input(struct ifnet *, struct ether_header *, struct mbuf *);
487 void ether_demux(struct ifnet *, struct ether_header *, struct mbuf *);
488 int ether_output_frame(struct ifnet *, struct mbuf *);
489 int ether_ioctl(struct ifnet *, int, caddr_t);
490 uint32_t ether_crc32_le(const uint8_t *, size_t);
491 uint32_t ether_crc32_be(const uint8_t *, size_t);
493 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
494 int if_allmulti(struct ifnet *, int);
495 void if_attach(struct ifnet *);
496 int if_delmulti(struct ifnet *, struct sockaddr *);
497 void if_detach(struct ifnet *);
498 void if_down(struct ifnet *);
499 void if_initname(struct ifnet *, const char *, int);
500 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
501 void if_route(struct ifnet *, int flag, int fam);
502 int if_setlladdr(struct ifnet *, const u_char *, int);
503 void if_unroute(struct ifnet *, int flag, int fam);
504 void if_up(struct ifnet *);
505 /*void ifinit(void);*/ /* declared in systm.h for main() */
506 int ifioctl(struct socket *, u_long, caddr_t, struct thread *);
507 int ifpromisc(struct ifnet *, int);
508 struct ifnet *ifunit(const char *);
509 struct ifnet *if_withname(struct sockaddr *);
511 struct ifaddr *ifa_ifwithaddr(struct sockaddr *);
512 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
513 struct ifaddr *ifa_ifwithnet(struct sockaddr *);
514 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
515 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
516 void ifafree(struct ifaddr *);
518 struct ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
519 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
521 void if_clone_attach(struct if_clone *);
522 void if_clone_detach(struct if_clone *);
524 int if_clone_create(char *, int);
525 int if_clone_destroy(const char *);
527 #define IF_LLADDR(ifp) \
528 LLADDR((struct sockaddr_dl *) ifnet_addrs[ifp->if_index - 1]->ifa_addr)
530 #ifdef DEVICE_POLLING
531 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER };
533 typedef void poll_handler_t (struct ifnet *ifp,
534 enum poll_cmd cmd, int count);
535 int ether_poll_register(poll_handler_t *h, struct ifnet *ifp);
536 int ether_poll_deregister(struct ifnet *ifp);
537 void emergency_poll_enable(const char *name);
538 #endif /* DEVICE_POLLING */
541 #endif /* !_NET_IF_VAR_H_ */