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.16 2004/07/28 08:53:43 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 */
85 #include <sys/systm.h> /* XXX */
88 #define IF_DUNIT_NONE -1
90 TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */
91 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */
92 TAILQ_HEAD(ifprefixhead, ifprefix);
93 LIST_HEAD(ifmultihead, ifmultiaddr);
96 * Structure defining a queue for a network interface.
99 struct mbuf *ifq_head;
100 struct mbuf *ifq_tail;
107 * Structure defining a network interface.
109 * (Would like to call this struct ``if'', but C isn't PL/1.)
113 * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with
114 * one of these structures, typically held within an arpcom structure.
116 * struct <foo>_softc {
118 * struct ifnet ac_if;
124 * The assumption is used in a number of places, including many
125 * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
127 * Unfortunately devices' softc are opaque, so we depend on this layout
128 * to locate the struct ifnet from the softc in the generic code.
130 * Note that not all fields are used by drivers in the FreeBSD source
131 * tree. However, who knows what third party software does with fields
132 * marked as "unused", such as if_ipending, if_done, and if_poll*,
133 * so any attemt to redefine their meaning might end up in binary
134 * compatibility problems, even if the size of struct ifnet, and
135 * the size and position of its fields do not change.
136 * We just have to live with that.
139 void *if_softc; /* pointer to driver state */
140 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */
141 char if_xname[IFNAMSIZ]; /* external name (name + unit) */
142 const char *if_dname; /* driver name */
143 int if_dunit; /* unit or IF_DUNIT_NONE */
144 struct ifaddrhead if_addrhead; /* linked list of addresses per if */
145 int if_pcount; /* number of promiscuous listeners */
146 struct bpf_if *if_bpf; /* packet filter structure */
147 u_short if_index; /* numeric abbreviation for this if */
148 short if_timer; /* time 'til if_watchdog called */
149 int if_flags; /* up/down, broadcast, etc. */
150 int if_capabilities; /* interface capabilities */
151 int if_capenable; /* enabled features */
152 void *if_linkmib; /* link-type-specific MIB data */
153 size_t if_linkmiblen; /* length of above data */
154 struct if_data if_data;
155 struct ifmultihead if_multiaddrs; /* multicast addresses configured */
156 int if_amcount; /* number of all-multicast requests */
157 /* procedure handles */
158 int (*if_output) /* output routine (enqueue) */
159 (struct ifnet *, struct mbuf *, struct sockaddr *,
161 void (*if_input) /* input routine from hardware driver */
162 (struct ifnet *, struct mbuf *);
163 void (*if_start) /* initiate output routine */
165 int (*if_ioctl) /* ioctl routine */
166 (struct ifnet *, u_long, caddr_t, struct ucred *);
167 void (*if_watchdog) /* timer routine */
169 void (*if_init) /* Init routine */
171 int (*if_resolvemulti) /* validate/resolve multicast */
172 (struct ifnet *, struct sockaddr **, struct sockaddr *);
173 struct ifqueue if_snd; /* output queue */
174 struct ifprefixhead if_prefixhead; /* list of prefixes per if */
175 const uint8_t *if_broadcastaddr;
177 typedef void if_init_f_t (void *);
179 #define if_mtu if_data.ifi_mtu
180 #define if_type if_data.ifi_type
181 #define if_physical if_data.ifi_physical
182 #define if_addrlen if_data.ifi_addrlen
183 #define if_hdrlen if_data.ifi_hdrlen
184 #define if_metric if_data.ifi_metric
185 #define if_baudrate if_data.ifi_baudrate
186 #define if_hwassist if_data.ifi_hwassist
187 #define if_ipackets if_data.ifi_ipackets
188 #define if_ierrors if_data.ifi_ierrors
189 #define if_opackets if_data.ifi_opackets
190 #define if_oerrors if_data.ifi_oerrors
191 #define if_collisions if_data.ifi_collisions
192 #define if_ibytes if_data.ifi_ibytes
193 #define if_obytes if_data.ifi_obytes
194 #define if_imcasts if_data.ifi_imcasts
195 #define if_omcasts if_data.ifi_omcasts
196 #define if_iqdrops if_data.ifi_iqdrops
197 #define if_noproto if_data.ifi_noproto
198 #define if_lastchange if_data.ifi_lastchange
199 #define if_recvquota if_data.ifi_recvquota
200 #define if_xmitquota if_data.ifi_xmitquota
201 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0)
203 /* for compatibility with other BSDs */
204 #define if_addrlist if_addrhead
205 #define if_list if_link
208 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
209 * are queues of messages stored on ifqueue structures
210 * (defined above). Entries are added to and deleted from these structures
211 * by these macros, which should be called with ipl raised to splimp().
213 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
214 #define IF_DROP(ifq) ((ifq)->ifq_drops++)
215 #define IF_QLEN(ifq) ((ifq)->ifq_len)
216 #define IF_ENQUEUE(ifq, m) { \
217 (m)->m_nextpkt = 0; \
218 if ((ifq)->ifq_tail == 0) \
219 (ifq)->ifq_head = m; \
221 (ifq)->ifq_tail->m_nextpkt = m; \
222 (ifq)->ifq_tail = m; \
225 #define IF_PREPEND(ifq, m) { \
226 (m)->m_nextpkt = (ifq)->ifq_head; \
227 if ((ifq)->ifq_tail == 0) \
228 (ifq)->ifq_tail = (m); \
229 (ifq)->ifq_head = (m); \
232 #define IF_DEQUEUE(ifq, m) { \
233 (m) = (ifq)->ifq_head; \
235 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
236 (ifq)->ifq_tail = 0; \
237 (m)->m_nextpkt = 0; \
242 #define IF_POLL(ifq, m) ((m) = (ifq)->ifq_head)
244 #define IF_DRAIN(ifq) do { \
247 IF_DEQUEUE(ifq, m); \
257 * #define _IF_QFULL for compatibility with -current
259 #define _IF_QFULL(ifq) IF_QFULL(ifq)
261 #define IF_HANDOFF(ifq, m, ifp) if_handoff(ifq, m, ifp, 0)
262 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj) if_handoff(ifq, m, ifp, adj)
265 if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp, int adjust)
267 int need_if_start = 0;
277 ifp->if_obytes += m->m_pkthdr.len + adjust;
278 if (m->m_flags & M_MCAST)
280 need_if_start = !(ifp->if_flags & IFF_OACTIVE);
284 (*ifp->if_start)(ifp);
289 #define IFQ_ENQUEUE(ifq, m, err) \
291 if (_IF_QFULL(ifq)) { \
295 _IF_ENQUEUE(ifq, m); \
299 (ifq)->ifq_drops++; \
302 #define IFQ_DEQUEUE(ifq, m) IF_DEQUEUE(ifq, m)
303 #define IFQ_POLL(ifq, m) IF_POLL(ifq, m)
304 #define IFQ_PURGE(ifq) IF_DRAIN(ifq)
306 #define IFQ_SET_READY(ifq) /* nothing */
308 #define IFQ_IS_EMPTY(ifq) ((ifq)->ifq_len == 0)
309 #define IFQ_INC_LEN(ifq) ((ifq)->ifq_len++)
310 #define IFQ_DEC_LEN(ifq) (--(ifq)->ifq_len)
311 #define IFQ_INC_DROPS(ifq) ((ifq)->ifq_drops++)
312 #define IFQ_SET_MAXLEN(ifq, len) ((ifq)->ifq_maxlen = (len))
314 #define IFQ_HANDOFF_ADJ(ifp, m, adj, err) \
319 len = (m)->m_pkthdr.len; \
320 mflags = (m)->m_flags; \
321 IFQ_ENQUEUE(&(ifp)->if_snd, m, err); \
323 (ifp)->if_obytes += len + (adj); \
324 if (mflags & M_MCAST) \
325 (ifp)->if_omcasts++; \
326 if (((ifp)->if_flags & IFF_OACTIVE) == 0) \
327 (*(ifp)->if_start)(ifp); \
331 #define IFQ_HANDOFF(ifp, m, err) \
332 IFQ_HANDOFF_ADJ(ifp, m, 0, err)
334 #define IFQ_DRV_DEQUEUE(ifq, m) \
336 (m) = (ifq)->ifq_drv_head; \
338 if (((ifq)->ifq_drv_head = (m)->m_nextpkt) == NULL) \
339 (ifq)->ifq_drv_tail = NULL; \
340 (m)->m_nextpkt = NULL; \
341 (ifq)->ifq_drv_len--; \
343 IFQ_DEQUEUE(ifq, m); \
344 while ((ifq)->ifq_drv_len < (ifq)->ifq_drv_maxlen) { \
346 IFQ_DEQUEUE(ifq, m0); \
349 m0->m_nextpkt = NULL; \
350 if ((ifq)->ifq_drv_tail == NULL) \
351 (ifq)->ifq_drv_head = m0; \
353 (ifq)->ifq_drv_tail->m_nextpkt = m0; \
354 (ifq)->ifq_drv_tail = m0; \
355 (ifq)->ifq_drv_len++; \
360 #define IFQ_DRV_PREPEND(ifq, m) \
362 (m)->m_nextpkt = (ifq)->ifq_drv_head; \
363 if ((ifq)->ifq_tail == NULL) \
364 (ifq)->ifq_tail = (m); \
365 (ifq)->ifq_drv_head = (m); \
366 (ifq)->ifq_drv_len++; \
369 #define IFQ_DRV_IS_EMPTY(ifq) \
370 (((ifq)->ifq_drv_len == 0) && ((ifq)->ifq_len == 0))
372 #define IFQ_DRV_PURGE(ifq) \
374 struct mbuf *m = (ifq)->ifq_drv_head; \
379 (ifq)->ifq_drv_head = (ifq)->ifq_drv_tail = NULL; \
380 (ifq)->ifq_drv_len = 0; \
385 * 72 was chosen below because it is the size of a TCP/IP
386 * header (40) + the minimum mss (32).
389 #define IF_MAXMTU 65535
394 * The ifaddr structure contains information about one address
395 * of an interface. They are maintained by the different address families,
396 * are allocated and attached when an address is set, and are linked
397 * together so all addresses for an interface can be located.
400 struct sockaddr *ifa_addr; /* address of interface */
401 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
402 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
403 struct sockaddr *ifa_netmask; /* used to determine subnet */
404 struct if_data if_data; /* not all members are meaningful */
405 struct ifnet *ifa_ifp; /* back-pointer to interface */
406 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */
407 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
408 (int, struct rtentry *, struct rt_addrinfo *);
409 u_short ifa_flags; /* mostly rt_flags for cloning */
410 u_int ifa_refcnt; /* references to this structure */
411 int ifa_metric; /* cost of going out this interface */
413 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */
415 int (*ifa_claim_addr) /* check if an addr goes to this if */
416 (struct ifaddr *, struct sockaddr *);
419 #define IFA_ROUTE RTF_UP /* route installed */
421 /* for compatibility with other BSDs */
422 #define ifa_list ifa_link
425 * The prefix structure contains information about one prefix
426 * of an interface. They are maintained by the different address families,
427 * are allocated and attached when an prefix or an address is set,
428 * and are linked together so all prefixes for an interface can be located.
431 struct sockaddr *ifpr_prefix; /* prefix of interface */
432 struct ifnet *ifpr_ifp; /* back-pointer to interface */
433 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
434 u_char ifpr_plen; /* prefix length in bits */
435 u_char ifpr_type; /* protocol dependent prefix type */
439 * Multicast address structure. This is analogous to the ifaddr
440 * structure except that it keeps track of multicast addresses.
441 * Also, the reference count here is a count of requests for this
442 * address, not a count of pointers to this structure.
445 LIST_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
446 struct sockaddr *ifma_addr; /* address this membership is for */
447 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
448 struct ifnet *ifma_ifp; /* back-pointer to interface */
449 u_int ifma_refcount; /* reference count */
450 void *ifma_protospec; /* protocol-specific state, if any */
454 #define IFAFREE(ifa) \
456 if ((ifa)->ifa_refcnt <= 0) \
459 (ifa)->ifa_refcnt--; \
462 extern struct ifnethead ifnet;
463 extern struct ifnet **ifindex2ifnet;
464 extern int ifqmaxlen;
465 extern struct ifnet loif[];
467 extern struct ifaddr **ifnet_addrs;
469 void ether_ifattach(struct ifnet *, uint8_t *);
470 void ether_ifattach_bpf(struct ifnet *, uint8_t *, u_int, u_int);
471 void ether_ifdetach(struct ifnet *);
472 void ether_input(struct ifnet *, struct ether_header *, struct mbuf *);
473 void ether_demux(struct ifnet *, struct ether_header *, struct mbuf *);
474 int ether_output_frame(struct ifnet *, struct mbuf *);
475 int ether_ioctl(struct ifnet *, int, caddr_t);
476 uint32_t ether_crc32_le(const uint8_t *, size_t);
477 uint32_t ether_crc32_be(const uint8_t *, size_t);
479 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
480 int if_allmulti(struct ifnet *, int);
481 void if_attach(struct ifnet *);
482 int if_delmulti(struct ifnet *, struct sockaddr *);
483 void if_detach(struct ifnet *);
484 void if_down(struct ifnet *);
485 void if_initname(struct ifnet *, const char *, int);
486 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
487 void if_route(struct ifnet *, int flag, int fam);
488 int if_setlladdr(struct ifnet *, const u_char *, int);
489 void if_unroute(struct ifnet *, int flag, int fam);
490 void if_up(struct ifnet *);
491 /*void ifinit(void);*/ /* declared in systm.h for main() */
492 int ifioctl(struct socket *, u_long, caddr_t, struct thread *);
493 int ifpromisc(struct ifnet *, int);
494 struct ifnet *ifunit(const char *);
495 struct ifnet *if_withname(struct sockaddr *);
497 struct ifaddr *ifa_ifwithaddr(struct sockaddr *);
498 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
499 struct ifaddr *ifa_ifwithnet(struct sockaddr *);
500 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
501 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
502 void ifafree(struct ifaddr *);
504 struct ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
505 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
507 void if_clone_attach(struct if_clone *);
508 void if_clone_detach(struct if_clone *);
510 int if_clone_create(char *, int);
511 int if_clone_destroy(const char *);
513 #define IF_LLADDR(ifp) \
514 LLADDR((struct sockaddr_dl *) ifnet_addrs[ifp->if_index - 1]->ifa_addr)
516 #ifdef DEVICE_POLLING
517 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER };
519 typedef void poll_handler_t (struct ifnet *ifp,
520 enum poll_cmd cmd, int count);
521 int ether_poll_register(poll_handler_t *h, struct ifnet *ifp);
522 int ether_poll_deregister(struct ifnet *ifp);
523 void emergency_poll_enable(const char *name);
524 #endif /* DEVICE_POLLING */
527 #endif /* !_NET_IF_VAR_H_ */