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.28 2005/06/03 23:23:03 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
69 * Forward structure declarations for function prototypes [sic].
79 #include <sys/queue.h> /* get TAILQ macros */
81 #include <net/altq/if_altq.h>
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;
107 #ifdef DEVICE_POLLING
108 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER,
113 * Structure defining a network interface.
115 * (Would like to call this struct ``if'', but C isn't PL/1.)
119 * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with
120 * one of these structures, typically held within an arpcom structure.
122 * struct <foo>_softc {
124 * struct ifnet ac_if;
130 * The assumption is used in a number of places, including many
131 * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
133 * Unfortunately devices' softc are opaque, so we depend on this layout
134 * to locate the struct ifnet from the softc in the generic code.
136 * Note that not all fields are used by drivers in the FreeBSD source
137 * tree. However, who knows what third party software does with fields
138 * marked as "unused", such as if_ipending, if_done, and if_poll*,
139 * so any attemt to redefine their meaning might end up in binary
140 * compatibility problems, even if the size of struct ifnet, and
141 * the size and position of its fields do not change.
142 * We just have to live with that.
145 void *if_softc; /* pointer to driver state */
146 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */
147 char if_xname[IFNAMSIZ]; /* external name (name + unit) */
148 const char *if_dname; /* driver name */
149 int if_dunit; /* unit or IF_DUNIT_NONE */
150 struct ifaddrhead if_addrhead; /* linked list of addresses per if */
151 int if_pcount; /* number of promiscuous listeners */
152 struct bpf_if *if_bpf; /* packet filter structure */
153 u_short if_index; /* numeric abbreviation for this if */
154 short if_timer; /* time 'til if_watchdog called */
155 int if_flags; /* up/down, broadcast, etc. */
156 int if_capabilities; /* interface capabilities */
157 int if_capenable; /* enabled features */
158 void *if_linkmib; /* link-type-specific MIB data */
159 size_t if_linkmiblen; /* length of above data */
160 struct if_data if_data;
161 struct ifmultihead if_multiaddrs; /* multicast addresses configured */
162 int if_amcount; /* number of all-multicast requests */
163 /* procedure handles */
164 int (*if_output) /* output routine (enqueue) */
165 (struct ifnet *, struct mbuf *, struct sockaddr *,
167 void (*if_input) /* input routine from hardware driver */
168 (struct ifnet *, struct mbuf *);
169 void (*if_start) /* initiate output routine */
171 int (*if_ioctl) /* ioctl routine */
172 (struct ifnet *, u_long, caddr_t, struct ucred *);
173 void (*if_watchdog) /* timer routine */
175 void (*if_init) /* Init routine */
177 int (*if_resolvemulti) /* validate/resolve multicast */
178 (struct ifnet *, struct sockaddr **, struct sockaddr *);
179 #ifdef DEVICE_POLLING
180 void (*if_poll) /* IFF_POLLING support */
181 (struct ifnet *, enum poll_cmd, int);
183 void (*if_poll_unused)(void); /* placeholder */
185 struct ifaltq if_snd; /* output queue (includes altq) */
186 struct ifprefixhead if_prefixhead; /* list of prefixes per if */
187 const uint8_t *if_broadcastaddr;
188 void *if_afdata[AF_MAX];
190 typedef void if_init_f_t (void *);
192 #define if_mtu if_data.ifi_mtu
193 #define if_type if_data.ifi_type
194 #define if_physical if_data.ifi_physical
195 #define if_addrlen if_data.ifi_addrlen
196 #define if_hdrlen if_data.ifi_hdrlen
197 #define if_metric if_data.ifi_metric
198 #define if_baudrate if_data.ifi_baudrate
199 #define if_hwassist if_data.ifi_hwassist
200 #define if_ipackets if_data.ifi_ipackets
201 #define if_ierrors if_data.ifi_ierrors
202 #define if_opackets if_data.ifi_opackets
203 #define if_oerrors if_data.ifi_oerrors
204 #define if_collisions if_data.ifi_collisions
205 #define if_ibytes if_data.ifi_ibytes
206 #define if_obytes if_data.ifi_obytes
207 #define if_imcasts if_data.ifi_imcasts
208 #define if_omcasts if_data.ifi_omcasts
209 #define if_iqdrops if_data.ifi_iqdrops
210 #define if_noproto if_data.ifi_noproto
211 #define if_lastchange if_data.ifi_lastchange
212 #define if_recvquota if_data.ifi_recvquota
213 #define if_xmitquota if_data.ifi_xmitquota
214 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0)
216 /* for compatibility with other BSDs */
217 #define if_addrlist if_addrhead
218 #define if_list if_link
221 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
222 * are queues of messages stored on ifqueue structures
223 * (defined above). Entries are added to and deleted from these structures
224 * by these macros, which should be called with ipl raised to splimp().
226 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
227 #define IF_DROP(ifq) ((ifq)->ifq_drops++)
228 #define IF_QLEN(ifq) ((ifq)->ifq_len)
229 #define IF_QEMPTY(ifq) (IF_QLEN(ifq) == 0)
230 #define IF_ENQUEUE(ifq, m) { \
231 (m)->m_nextpkt = 0; \
232 if ((ifq)->ifq_tail == 0) \
233 (ifq)->ifq_head = m; \
235 (ifq)->ifq_tail->m_nextpkt = m; \
236 (ifq)->ifq_tail = m; \
239 #define IF_PREPEND(ifq, m) { \
240 (m)->m_nextpkt = (ifq)->ifq_head; \
241 if ((ifq)->ifq_tail == 0) \
242 (ifq)->ifq_tail = (m); \
243 (ifq)->ifq_head = (m); \
246 #define IF_DEQUEUE(ifq, m) { \
247 (m) = (ifq)->ifq_head; \
249 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
250 (ifq)->ifq_tail = 0; \
251 (m)->m_nextpkt = 0; \
256 #define IF_POLL(ifq, m) ((m) = (ifq)->ifq_head)
258 #define IF_DRAIN(ifq) do { \
261 IF_DEQUEUE(ifq, m); \
270 #define IF_HANDOFF(ifq, m, ifp) if_handoff(ifq, m, ifp, 0)
271 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj) if_handoff(ifq, m, ifp, adj)
274 if_handoff(struct ifqueue *_ifq, struct mbuf *_m, struct ifnet *_ifp,
277 int _need_if_start = 0;
280 if (IF_QFULL(_ifq)) {
287 _ifp->if_obytes += _m->m_pkthdr.len + _adjust;
288 if (_m->m_flags & M_MCAST)
290 _need_if_start = !(_ifp->if_flags & IFF_OACTIVE);
292 IF_ENQUEUE(_ifq, _m);
294 (*_ifp->if_start)(_ifp);
300 * 72 was chosen below because it is the size of a TCP/IP
301 * header (40) + the minimum mss (32).
304 #define IF_MAXMTU 65535
309 * The ifaddr structure contains information about one address
310 * of an interface. They are maintained by the different address families,
311 * are allocated and attached when an address is set, and are linked
312 * together so all addresses for an interface can be located.
315 struct sockaddr *ifa_addr; /* address of interface */
316 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
317 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
318 struct sockaddr *ifa_netmask; /* used to determine subnet */
319 struct if_data if_data; /* not all members are meaningful */
320 struct ifnet *ifa_ifp; /* back-pointer to interface */
321 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */
322 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
323 (int, struct rtentry *, struct rt_addrinfo *);
324 u_short ifa_flags; /* mostly rt_flags for cloning */
325 u_int ifa_refcnt; /* references to this structure */
326 int ifa_metric; /* cost of going out this interface */
328 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */
330 int (*ifa_claim_addr) /* check if an addr goes to this if */
331 (struct ifaddr *, struct sockaddr *);
334 #define IFA_ROUTE RTF_UP /* route installed */
336 /* for compatibility with other BSDs */
337 #define ifa_list ifa_link
340 * The prefix structure contains information about one prefix
341 * of an interface. They are maintained by the different address families,
342 * are allocated and attached when an prefix or an address is set,
343 * and are linked together so all prefixes for an interface can be located.
346 struct sockaddr *ifpr_prefix; /* prefix of interface */
347 struct ifnet *ifpr_ifp; /* back-pointer to interface */
348 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
349 u_char ifpr_plen; /* prefix length in bits */
350 u_char ifpr_type; /* protocol dependent prefix type */
354 * Multicast address structure. This is analogous to the ifaddr
355 * structure except that it keeps track of multicast addresses.
356 * Also, the reference count here is a count of requests for this
357 * address, not a count of pointers to this structure.
360 LIST_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
361 struct sockaddr *ifma_addr; /* address this membership is for */
362 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
363 struct ifnet *ifma_ifp; /* back-pointer to interface */
364 u_int ifma_refcount; /* reference count */
365 void *ifma_protospec; /* protocol-specific state, if any */
369 /* interface address change event */
370 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
371 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
372 /* new interface attach event */
373 typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *);
374 EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t);
375 /* interface detach event */
376 typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *);
377 EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t);
378 /* interface clone event */
379 typedef void (*if_clone_event_handler_t)(void *, struct if_clone *);
380 EVENTHANDLER_DECLARE(if_clone_event, if_clone_event_handler_t);
383 IFAREF(struct ifaddr *_ifa)
388 #include <sys/malloc.h>
390 MALLOC_DECLARE(M_IFADDR);
391 MALLOC_DECLARE(M_IFMADDR);
394 IFAFREE(struct ifaddr *_ifa)
396 if (_ifa->ifa_refcnt <= 0)
397 free(_ifa, M_IFADDR);
402 extern struct ifnethead ifnet;
403 extern struct ifnet **ifindex2ifnet;
404 extern int ifqmaxlen;
405 extern struct ifnet loif[];
407 extern struct ifaddr **ifnet_addrs;
409 void ether_ifattach(struct ifnet *, uint8_t *);
410 void ether_ifattach_bpf(struct ifnet *, uint8_t *, u_int, u_int);
411 void ether_ifdetach(struct ifnet *);
412 void ether_input(struct ifnet *, struct ether_header *, struct mbuf *);
413 void ether_demux(struct ifnet *, struct ether_header *, struct mbuf *);
414 int ether_output_frame(struct ifnet *, struct mbuf *);
415 int ether_ioctl(struct ifnet *, int, caddr_t);
416 uint32_t ether_crc32_le(const uint8_t *, size_t);
417 uint32_t ether_crc32_be(const uint8_t *, size_t);
419 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
420 int if_allmulti(struct ifnet *, int);
421 void if_attach(struct ifnet *);
422 int if_delmulti(struct ifnet *, struct sockaddr *);
423 void if_detach(struct ifnet *);
424 void if_down(struct ifnet *);
425 void if_initname(struct ifnet *, const char *, int);
426 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
427 void if_route(struct ifnet *, int flag, int fam);
428 int if_setlladdr(struct ifnet *, const u_char *, int);
429 void if_unroute(struct ifnet *, int flag, int fam);
430 void if_up(struct ifnet *);
431 /*void ifinit(void);*/ /* declared in systm.h for main() */
432 int ifioctl(struct socket *, u_long, caddr_t, struct thread *);
433 int ifpromisc(struct ifnet *, int);
434 struct ifnet *ifunit(const char *);
435 struct ifnet *if_withname(struct sockaddr *);
437 struct ifaddr *ifa_ifwithaddr(struct sockaddr *);
438 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
439 struct ifaddr *ifa_ifwithnet(struct sockaddr *);
440 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
441 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
443 struct ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
444 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
446 void if_clone_attach(struct if_clone *);
447 void if_clone_detach(struct if_clone *);
449 int if_clone_create(char *, int);
450 int if_clone_destroy(const char *);
452 #define IF_LLSOCKADDR(ifp) \
453 ((struct sockaddr_dl *) ifnet_addrs[(ifp)->if_index - 1]->ifa_addr)
454 #define IF_LLADDR(ifp) LLADDR(IF_LLSOCKADDR(ifp))
456 #ifdef DEVICE_POLLING
457 typedef void poll_handler_t (struct ifnet *ifp, enum poll_cmd cmd, int count);
458 int ether_poll_register(struct ifnet *);
459 int ether_poll_deregister(struct ifnet *);
460 void emergency_poll_enable(const char *);
461 #endif /* DEVICE_POLLING */
464 #endif /* !_NET_IF_VAR_H_ */