FreeBSD/Linux Kernel Cross Reference
sys/net/if_var.h
1 /*
2 * Copyright (c) 1982, 1986, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
20 *
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
31 * SUCH DAMAGE.
32 *
33 * From: @(#)if.h 8.1 (Berkeley) 6/10/93
34 * $FreeBSD: releng/5.2/sys/net/if_var.h 122524 2003-11-12 03:14:31Z rwatson $
35 */
36
37 #ifndef _NET_IF_VAR_H_
38 #define _NET_IF_VAR_H_
39
40 /*
41 * Structures defining a network interface, providing a packet
42 * transport mechanism (ala level 0 of the PUP protocols).
43 *
44 * Each interface accepts output datagrams of a specified maximum
45 * length, and provides higher level routines with input datagrams
46 * received from its medium.
47 *
48 * Output occurs when the routine if_output is called, with three parameters:
49 * (*ifp->if_output)(ifp, m, dst, rt)
50 * Here m is the mbuf chain to be sent and dst is the destination address.
51 * The output routine encapsulates the supplied datagram if necessary,
52 * and then transmits it on its medium.
53 *
54 * On input, each interface unwraps the data received by it, and either
55 * places it on the input queue of an internetwork datagram routine
56 * and posts the associated software interrupt, or passes the datagram to a raw
57 * packet input routine.
58 *
59 * Routines exist for locating interfaces by their addresses
60 * or for locating an interface on a certain network, as well as more general
61 * routing and gateway routines maintaining information used to locate
62 * interfaces. These routines live in the files if.c and route.c
63 */
64
65 #ifdef __STDC__
66 /*
67 * Forward structure declarations for function prototypes [sic].
68 */
69 struct mbuf;
70 struct thread;
71 struct rtentry;
72 struct rt_addrinfo;
73 struct socket;
74 struct ether_header;
75 #endif
76
77 #include <sys/queue.h> /* get TAILQ macros */
78
79 #ifdef _KERNEL
80 #include <sys/mbuf.h>
81 #endif /* _KERNEL */
82 #include <sys/lock.h> /* XXX */
83 #include <sys/mutex.h> /* XXX */
84 #include <sys/event.h> /* XXX */
85
86 #define IF_DUNIT_NONE -1
87
88 TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */
89 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */
90 TAILQ_HEAD(ifprefixhead, ifprefix);
91 TAILQ_HEAD(ifmultihead, ifmultiaddr);
92
93 /*
94 * Structure defining a queue for a network interface.
95 */
96 struct ifqueue {
97 struct mbuf *ifq_head;
98 struct mbuf *ifq_tail;
99 int ifq_len;
100 int ifq_maxlen;
101 int ifq_drops;
102 struct mtx ifq_mtx;
103 };
104
105 /*
106 * Structure defining a network interface.
107 *
108 * (Would like to call this struct ``if'', but C isn't PL/1.)
109 */
110
111 /*
112 * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with
113 * one of these structures, typically held within an arpcom structure.
114 *
115 * struct <foo>_softc {
116 * struct arpcom {
117 * struct ifnet ac_if;
118 * ...
119 * } <arpcom> ;
120 * ...
121 * };
122 *
123 * The assumption is used in a number of places, including many
124 * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
125 *
126 * Unfortunately devices' softc are opaque, so we depend on this layout
127 * to locate the struct ifnet from the softc in the generic code.
128 *
129 */
130 struct ifnet {
131 void *if_softc; /* pointer to driver state */
132 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */
133 char if_xname[IFNAMSIZ]; /* external name (name + unit) */
134 const char *if_dname; /* driver name */
135 int if_dunit; /* unit or IF_DUNIT_NONE */
136 struct ifaddrhead if_addrhead; /* linked list of addresses per if */
137 struct klist if_klist; /* events attached to this if */
138 int if_pcount; /* number of promiscuous listeners */
139 struct bpf_if *if_bpf; /* packet filter structure */
140 u_short if_index; /* numeric abbreviation for this if */
141 short if_timer; /* time 'til if_watchdog called */
142 u_short if_nvlans; /* number of active vlans */
143 int if_flags; /* up/down, broadcast, etc. */
144 int if_capabilities; /* interface capabilities */
145 int if_capenable; /* enabled features */
146 int if_ipending; /* interrupts pending */
147 void *if_linkmib; /* link-type-specific MIB data */
148 size_t if_linkmiblen; /* length of above data */
149 struct if_data if_data;
150 struct ifmultihead if_multiaddrs; /* multicast addresses configured */
151 int if_amcount; /* number of all-multicast requests */
152 /* procedure handles */
153 int (*if_output) /* output routine (enqueue) */
154 (struct ifnet *, struct mbuf *, struct sockaddr *,
155 struct rtentry *);
156 void (*if_input) /* input routine (from h/w driver) */
157 (struct ifnet *, struct mbuf *);
158 void (*if_start) /* initiate output routine */
159 (struct ifnet *);
160 int (*if_done) /* output complete routine */
161 (struct ifnet *); /* (XXX not used; fake prototype) */
162 int (*if_ioctl) /* ioctl routine */
163 (struct ifnet *, u_long, caddr_t);
164 void (*if_watchdog) /* timer routine */
165 (struct ifnet *);
166 int (*if_poll_recv) /* polled receive routine */
167 (struct ifnet *, int *);
168 int (*if_poll_xmit) /* polled transmit routine */
169 (struct ifnet *, int *);
170 void (*if_poll_intren) /* polled interrupt reenable routine */
171 (struct ifnet *);
172 void (*if_poll_slowinput) /* input routine for slow devices */
173 (struct ifnet *, struct mbuf *);
174 void (*if_init) /* Init routine */
175 (void *);
176 int (*if_resolvemulti) /* validate/resolve multicast */
177 (struct ifnet *, struct sockaddr **, struct sockaddr *);
178 struct ifqueue if_snd; /* output queue */
179 struct ifqueue *if_poll_slowq; /* input queue for slow devices */
180 struct ifprefixhead if_prefixhead; /* list of prefixes per if */
181 u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
182 struct label *if_label; /* interface MAC label */
183
184 void *if_afdata[AF_MAX];
185 int if_afdata_initialized;
186 struct mtx if_afdata_mtx;
187 };
188
189 typedef void if_init_f_t(void *);
190
191 #define if_mtu if_data.ifi_mtu
192 #define if_type if_data.ifi_type
193 #define if_physical if_data.ifi_physical
194 #define if_addrlen if_data.ifi_addrlen
195 #define if_hdrlen if_data.ifi_hdrlen
196 #define if_metric if_data.ifi_metric
197 #define if_baudrate if_data.ifi_baudrate
198 #define if_hwassist if_data.ifi_hwassist
199 #define if_ipackets if_data.ifi_ipackets
200 #define if_ierrors if_data.ifi_ierrors
201 #define if_opackets if_data.ifi_opackets
202 #define if_oerrors if_data.ifi_oerrors
203 #define if_collisions if_data.ifi_collisions
204 #define if_ibytes if_data.ifi_ibytes
205 #define if_obytes if_data.ifi_obytes
206 #define if_imcasts if_data.ifi_imcasts
207 #define if_omcasts if_data.ifi_omcasts
208 #define if_iqdrops if_data.ifi_iqdrops
209 #define if_noproto if_data.ifi_noproto
210 #define if_lastchange if_data.ifi_lastchange
211 #define if_recvquota if_data.ifi_recvquota
212 #define if_xmitquota if_data.ifi_xmitquota
213 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0)
214
215 /* for compatibility with other BSDs */
216 #define if_addrlist if_addrhead
217 #define if_list if_link
218
219 /*
220 * Bit values in if_ipending
221 */
222 #define IFI_RECV 1 /* I want to receive */
223 #define IFI_XMIT 2 /* I want to transmit */
224
225 /*
226 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
227 * are queues of messages stored on ifqueue structures
228 * (defined above). Entries are added to and deleted from these structures
229 * by these macros, which should be called with ipl raised to splimp().
230 */
231 #define IF_LOCK(ifq) mtx_lock(&(ifq)->ifq_mtx)
232 #define IF_UNLOCK(ifq) mtx_unlock(&(ifq)->ifq_mtx)
233 #define _IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
234 #define _IF_DROP(ifq) ((ifq)->ifq_drops++)
235 #define _IF_QLEN(ifq) ((ifq)->ifq_len)
236
237 #define _IF_ENQUEUE(ifq, m) do { \
238 (m)->m_nextpkt = NULL; \
239 if ((ifq)->ifq_tail == NULL) \
240 (ifq)->ifq_head = m; \
241 else \
242 (ifq)->ifq_tail->m_nextpkt = m; \
243 (ifq)->ifq_tail = m; \
244 (ifq)->ifq_len++; \
245 } while (0)
246
247 #define IF_ENQUEUE(ifq, m) do { \
248 IF_LOCK(ifq); \
249 _IF_ENQUEUE(ifq, m); \
250 IF_UNLOCK(ifq); \
251 } while (0)
252
253 #define _IF_PREPEND(ifq, m) do { \
254 (m)->m_nextpkt = (ifq)->ifq_head; \
255 if ((ifq)->ifq_tail == NULL) \
256 (ifq)->ifq_tail = (m); \
257 (ifq)->ifq_head = (m); \
258 (ifq)->ifq_len++; \
259 } while (0)
260
261 #define IF_PREPEND(ifq, m) do { \
262 IF_LOCK(ifq); \
263 _IF_PREPEND(ifq, m); \
264 IF_UNLOCK(ifq); \
265 } while (0)
266
267 #define _IF_DEQUEUE(ifq, m) do { \
268 (m) = (ifq)->ifq_head; \
269 if (m) { \
270 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
271 (ifq)->ifq_tail = NULL; \
272 (m)->m_nextpkt = NULL; \
273 (ifq)->ifq_len--; \
274 } \
275 } while (0)
276
277 #define IF_DEQUEUE(ifq, m) do { \
278 IF_LOCK(ifq); \
279 _IF_DEQUEUE(ifq, m); \
280 IF_UNLOCK(ifq); \
281 } while (0)
282
283 #define IF_DRAIN(ifq) do { \
284 struct mbuf *m; \
285 IF_LOCK(ifq); \
286 for (;;) { \
287 _IF_DEQUEUE(ifq, m); \
288 if (m == NULL) \
289 break; \
290 m_freem(m); \
291 } \
292 IF_UNLOCK(ifq); \
293 } while (0)
294
295 #ifdef _KERNEL
296 #define IF_AFDATA_LOCK_INIT(ifp) \
297 mtx_init(&(ifp)->if_afdata_mtx, "if_afdata", NULL, MTX_DEF)
298 #define IF_AFDATA_LOCK(ifp) mtx_lock(&(ifp)->if_afdata_mtx)
299 #define IF_AFDATA_TRYLOCK(ifp) mtx_trylock(&(ifp)->if_afdata_mtx)
300 #define IF_AFDATA_UNLOCK(ifp) mtx_unlock(&(ifp)->if_afdata_mtx)
301 #define IF_AFDATA_DESTROY(ifp) mtx_destroy(&(ifp)->if_afdata_mtx)
302
303 #define IF_HANDOFF(ifq, m, ifp) if_handoff(ifq, m, ifp, 0)
304 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj) if_handoff(ifq, m, ifp, adj)
305
306 static __inline int
307 if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp, int adjust)
308 {
309 int active = 0;
310
311 IF_LOCK(ifq);
312 if (_IF_QFULL(ifq)) {
313 _IF_DROP(ifq);
314 IF_UNLOCK(ifq);
315 m_freem(m);
316 return (0);
317 }
318 if (ifp != NULL) {
319 ifp->if_obytes += m->m_pkthdr.len + adjust;
320 if (m->m_flags & M_MCAST)
321 ifp->if_omcasts++;
322 active = ifp->if_flags & IFF_OACTIVE;
323 }
324 _IF_ENQUEUE(ifq, m);
325 IF_UNLOCK(ifq);
326 if (ifp != NULL && !active)
327 (*ifp->if_start)(ifp);
328 return (1);
329 }
330
331 /*
332 * 72 was chosen below because it is the size of a TCP/IP
333 * header (40) + the minimum mss (32).
334 */
335 #define IF_MINMTU 72
336 #define IF_MAXMTU 65535
337
338 #endif /* _KERNEL */
339
340 /*
341 * The ifaddr structure contains information about one address
342 * of an interface. They are maintained by the different address families,
343 * are allocated and attached when an address is set, and are linked
344 * together so all addresses for an interface can be located.
345 */
346 struct ifaddr {
347 struct sockaddr *ifa_addr; /* address of interface */
348 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
349 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
350 struct sockaddr *ifa_netmask; /* used to determine subnet */
351 struct if_data if_data; /* not all members are meaningful */
352 struct ifnet *ifa_ifp; /* back-pointer to interface */
353 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */
354 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
355 (int, struct rtentry *, struct rt_addrinfo *);
356 u_short ifa_flags; /* mostly rt_flags for cloning */
357 u_int ifa_refcnt; /* references to this structure */
358 int ifa_metric; /* cost of going out this interface */
359 #ifdef notdef
360 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */
361 #endif
362 int (*ifa_claim_addr) /* check if an addr goes to this if */
363 (struct ifaddr *, struct sockaddr *);
364 struct mtx ifa_mtx;
365 };
366 #define IFA_ROUTE RTF_UP /* route installed */
367
368 /* for compatibility with other BSDs */
369 #define ifa_list ifa_link
370
371 #define IFA_LOCK_INIT(ifa) \
372 mtx_init(&(ifa)->ifa_mtx, "ifaddr", NULL, MTX_DEF)
373 #define IFA_LOCK(ifa) mtx_lock(&(ifa)->ifa_mtx)
374 #define IFA_UNLOCK(ifa) mtx_unlock(&(ifa)->ifa_mtx)
375 #define IFA_DESTROY(ifa) mtx_destroy(&(ifa)->ifa_mtx)
376
377 /*
378 * The prefix structure contains information about one prefix
379 * of an interface. They are maintained by the different address families,
380 * are allocated and attached when a prefix or an address is set,
381 * and are linked together so all prefixes for an interface can be located.
382 */
383 struct ifprefix {
384 struct sockaddr *ifpr_prefix; /* prefix of interface */
385 struct ifnet *ifpr_ifp; /* back-pointer to interface */
386 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
387 u_char ifpr_plen; /* prefix length in bits */
388 u_char ifpr_type; /* protocol dependent prefix type */
389 };
390
391 /*
392 * Multicast address structure. This is analogous to the ifaddr
393 * structure except that it keeps track of multicast addresses.
394 * Also, the reference count here is a count of requests for this
395 * address, not a count of pointers to this structure.
396 */
397 struct ifmultiaddr {
398 TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
399 struct sockaddr *ifma_addr; /* address this membership is for */
400 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
401 struct ifnet *ifma_ifp; /* back-pointer to interface */
402 u_int ifma_refcount; /* reference count */
403 void *ifma_protospec; /* protocol-specific state, if any */
404 };
405
406 #ifdef _KERNEL
407 #define IFAFREE(ifa) \
408 do { \
409 IFA_LOCK(ifa); \
410 KASSERT((ifa)->ifa_refcnt > 0, \
411 ("ifa %p !(ifa_refcnt > 0)", ifa)); \
412 if (--(ifa)->ifa_refcnt == 0) { \
413 IFA_DESTROY(ifa); \
414 free(ifa, M_IFADDR); \
415 } else \
416 IFA_UNLOCK(ifa); \
417 } while (0)
418
419 #define IFAREF(ifa) \
420 do { \
421 IFA_LOCK(ifa); \
422 ++(ifa)->ifa_refcnt; \
423 IFA_UNLOCK(ifa); \
424 } while (0)
425
426 extern struct mtx ifnet_lock;
427 #define IFNET_LOCK_INIT() \
428 mtx_init(&ifnet_lock, "ifnet", NULL, MTX_DEF | MTX_RECURSE)
429 #define IFNET_WLOCK() mtx_lock(&ifnet_lock)
430 #define IFNET_WUNLOCK() mtx_unlock(&ifnet_lock)
431 #define IFNET_RLOCK() IFNET_WLOCK()
432 #define IFNET_RUNLOCK() IFNET_WUNLOCK()
433
434 struct ifindex_entry {
435 struct ifnet *ife_ifnet;
436 struct ifaddr *ife_ifnet_addr;
437 dev_t ife_dev;
438 };
439
440 #define ifnet_byindex(idx) ifindex_table[(idx)].ife_ifnet
441 #define ifaddr_byindex(idx) ifindex_table[(idx)].ife_ifnet_addr
442 #define ifdev_byindex(idx) ifindex_table[(idx)].ife_dev
443
444 extern struct ifnethead ifnet;
445 extern struct ifindex_entry *ifindex_table;
446 extern int ifqmaxlen;
447 extern struct ifnet *loif; /* first loopback interface */
448 extern int if_index;
449
450 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
451 int if_allmulti(struct ifnet *, int);
452 void if_attach(struct ifnet *);
453 int if_delmulti(struct ifnet *, struct sockaddr *);
454 void if_detach(struct ifnet *);
455 void if_down(struct ifnet *);
456 void if_initname(struct ifnet *, const char *, int);
457 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
458 void if_route(struct ifnet *, int flag, int fam);
459 int if_setlladdr(struct ifnet *, const u_char *, int);
460 void if_unroute(struct ifnet *, int flag, int fam);
461 void if_up(struct ifnet *);
462 /*void ifinit(void);*/ /* declared in systm.h for main() */
463 int ifioctl(struct socket *, u_long, caddr_t, struct thread *);
464 int ifpromisc(struct ifnet *, int);
465 struct ifnet *ifunit(const char *);
466 struct ifnet *if_withname(struct sockaddr *);
467
468 int if_poll_recv_slow(struct ifnet *ifp, int *quotap);
469 void if_poll_xmit_slow(struct ifnet *ifp, int *quotap);
470 void if_poll_throttle(void);
471 void if_poll_unthrottle(void *);
472 void if_poll_init(void);
473 void if_poll(void);
474
475 struct ifaddr *ifa_ifwithaddr(struct sockaddr *);
476 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
477 struct ifaddr *ifa_ifwithnet(struct sockaddr *);
478 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
479 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
480
481 struct ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
482 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
483
484 void if_clone_attach(struct if_clone *);
485 void if_clone_detach(struct if_clone *);
486
487 int if_clone_create(char *, int);
488 int if_clone_destroy(const char *);
489
490 #define IF_LLADDR(ifp) \
491 LLADDR((struct sockaddr_dl *) ifaddr_byindex((ifp)->if_index)->ifa_addr)
492
493 #ifdef DEVICE_POLLING
494 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER };
495
496 typedef void poll_handler_t(struct ifnet *ifp, enum poll_cmd cmd, int count);
497 int ether_poll_register(poll_handler_t *h, struct ifnet *ifp);
498 int ether_poll_deregister(struct ifnet *ifp);
499 #endif /* DEVICE_POLLING */
500
501 #endif /* _KERNEL */
502
503 #endif /* !_NET_IF_VAR_H_ */
Cache object: da5a25e9520c1b1bb2ecf095f0a35be8
|