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.6 2003/12/30 01:01:48 dillon 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 a raw
58 * packet input routine.
60 * Routines exist for locating interfaces by their addresses
61 * or for locating a interface on a certain network, as well as more general
62 * routing and gateway routines maintaining information used to locate
63 * interfaces. These routines live in the files if.c and route.c
68 * Forward structure declarations for function prototypes [sic].
78 #include <sys/queue.h> /* get TAILQ macros */
82 #include <sys/systm.h> /* XXX */
85 #define IF_DUNIT_NONE -1
87 TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */
88 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */
89 TAILQ_HEAD(ifprefixhead, ifprefix);
90 LIST_HEAD(ifmultihead, ifmultiaddr);
93 * Structure defining a queue for a network interface.
96 struct mbuf *ifq_head;
97 struct mbuf *ifq_tail;
104 * Structure defining a network interface.
106 * (Would like to call this struct ``if'', but C isn't PL/1.)
110 * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with
111 * one of these structures, typically held within an arpcom structure.
113 * struct <foo>_softc {
115 * struct ifnet ac_if;
121 * The assumption is used in a number of places, including many
122 * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
124 * Unfortunately devices' softc are opaque, so we depend on this layout
125 * to locate the struct ifnet from the softc in the generic code.
127 * Note that not all fields are used by drivers in the FreeBSD source
128 * tree. However, who knows what third party software does with fields
129 * marked as "unused", such as if_ipending, if_done, and if_poll*,
130 * so any attemt to redefine their meaning might end up in binary
131 * compatibility problems, even if the size of struct ifnet, and
132 * the size and position of its fields do not change.
133 * We just have to live with that.
136 void *if_softc; /* pointer to driver state */
137 /* XXX if_name -> if_dname */
138 const char *if_name; /* name, e.g. ``en'' or ``lo'' */
139 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */
140 char if_xname[IFNAMSIZ]; /* external name (name + unit) */
141 struct ifaddrhead if_addrhead; /* linked list of addresses per if */
142 int if_pcount; /* number of promiscuous listeners */
143 struct bpf_if *if_bpf; /* packet filter structure */
144 u_short if_index; /* numeric abbreviation for this if */
145 /* XXX if_unit -> if_dunit */
146 short if_unit; /* sub-unit for lower level driver */
147 short if_timer; /* time 'til if_watchdog called */
148 short if_flags; /* up/down, broadcast, etc. */
149 int if_ipending; /* interrupts pending */
150 void *if_linkmib; /* link-type-specific MIB data */
151 size_t if_linkmiblen; /* length of above data */
152 struct if_data if_data;
153 struct ifmultihead if_multiaddrs; /* multicast addresses configured */
154 int if_amcount; /* number of all-multicast requests */
155 /* procedure handles */
156 int (*if_output) /* output routine (enqueue) */
157 (struct ifnet *, struct mbuf *, struct sockaddr *,
159 void (*if_start) /* initiate output routine */
162 int (*if_done) /* output complete routine */
163 (struct ifnet *); /* (XXX not used) */
164 int uif_capabilities; /* interface capabilities */
166 int (*if_ioctl) /* ioctl routine */
167 (struct ifnet *, u_long, caddr_t);
168 void (*if_watchdog) /* timer routine */
171 int (*if_poll_recv) /* polled receive routine */
172 (struct ifnet *, int *);
173 int uif_capenable; /* enabled features */
175 int (*if_poll_xmit) /* polled transmit routine */
176 (struct ifnet *, int *);
177 void (*if_poll_intren) /* polled interrupt reenable routine */
179 void (*if_poll_slowinput) /* input routine for slow devices */
180 (struct ifnet *, struct mbuf *);
181 void (*if_init) /* Init routine */
183 int (*if_resolvemulti) /* validate/resolve multicast */
184 (struct ifnet *, struct sockaddr **, struct sockaddr *);
185 struct ifqueue if_snd; /* output queue */
186 struct ifqueue *if_poll_slowq; /* input queue for slow devices */
187 struct ifprefixhead if_prefixhead; /* list of prefixes per if */
189 typedef void if_init_f_t (void *);
192 * Binary compatibility gunk for 4.x ONLY.
194 #define if_capabilities _u1.uif_capabilities
195 #define if_capenable _u2.uif_capenable
197 #define if_mtu if_data.ifi_mtu
198 #define if_type if_data.ifi_type
199 #define if_physical if_data.ifi_physical
200 #define if_addrlen if_data.ifi_addrlen
201 #define if_hdrlen if_data.ifi_hdrlen
202 #define if_metric if_data.ifi_metric
203 #define if_baudrate if_data.ifi_baudrate
204 #define if_hwassist if_data.ifi_hwassist
205 #define if_ipackets if_data.ifi_ipackets
206 #define if_ierrors if_data.ifi_ierrors
207 #define if_opackets if_data.ifi_opackets
208 #define if_oerrors if_data.ifi_oerrors
209 #define if_collisions if_data.ifi_collisions
210 #define if_ibytes if_data.ifi_ibytes
211 #define if_obytes if_data.ifi_obytes
212 #define if_imcasts if_data.ifi_imcasts
213 #define if_omcasts if_data.ifi_omcasts
214 #define if_iqdrops if_data.ifi_iqdrops
215 #define if_noproto if_data.ifi_noproto
216 #define if_lastchange if_data.ifi_lastchange
217 #define if_recvquota if_data.ifi_recvquota
218 #define if_xmitquota if_data.ifi_xmitquota
219 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0)
221 /* for compatibility with other BSDs */
222 #define if_addrlist if_addrhead
223 #define if_list if_link
226 * Bit values in if_ipending
228 #define IFI_RECV 1 /* I want to receive */
229 #define IFI_XMIT 2 /* I want to transmit */
232 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
233 * are queues of messages stored on ifqueue structures
234 * (defined above). Entries are added to and deleted from these structures
235 * by these macros, which should be called with ipl raised to splimp().
237 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
238 #define IF_DROP(ifq) ((ifq)->ifq_drops++)
239 #define IF_ENQUEUE(ifq, m) { \
240 (m)->m_nextpkt = 0; \
241 if ((ifq)->ifq_tail == 0) \
242 (ifq)->ifq_head = m; \
244 (ifq)->ifq_tail->m_nextpkt = m; \
245 (ifq)->ifq_tail = m; \
248 #define IF_PREPEND(ifq, m) { \
249 (m)->m_nextpkt = (ifq)->ifq_head; \
250 if ((ifq)->ifq_tail == 0) \
251 (ifq)->ifq_tail = (m); \
252 (ifq)->ifq_head = (m); \
255 #define IF_DEQUEUE(ifq, m) { \
256 (m) = (ifq)->ifq_head; \
258 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
259 (ifq)->ifq_tail = 0; \
260 (m)->m_nextpkt = 0; \
264 #define IF_DRAIN(ifq) do { \
267 IF_DEQUEUE(ifq, m); \
277 * #define _IF_QFULL for compatibility with -current
279 #define _IF_QFULL(ifq) IF_QFULL(ifq)
281 #define IF_HANDOFF(ifq, m, ifp) if_handoff(ifq, m, ifp, 0)
282 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj) if_handoff(ifq, m, ifp, adj)
285 if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp, int adjust)
287 int need_if_start = 0;
297 ifp->if_obytes += m->m_pkthdr.len + adjust;
298 if (m->m_flags & M_MCAST)
300 need_if_start = !(ifp->if_flags & IFF_OACTIVE);
304 (*ifp->if_start)(ifp);
310 * 72 was chosen below because it is the size of a TCP/IP
311 * header (40) + the minimum mss (32).
314 #define IF_MAXMTU 65535
319 * The ifaddr structure contains information about one address
320 * of an interface. They are maintained by the different address families,
321 * are allocated and attached when an address is set, and are linked
322 * together so all addresses for an interface can be located.
325 struct sockaddr *ifa_addr; /* address of interface */
326 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
327 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
328 struct sockaddr *ifa_netmask; /* used to determine subnet */
329 struct if_data if_data; /* not all members are meaningful */
330 struct ifnet *ifa_ifp; /* back-pointer to interface */
331 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */
332 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
333 (int, struct rtentry *, struct rt_addrinfo *);
334 u_short ifa_flags; /* mostly rt_flags for cloning */
335 u_int ifa_refcnt; /* references to this structure */
336 int ifa_metric; /* cost of going out this interface */
338 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */
340 int (*ifa_claim_addr) /* check if an addr goes to this if */
341 (struct ifaddr *, struct sockaddr *);
344 #define IFA_ROUTE RTF_UP /* route installed */
346 /* for compatibility with other BSDs */
347 #define ifa_list ifa_link
350 * The prefix structure contains information about one prefix
351 * of an interface. They are maintained by the different address families,
352 * are allocated and attached when an prefix or an address is set,
353 * and are linked together so all prefixes for an interface can be located.
356 struct sockaddr *ifpr_prefix; /* prefix of interface */
357 struct ifnet *ifpr_ifp; /* back-pointer to interface */
358 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
359 u_char ifpr_plen; /* prefix length in bits */
360 u_char ifpr_type; /* protocol dependent prefix type */
364 * Multicast address structure. This is analogous to the ifaddr
365 * structure except that it keeps track of multicast addresses.
366 * Also, the reference count here is a count of requests for this
367 * address, not a count of pointers to this structure.
370 LIST_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
371 struct sockaddr *ifma_addr; /* address this membership is for */
372 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
373 struct ifnet *ifma_ifp; /* back-pointer to interface */
374 u_int ifma_refcount; /* reference count */
375 void *ifma_protospec; /* protocol-specific state, if any */
379 #define IFAFREE(ifa) \
381 if ((ifa)->ifa_refcnt <= 0) \
384 (ifa)->ifa_refcnt--; \
387 extern struct ifnethead ifnet;
388 extern struct ifnet **ifindex2ifnet;
389 extern int ifqmaxlen;
390 extern struct ifnet loif[];
392 extern struct ifaddr **ifnet_addrs;
394 void ether_ifattach(struct ifnet *, int);
395 void ether_ifdetach(struct ifnet *, int);
396 void ether_input(struct ifnet *, struct ether_header *, struct mbuf *);
397 void ether_demux(struct ifnet *, struct ether_header *, struct mbuf *);
398 int ether_output(struct ifnet *,
399 struct mbuf *, struct sockaddr *, struct rtentry *);
400 int ether_output_frame(struct ifnet *, struct mbuf *);
401 int ether_ioctl(struct ifnet *, int, caddr_t);
403 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
404 int if_allmulti(struct ifnet *, int);
405 void if_attach(struct ifnet *);
406 int if_delmulti(struct ifnet *, struct sockaddr *);
407 void if_detach(struct ifnet *);
408 void if_down(struct ifnet *);
409 void if_initname(struct ifnet *, const char *, int);
410 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
411 void if_route(struct ifnet *, int flag, int fam);
412 int if_setlladdr(struct ifnet *, const u_char *, int);
413 void if_unroute(struct ifnet *, int flag, int fam);
414 void if_up(struct ifnet *);
415 /*void ifinit(void);*/ /* declared in systm.h for main() */
416 int ifioctl(struct socket *, u_long, caddr_t, struct thread *);
417 int ifpromisc(struct ifnet *, int);
418 struct ifnet *ifunit(const char *);
419 struct ifnet *if_withname(struct sockaddr *);
421 struct ifaddr *ifa_ifwithaddr(struct sockaddr *);
422 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
423 struct ifaddr *ifa_ifwithnet(struct sockaddr *);
424 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
425 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
426 void ifafree(struct ifaddr *);
428 struct ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
429 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
431 void if_clone_attach(struct if_clone *);
432 void if_clone_detach(struct if_clone *);
434 int if_clone_create(char *, int);
435 int if_clone_destroy(const char *);
437 #define IF_LLADDR(ifp) \
438 LLADDR((struct sockaddr_dl *) ifnet_addrs[ifp->if_index - 1]->ifa_addr)
440 #ifdef DEVICE_POLLING
441 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER };
443 typedef void poll_handler_t (struct ifnet *ifp,
444 enum poll_cmd cmd, int count);
445 int ether_poll_register(poll_handler_t *h, struct ifnet *ifp);
446 int ether_poll_deregister(struct ifnet *ifp);
447 #endif /* DEVICE_POLLING */
450 #endif /* !_NET_IF_VAR_H_ */