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 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * From: @(#)if.h 8.1 (Berkeley) 6/10/93
30 * $FreeBSD: head/sys/net/if_var.h 199975 2009-11-30 21:25:57Z jhb $
31 */
32
33 #ifndef _NET_IF_VAR_H_
34 #define _NET_IF_VAR_H_
35
36 /*
37 * Structures defining a network interface, providing a packet
38 * transport mechanism (ala level 0 of the PUP protocols).
39 *
40 * Each interface accepts output datagrams of a specified maximum
41 * length, and provides higher level routines with input datagrams
42 * received from its medium.
43 *
44 * Output occurs when the routine if_output is called, with three parameters:
45 * (*ifp->if_output)(ifp, m, dst, rt)
46 * Here m is the mbuf chain to be sent and dst is the destination address.
47 * The output routine encapsulates the supplied datagram if necessary,
48 * and then transmits it on its medium.
49 *
50 * On input, each interface unwraps the data received by it, and either
51 * places it on the input queue of an internetwork datagram routine
52 * and posts the associated software interrupt, or passes the datagram to a raw
53 * packet input routine.
54 *
55 * Routines exist for locating interfaces by their addresses
56 * or for locating an interface on a certain network, as well as more general
57 * routing and gateway routines maintaining information used to locate
58 * interfaces. These routines live in the files if.c and route.c
59 */
60
61 #ifdef __STDC__
62 /*
63 * Forward structure declarations for function prototypes [sic].
64 */
65 struct mbuf;
66 struct thread;
67 struct rtentry;
68 struct rt_addrinfo;
69 struct socket;
70 struct ether_header;
71 struct carp_if;
72 struct ifvlantrunk;
73 struct route;
74 struct vnet;
75 #endif
76
77 #include <sys/queue.h> /* get TAILQ macros */
78
79 #ifdef _KERNEL
80 #include <sys/mbuf.h>
81 #include <sys/eventhandler.h>
82 #include <sys/buf_ring.h>
83 #include <net/vnet.h>
84 #endif /* _KERNEL */
85 #include <sys/lock.h> /* XXX */
86 #include <sys/mutex.h> /* XXX */
87 #include <sys/rwlock.h> /* XXX */
88 #include <sys/sx.h> /* XXX */
89 #include <sys/event.h> /* XXX */
90 #include <sys/_task.h>
91
92 #define IF_DUNIT_NONE -1
93
94 #include <altq/if_altq.h>
95
96 TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */
97 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */
98 TAILQ_HEAD(ifprefixhead, ifprefix);
99 TAILQ_HEAD(ifmultihead, ifmultiaddr);
100 TAILQ_HEAD(ifgrouphead, ifg_group);
101
102 /*
103 * Structure defining a queue for a network interface.
104 */
105 struct ifqueue {
106 struct mbuf *ifq_head;
107 struct mbuf *ifq_tail;
108 int ifq_len;
109 int ifq_maxlen;
110 int ifq_drops;
111 struct mtx ifq_mtx;
112 };
113
114 /*
115 * Structure defining a network interface.
116 *
117 * (Would like to call this struct ``if'', but C isn't PL/1.)
118 */
119
120 struct ifnet {
121 void *if_softc; /* pointer to driver state */
122 void *if_l2com; /* pointer to protocol bits */
123 struct vnet *if_vnet; /* pointer to network stack instance */
124 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */
125 char if_xname[IFNAMSIZ]; /* external name (name + unit) */
126 const char *if_dname; /* driver name */
127 int if_dunit; /* unit or IF_DUNIT_NONE */
128 u_int if_refcount; /* reference count */
129 struct ifaddrhead if_addrhead; /* linked list of addresses per if */
130 /*
131 * if_addrhead is the list of all addresses associated to
132 * an interface.
133 * Some code in the kernel assumes that first element
134 * of the list has type AF_LINK, and contains sockaddr_dl
135 * addresses which store the link-level address and the name
136 * of the interface.
137 * However, access to the AF_LINK address through this
138 * field is deprecated. Use if_addr or ifaddr_byindex() instead.
139 */
140 int if_pcount; /* number of promiscuous listeners */
141 struct carp_if *if_carp; /* carp interface structure */
142 struct bpf_if *if_bpf; /* packet filter structure */
143 u_short if_index; /* numeric abbreviation for this if */
144 short if_index_reserved; /* spare space to grow if_index */
145 struct ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */
146 int if_flags; /* up/down, broadcast, etc. */
147 int if_capabilities; /* interface features & capabilities */
148 int if_capenable; /* enabled features & capabilities */
149 void *if_linkmib; /* link-type-specific MIB data */
150 size_t if_linkmiblen; /* length of above data */
151 struct if_data if_data;
152 struct ifmultihead if_multiaddrs; /* multicast addresses configured */
153 int if_amcount; /* number of all-multicast requests */
154 /* procedure handles */
155 int (*if_output) /* output routine (enqueue) */
156 (struct ifnet *, struct mbuf *, struct sockaddr *,
157 struct route *);
158 void (*if_input) /* input routine (from h/w driver) */
159 (struct ifnet *, struct mbuf *);
160 void (*if_start) /* initiate output routine */
161 (struct ifnet *);
162 int (*if_ioctl) /* ioctl routine */
163 (struct ifnet *, u_long, caddr_t);
164 void (*if_init) /* Init routine */
165 (void *);
166 int (*if_resolvemulti) /* validate/resolve multicast */
167 (struct ifnet *, struct sockaddr **, struct sockaddr *);
168 void (*if_qflush) /* flush any queues */
169 (struct ifnet *);
170 int (*if_transmit) /* initiate output routine */
171 (struct ifnet *, struct mbuf *);
172 void (*if_reassign) /* reassign to vnet routine */
173 (struct ifnet *, struct vnet *, char *);
174 struct vnet *if_home_vnet; /* where this ifnet originates from */
175 struct ifaddr *if_addr; /* pointer to link-level address */
176 void *if_llsoftc; /* link layer softc */
177 int if_drv_flags; /* driver-managed status flags */
178 struct ifaltq if_snd; /* output queue (includes altq) */
179 const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
180
181 void *if_bridge; /* bridge glue */
182
183 struct label *if_label; /* interface MAC label */
184
185 /* these are only used by IPv6 */
186 struct ifprefixhead if_prefixhead; /* list of prefixes per if */
187 void *if_afdata[AF_MAX];
188 int if_afdata_initialized;
189 struct rwlock if_afdata_lock;
190 struct task if_linktask; /* task for link change events */
191 struct mtx if_addr_mtx; /* mutex to protect address lists */
192
193 LIST_ENTRY(ifnet) if_clones; /* interfaces of a cloner */
194 TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
195 /* protected by if_addr_mtx */
196 void *if_pf_kif;
197 void *if_lagg; /* lagg glue */
198 u_char if_alloctype; /* if_type at time of allocation */
199
200 /*
201 * Spare fields are added so that we can modify sensitive data
202 * structures without changing the kernel binary interface, and must
203 * be used with care where binary compatibility is required.
204 */
205 char if_cspare[3];
206 void *if_pspare[8];
207 int if_ispare[4];
208 };
209
210 typedef void if_init_f_t(void *);
211
212 /*
213 * XXX These aliases are terribly dangerous because they could apply
214 * to anything.
215 */
216 #define if_mtu if_data.ifi_mtu
217 #define if_type if_data.ifi_type
218 #define if_physical if_data.ifi_physical
219 #define if_addrlen if_data.ifi_addrlen
220 #define if_hdrlen if_data.ifi_hdrlen
221 #define if_metric if_data.ifi_metric
222 #define if_link_state if_data.ifi_link_state
223 #define if_baudrate if_data.ifi_baudrate
224 #define if_hwassist if_data.ifi_hwassist
225 #define if_ipackets if_data.ifi_ipackets
226 #define if_ierrors if_data.ifi_ierrors
227 #define if_opackets if_data.ifi_opackets
228 #define if_oerrors if_data.ifi_oerrors
229 #define if_collisions if_data.ifi_collisions
230 #define if_ibytes if_data.ifi_ibytes
231 #define if_obytes if_data.ifi_obytes
232 #define if_imcasts if_data.ifi_imcasts
233 #define if_omcasts if_data.ifi_omcasts
234 #define if_iqdrops if_data.ifi_iqdrops
235 #define if_noproto if_data.ifi_noproto
236 #define if_lastchange if_data.ifi_lastchange
237
238 /* for compatibility with other BSDs */
239 #define if_addrlist if_addrhead
240 #define if_list if_link
241 #define if_name(ifp) ((ifp)->if_xname)
242
243 /*
244 * Locks for address lists on the network interface.
245 */
246 #define IF_ADDR_LOCK_INIT(if) mtx_init(&(if)->if_addr_mtx, \
247 "if_addr_mtx", NULL, MTX_DEF)
248 #define IF_ADDR_LOCK_DESTROY(if) mtx_destroy(&(if)->if_addr_mtx)
249 #define IF_ADDR_LOCK(if) mtx_lock(&(if)->if_addr_mtx)
250 #define IF_ADDR_UNLOCK(if) mtx_unlock(&(if)->if_addr_mtx)
251 #define IF_ADDR_LOCK_ASSERT(if) mtx_assert(&(if)->if_addr_mtx, MA_OWNED)
252
253 /*
254 * Function variations on locking macros intended to be used by loadable
255 * kernel modules in order to divorce them from the internals of address list
256 * locking.
257 */
258 void if_addr_rlock(struct ifnet *ifp); /* if_addrhead */
259 void if_addr_runlock(struct ifnet *ifp); /* if_addrhead */
260 void if_maddr_rlock(struct ifnet *ifp); /* if_multiaddrs */
261 void if_maddr_runlock(struct ifnet *ifp); /* if_multiaddrs */
262
263 /*
264 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
265 * are queues of messages stored on ifqueue structures
266 * (defined above). Entries are added to and deleted from these structures
267 * by these macros, which should be called with ipl raised to splimp().
268 */
269 #define IF_LOCK(ifq) mtx_lock(&(ifq)->ifq_mtx)
270 #define IF_UNLOCK(ifq) mtx_unlock(&(ifq)->ifq_mtx)
271 #define IF_LOCK_ASSERT(ifq) mtx_assert(&(ifq)->ifq_mtx, MA_OWNED)
272 #define _IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
273 #define _IF_DROP(ifq) ((ifq)->ifq_drops++)
274 #define _IF_QLEN(ifq) ((ifq)->ifq_len)
275
276 #define _IF_ENQUEUE(ifq, m) do { \
277 (m)->m_nextpkt = NULL; \
278 if ((ifq)->ifq_tail == NULL) \
279 (ifq)->ifq_head = m; \
280 else \
281 (ifq)->ifq_tail->m_nextpkt = m; \
282 (ifq)->ifq_tail = m; \
283 (ifq)->ifq_len++; \
284 } while (0)
285
286 #define IF_ENQUEUE(ifq, m) do { \
287 IF_LOCK(ifq); \
288 _IF_ENQUEUE(ifq, m); \
289 IF_UNLOCK(ifq); \
290 } while (0)
291
292 #define _IF_PREPEND(ifq, m) do { \
293 (m)->m_nextpkt = (ifq)->ifq_head; \
294 if ((ifq)->ifq_tail == NULL) \
295 (ifq)->ifq_tail = (m); \
296 (ifq)->ifq_head = (m); \
297 (ifq)->ifq_len++; \
298 } while (0)
299
300 #define IF_PREPEND(ifq, m) do { \
301 IF_LOCK(ifq); \
302 _IF_PREPEND(ifq, m); \
303 IF_UNLOCK(ifq); \
304 } while (0)
305
306 #define _IF_DEQUEUE(ifq, m) do { \
307 (m) = (ifq)->ifq_head; \
308 if (m) { \
309 if (((ifq)->ifq_head = (m)->m_nextpkt) == NULL) \
310 (ifq)->ifq_tail = NULL; \
311 (m)->m_nextpkt = NULL; \
312 (ifq)->ifq_len--; \
313 } \
314 } while (0)
315
316 #define IF_DEQUEUE(ifq, m) do { \
317 IF_LOCK(ifq); \
318 _IF_DEQUEUE(ifq, m); \
319 IF_UNLOCK(ifq); \
320 } while (0)
321
322 #define _IF_POLL(ifq, m) ((m) = (ifq)->ifq_head)
323 #define IF_POLL(ifq, m) _IF_POLL(ifq, m)
324
325 #define _IF_DRAIN(ifq) do { \
326 struct mbuf *m; \
327 for (;;) { \
328 _IF_DEQUEUE(ifq, m); \
329 if (m == NULL) \
330 break; \
331 m_freem(m); \
332 } \
333 } while (0)
334
335 #define IF_DRAIN(ifq) do { \
336 IF_LOCK(ifq); \
337 _IF_DRAIN(ifq); \
338 IF_UNLOCK(ifq); \
339 } while(0)
340
341 #ifdef _KERNEL
342 /* interface address change event */
343 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
344 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
345 /* new interface arrival event */
346 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
347 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
348 /* interface departure event */
349 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
350 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
351
352 /*
353 * interface groups
354 */
355 struct ifg_group {
356 char ifg_group[IFNAMSIZ];
357 u_int ifg_refcnt;
358 void *ifg_pf_kif;
359 TAILQ_HEAD(, ifg_member) ifg_members;
360 TAILQ_ENTRY(ifg_group) ifg_next;
361 };
362
363 struct ifg_member {
364 TAILQ_ENTRY(ifg_member) ifgm_next;
365 struct ifnet *ifgm_ifp;
366 };
367
368 struct ifg_list {
369 struct ifg_group *ifgl_group;
370 TAILQ_ENTRY(ifg_list) ifgl_next;
371 };
372
373 /* group attach event */
374 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
375 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
376 /* group detach event */
377 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
378 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
379 /* group change event */
380 typedef void (*group_change_event_handler_t)(void *, const char *);
381 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
382
383 #define IF_AFDATA_LOCK_INIT(ifp) \
384 rw_init(&(ifp)->if_afdata_lock, "if_afdata")
385
386 #define IF_AFDATA_WLOCK(ifp) rw_wlock(&(ifp)->if_afdata_lock)
387 #define IF_AFDATA_RLOCK(ifp) rw_rlock(&(ifp)->if_afdata_lock)
388 #define IF_AFDATA_WUNLOCK(ifp) rw_wunlock(&(ifp)->if_afdata_lock)
389 #define IF_AFDATA_RUNLOCK(ifp) rw_runlock(&(ifp)->if_afdata_lock)
390 #define IF_AFDATA_LOCK(ifp) IF_AFDATA_WLOCK(ifp)
391 #define IF_AFDATA_UNLOCK(ifp) IF_AFDATA_WUNLOCK(ifp)
392 #define IF_AFDATA_TRYLOCK(ifp) rw_try_wlock(&(ifp)->if_afdata_lock)
393 #define IF_AFDATA_DESTROY(ifp) rw_destroy(&(ifp)->if_afdata_lock)
394
395 #define IF_AFDATA_LOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_LOCKED)
396 #define IF_AFDATA_UNLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_UNLOCKED)
397
398 int if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp,
399 int adjust);
400 #define IF_HANDOFF(ifq, m, ifp) \
401 if_handoff((struct ifqueue *)ifq, m, ifp, 0)
402 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj) \
403 if_handoff((struct ifqueue *)ifq, m, ifp, adj)
404
405 void if_start(struct ifnet *);
406
407 #define IFQ_ENQUEUE(ifq, m, err) \
408 do { \
409 IF_LOCK(ifq); \
410 if (ALTQ_IS_ENABLED(ifq)) \
411 ALTQ_ENQUEUE(ifq, m, NULL, err); \
412 else { \
413 if (_IF_QFULL(ifq)) { \
414 m_freem(m); \
415 (err) = ENOBUFS; \
416 } else { \
417 _IF_ENQUEUE(ifq, m); \
418 (err) = 0; \
419 } \
420 } \
421 if (err) \
422 (ifq)->ifq_drops++; \
423 IF_UNLOCK(ifq); \
424 } while (0)
425
426 #define IFQ_DEQUEUE_NOLOCK(ifq, m) \
427 do { \
428 if (TBR_IS_ENABLED(ifq)) \
429 (m) = tbr_dequeue_ptr(ifq, ALTDQ_REMOVE); \
430 else if (ALTQ_IS_ENABLED(ifq)) \
431 ALTQ_DEQUEUE(ifq, m); \
432 else \
433 _IF_DEQUEUE(ifq, m); \
434 } while (0)
435
436 #define IFQ_DEQUEUE(ifq, m) \
437 do { \
438 IF_LOCK(ifq); \
439 IFQ_DEQUEUE_NOLOCK(ifq, m); \
440 IF_UNLOCK(ifq); \
441 } while (0)
442
443 #define IFQ_POLL_NOLOCK(ifq, m) \
444 do { \
445 if (TBR_IS_ENABLED(ifq)) \
446 (m) = tbr_dequeue_ptr(ifq, ALTDQ_POLL); \
447 else if (ALTQ_IS_ENABLED(ifq)) \
448 ALTQ_POLL(ifq, m); \
449 else \
450 _IF_POLL(ifq, m); \
451 } while (0)
452
453 #define IFQ_POLL(ifq, m) \
454 do { \
455 IF_LOCK(ifq); \
456 IFQ_POLL_NOLOCK(ifq, m); \
457 IF_UNLOCK(ifq); \
458 } while (0)
459
460 #define IFQ_PURGE_NOLOCK(ifq) \
461 do { \
462 if (ALTQ_IS_ENABLED(ifq)) { \
463 ALTQ_PURGE(ifq); \
464 } else \
465 _IF_DRAIN(ifq); \
466 } while (0)
467
468 #define IFQ_PURGE(ifq) \
469 do { \
470 IF_LOCK(ifq); \
471 IFQ_PURGE_NOLOCK(ifq); \
472 IF_UNLOCK(ifq); \
473 } while (0)
474
475 #define IFQ_SET_READY(ifq) \
476 do { ((ifq)->altq_flags |= ALTQF_READY); } while (0)
477
478 #define IFQ_LOCK(ifq) IF_LOCK(ifq)
479 #define IFQ_UNLOCK(ifq) IF_UNLOCK(ifq)
480 #define IFQ_LOCK_ASSERT(ifq) IF_LOCK_ASSERT(ifq)
481 #define IFQ_IS_EMPTY(ifq) ((ifq)->ifq_len == 0)
482 #define IFQ_INC_LEN(ifq) ((ifq)->ifq_len++)
483 #define IFQ_DEC_LEN(ifq) (--(ifq)->ifq_len)
484 #define IFQ_INC_DROPS(ifq) ((ifq)->ifq_drops++)
485 #define IFQ_SET_MAXLEN(ifq, len) ((ifq)->ifq_maxlen = (len))
486
487 /*
488 * The IFF_DRV_OACTIVE test should really occur in the device driver, not in
489 * the handoff logic, as that flag is locked by the device driver.
490 */
491 #define IFQ_HANDOFF_ADJ(ifp, m, adj, err) \
492 do { \
493 int len; \
494 short mflags; \
495 \
496 len = (m)->m_pkthdr.len; \
497 mflags = (m)->m_flags; \
498 IFQ_ENQUEUE(&(ifp)->if_snd, m, err); \
499 if ((err) == 0) { \
500 (ifp)->if_obytes += len + (adj); \
501 if (mflags & M_MCAST) \
502 (ifp)->if_omcasts++; \
503 if (((ifp)->if_drv_flags & IFF_DRV_OACTIVE) == 0) \
504 if_start(ifp); \
505 } \
506 } while (0)
507
508 #define IFQ_HANDOFF(ifp, m, err) \
509 IFQ_HANDOFF_ADJ(ifp, m, 0, err)
510
511 #define IFQ_DRV_DEQUEUE(ifq, m) \
512 do { \
513 (m) = (ifq)->ifq_drv_head; \
514 if (m) { \
515 if (((ifq)->ifq_drv_head = (m)->m_nextpkt) == NULL) \
516 (ifq)->ifq_drv_tail = NULL; \
517 (m)->m_nextpkt = NULL; \
518 (ifq)->ifq_drv_len--; \
519 } else { \
520 IFQ_LOCK(ifq); \
521 IFQ_DEQUEUE_NOLOCK(ifq, m); \
522 while ((ifq)->ifq_drv_len < (ifq)->ifq_drv_maxlen) { \
523 struct mbuf *m0; \
524 IFQ_DEQUEUE_NOLOCK(ifq, m0); \
525 if (m0 == NULL) \
526 break; \
527 m0->m_nextpkt = NULL; \
528 if ((ifq)->ifq_drv_tail == NULL) \
529 (ifq)->ifq_drv_head = m0; \
530 else \
531 (ifq)->ifq_drv_tail->m_nextpkt = m0; \
532 (ifq)->ifq_drv_tail = m0; \
533 (ifq)->ifq_drv_len++; \
534 } \
535 IFQ_UNLOCK(ifq); \
536 } \
537 } while (0)
538
539 #define IFQ_DRV_PREPEND(ifq, m) \
540 do { \
541 (m)->m_nextpkt = (ifq)->ifq_drv_head; \
542 if ((ifq)->ifq_drv_tail == NULL) \
543 (ifq)->ifq_drv_tail = (m); \
544 (ifq)->ifq_drv_head = (m); \
545 (ifq)->ifq_drv_len++; \
546 } while (0)
547
548 #define IFQ_DRV_IS_EMPTY(ifq) \
549 (((ifq)->ifq_drv_len == 0) && ((ifq)->ifq_len == 0))
550
551 #define IFQ_DRV_PURGE(ifq) \
552 do { \
553 struct mbuf *m, *n = (ifq)->ifq_drv_head; \
554 while((m = n) != NULL) { \
555 n = m->m_nextpkt; \
556 m_freem(m); \
557 } \
558 (ifq)->ifq_drv_head = (ifq)->ifq_drv_tail = NULL; \
559 (ifq)->ifq_drv_len = 0; \
560 IFQ_PURGE(ifq); \
561 } while (0)
562
563 #ifdef _KERNEL
564 static __inline void
565 drbr_stats_update(struct ifnet *ifp, int len, int mflags)
566 {
567 #ifndef NO_SLOW_STATS
568 ifp->if_obytes += len;
569 if (mflags & M_MCAST)
570 ifp->if_omcasts++;
571 #endif
572 }
573
574 static __inline int
575 drbr_enqueue(struct ifnet *ifp, struct buf_ring *br, struct mbuf *m)
576 {
577 int error = 0;
578 int len = m->m_pkthdr.len;
579 int mflags = m->m_flags;
580
581 #ifdef ALTQ
582 if (ALTQ_IS_ENABLED(&ifp->if_snd)) {
583 IFQ_ENQUEUE(&ifp->if_snd, m, error);
584 return (error);
585 }
586 #endif
587 if ((error = buf_ring_enqueue_bytes(br, m, len)) == ENOBUFS) {
588 br->br_drops++;
589 m_freem(m);
590 } else
591 drbr_stats_update(ifp, len, mflags);
592
593 return (error);
594 }
595
596 static __inline void
597 drbr_flush(struct ifnet *ifp, struct buf_ring *br)
598 {
599 struct mbuf *m;
600
601 #ifdef ALTQ
602 if (ifp != NULL && ALTQ_IS_ENABLED(&ifp->if_snd)) {
603 while (!IFQ_IS_EMPTY(&ifp->if_snd)) {
604 IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
605 m_freem(m);
606 }
607 }
608 #endif
609 while ((m = buf_ring_dequeue_sc(br)) != NULL)
610 m_freem(m);
611 }
612
613 static __inline void
614 drbr_free(struct buf_ring *br, struct malloc_type *type)
615 {
616
617 drbr_flush(NULL, br);
618 buf_ring_free(br, type);
619 }
620
621 static __inline struct mbuf *
622 drbr_dequeue(struct ifnet *ifp, struct buf_ring *br)
623 {
624 #ifdef ALTQ
625 struct mbuf *m;
626
627 if (ALTQ_IS_ENABLED(&ifp->if_snd)) {
628 IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
629 return (m);
630 }
631 #endif
632 return (buf_ring_dequeue_sc(br));
633 }
634
635 static __inline struct mbuf *
636 drbr_dequeue_cond(struct ifnet *ifp, struct buf_ring *br,
637 int (*func) (struct mbuf *, void *), void *arg)
638 {
639 struct mbuf *m;
640 #ifdef ALTQ
641 /*
642 * XXX need to evaluate / requeue
643 */
644 if (ALTQ_IS_ENABLED(&ifp->if_snd)) {
645 IFQ_DRV_DEQUEUE(&ifp->if_snd, m);
646 return (m);
647 }
648 #endif
649 m = buf_ring_peek(br);
650 if (m == NULL || func(m, arg) == 0)
651 return (NULL);
652
653 return (buf_ring_dequeue_sc(br));
654 }
655
656 static __inline int
657 drbr_empty(struct ifnet *ifp, struct buf_ring *br)
658 {
659 #ifdef ALTQ
660 if (ALTQ_IS_ENABLED(&ifp->if_snd))
661 return (IFQ_DRV_IS_EMPTY(&ifp->if_snd));
662 #endif
663 return (buf_ring_empty(br));
664 }
665
666 static __inline int
667 drbr_inuse(struct ifnet *ifp, struct buf_ring *br)
668 {
669 #ifdef ALTQ
670 if (ALTQ_IS_ENABLED(&ifp->if_snd))
671 return (ifp->if_snd.ifq_len);
672 #endif
673 return (buf_ring_count(br));
674 }
675 #endif
676 /*
677 * 72 was chosen below because it is the size of a TCP/IP
678 * header (40) + the minimum mss (32).
679 */
680 #define IF_MINMTU 72
681 #define IF_MAXMTU 65535
682
683 #endif /* _KERNEL */
684
685 /*
686 * The ifaddr structure contains information about one address
687 * of an interface. They are maintained by the different address families,
688 * are allocated and attached when an address is set, and are linked
689 * together so all addresses for an interface can be located.
690 *
691 * NOTE: a 'struct ifaddr' is always at the beginning of a larger
692 * chunk of malloc'ed memory, where we store the three addresses
693 * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
694 */
695 struct ifaddr {
696 struct sockaddr *ifa_addr; /* address of interface */
697 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
698 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
699 struct sockaddr *ifa_netmask; /* used to determine subnet */
700 struct if_data if_data; /* not all members are meaningful */
701 struct ifnet *ifa_ifp; /* back-pointer to interface */
702 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */
703 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
704 (int, struct rtentry *, struct rt_addrinfo *);
705 u_short ifa_flags; /* mostly rt_flags for cloning */
706 u_int ifa_refcnt; /* references to this structure */
707 int ifa_metric; /* cost of going out this interface */
708 int (*ifa_claim_addr) /* check if an addr goes to this if */
709 (struct ifaddr *, struct sockaddr *);
710 struct mtx ifa_mtx;
711 };
712 #define IFA_ROUTE RTF_UP /* route installed */
713
714 /* for compatibility with other BSDs */
715 #define ifa_list ifa_link
716
717 #ifdef _KERNEL
718 #define IFA_LOCK(ifa) mtx_lock(&(ifa)->ifa_mtx)
719 #define IFA_UNLOCK(ifa) mtx_unlock(&(ifa)->ifa_mtx)
720
721 void ifa_free(struct ifaddr *ifa);
722 void ifa_init(struct ifaddr *ifa);
723 void ifa_ref(struct ifaddr *ifa);
724 #endif
725
726 /*
727 * The prefix structure contains information about one prefix
728 * of an interface. They are maintained by the different address families,
729 * are allocated and attached when a prefix or an address is set,
730 * and are linked together so all prefixes for an interface can be located.
731 */
732 struct ifprefix {
733 struct sockaddr *ifpr_prefix; /* prefix of interface */
734 struct ifnet *ifpr_ifp; /* back-pointer to interface */
735 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
736 u_char ifpr_plen; /* prefix length in bits */
737 u_char ifpr_type; /* protocol dependent prefix type */
738 };
739
740 /*
741 * Multicast address structure. This is analogous to the ifaddr
742 * structure except that it keeps track of multicast addresses.
743 */
744 struct ifmultiaddr {
745 TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
746 struct sockaddr *ifma_addr; /* address this membership is for */
747 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
748 struct ifnet *ifma_ifp; /* back-pointer to interface */
749 u_int ifma_refcount; /* reference count */
750 void *ifma_protospec; /* protocol-specific state, if any */
751 struct ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
752 };
753
754 #ifdef _KERNEL
755
756 extern struct rwlock ifnet_rwlock;
757 extern struct sx ifnet_sxlock;
758
759 #define IFNET_LOCK_INIT() do { \
760 rw_init_flags(&ifnet_rwlock, "ifnet_rw", RW_RECURSE); \
761 sx_init_flags(&ifnet_sxlock, "ifnet_sx", SX_RECURSE); \
762 } while(0)
763
764 #define IFNET_WLOCK() do { \
765 sx_xlock(&ifnet_sxlock); \
766 rw_wlock(&ifnet_rwlock); \
767 } while (0)
768
769 #define IFNET_WUNLOCK() do { \
770 rw_wunlock(&ifnet_rwlock); \
771 sx_xunlock(&ifnet_sxlock); \
772 } while (0)
773
774 /*
775 * To assert the ifnet lock, you must know not only whether it's for read or
776 * write, but also whether it was acquired with sleep support or not.
777 */
778 #define IFNET_RLOCK_ASSERT() sx_assert(&ifnet_sxlock, SA_SLOCKED)
779 #define IFNET_RLOCK_NOSLEEP_ASSERT() rw_assert(&ifnet_rwlock, RA_RLOCKED)
780 #define IFNET_WLOCK_ASSERT() do { \
781 sx_assert(&ifnet_sxlock, SA_XLOCKED); \
782 rw_assert(&ifnet_rwlock, RA_WLOCKED); \
783 } while (0)
784
785 #define IFNET_RLOCK() sx_slock(&ifnet_sxlock)
786 #define IFNET_RLOCK_NOSLEEP() rw_rlock(&ifnet_rwlock)
787 #define IFNET_RUNLOCK() sx_sunlock(&ifnet_sxlock)
788 #define IFNET_RUNLOCK_NOSLEEP() rw_runlock(&ifnet_rwlock)
789
790 /*
791 * Look up an ifnet given its index; the _ref variant also acquires a
792 * reference that must be freed using if_rele(). It is almost always a bug
793 * to call ifnet_byindex() instead if ifnet_byindex_ref().
794 */
795 struct ifnet *ifnet_byindex(u_short idx);
796 struct ifnet *ifnet_byindex_locked(u_short idx);
797 struct ifnet *ifnet_byindex_ref(u_short idx);
798
799 /*
800 * Given the index, ifaddr_byindex() returns the one and only
801 * link-level ifaddr for the interface. You are not supposed to use
802 * it to traverse the list of addresses associated to the interface.
803 */
804 struct ifaddr *ifaddr_byindex(u_short idx);
805
806 VNET_DECLARE(struct ifnethead, ifnet);
807 VNET_DECLARE(struct ifgrouphead, ifg_head);
808 VNET_DECLARE(int, if_index);
809 VNET_DECLARE(struct ifnet *, loif); /* first loopback interface */
810 VNET_DECLARE(int, useloopback);
811
812 #define V_ifnet VNET(ifnet)
813 #define V_ifg_head VNET(ifg_head)
814 #define V_if_index VNET(if_index)
815 #define V_loif VNET(loif)
816 #define V_useloopback VNET(useloopback)
817
818 extern int ifqmaxlen;
819
820 int if_addgroup(struct ifnet *, const char *);
821 int if_delgroup(struct ifnet *, const char *);
822 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
823 int if_allmulti(struct ifnet *, int);
824 struct ifnet* if_alloc(u_char);
825 void if_attach(struct ifnet *);
826 void if_dead(struct ifnet *);
827 int if_delmulti(struct ifnet *, struct sockaddr *);
828 void if_delmulti_ifma(struct ifmultiaddr *);
829 void if_detach(struct ifnet *);
830 void if_vmove(struct ifnet *, struct vnet *);
831 void if_purgeaddrs(struct ifnet *);
832 void if_purgemaddrs(struct ifnet *);
833 void if_down(struct ifnet *);
834 struct ifmultiaddr *
835 if_findmulti(struct ifnet *, struct sockaddr *);
836 void if_free(struct ifnet *);
837 void if_free_type(struct ifnet *, u_char);
838 void if_initname(struct ifnet *, const char *, int);
839 void if_link_state_change(struct ifnet *, int);
840 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
841 void if_qflush(struct ifnet *);
842 void if_ref(struct ifnet *);
843 void if_rele(struct ifnet *);
844 int if_setlladdr(struct ifnet *, const u_char *, int);
845 void if_up(struct ifnet *);
846 /*void ifinit(void);*/ /* declared in systm.h for main() */
847 int ifioctl(struct socket *, u_long, caddr_t, struct thread *);
848 int ifpromisc(struct ifnet *, int);
849 struct ifnet *ifunit(const char *);
850 struct ifnet *ifunit_ref(const char *);
851
852 void ifq_init(struct ifaltq *, struct ifnet *ifp);
853 void ifq_delete(struct ifaltq *);
854
855 int ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
856 int ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
857
858 struct ifaddr *ifa_ifwithaddr(struct sockaddr *);
859 int ifa_ifwithaddr_check(struct sockaddr *);
860 struct ifaddr *ifa_ifwithbroadaddr(struct sockaddr *);
861 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
862 struct ifaddr *ifa_ifwithnet(struct sockaddr *);
863 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
864 struct ifaddr *ifa_ifwithroute_fib(int, struct sockaddr *, struct sockaddr *, u_int);
865
866 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
867
868 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
869
870 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
871 typedef void if_com_free_t(void *com, u_char type);
872 void if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
873 void if_deregister_com_alloc(u_char type);
874
875 #define IF_LLADDR(ifp) \
876 LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr))
877
878 #ifdef DEVICE_POLLING
879 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS };
880
881 typedef int poll_handler_t(struct ifnet *ifp, enum poll_cmd cmd, int count);
882 int ether_poll_register(poll_handler_t *h, struct ifnet *ifp);
883 int ether_poll_deregister(struct ifnet *ifp);
884 #endif /* DEVICE_POLLING */
885
886 #endif /* _KERNEL */
887
888 #endif /* !_NET_IF_VAR_H_ */
Cache object: 7e5cd649dde2bbae8537969fc5a17a28
|