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: releng/9.1/sys/net/if_var.h 231157 2012-02-07 19:55:58Z 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 char *if_description; /* interface description */
199 u_int if_fib; /* interface FIB */
200 u_char if_alloctype; /* if_type at time of allocation */
201
202 /*
203 * Spare fields are added so that we can modify sensitive data
204 * structures without changing the kernel binary interface, and must
205 * be used with care where binary compatibility is required.
206 */
207 char if_cspare[3];
208 int if_ispare[4];
209 void *if_pspare[8]; /* 1 netmap, 7 TDB */
210 };
211
212 typedef void if_init_f_t(void *);
213
214 /*
215 * XXX These aliases are terribly dangerous because they could apply
216 * to anything.
217 */
218 #define if_mtu if_data.ifi_mtu
219 #define if_type if_data.ifi_type
220 #define if_physical if_data.ifi_physical
221 #define if_addrlen if_data.ifi_addrlen
222 #define if_hdrlen if_data.ifi_hdrlen
223 #define if_metric if_data.ifi_metric
224 #define if_link_state if_data.ifi_link_state
225 #define if_baudrate if_data.ifi_baudrate
226 #define if_hwassist if_data.ifi_hwassist
227 #define if_ipackets if_data.ifi_ipackets
228 #define if_ierrors if_data.ifi_ierrors
229 #define if_opackets if_data.ifi_opackets
230 #define if_oerrors if_data.ifi_oerrors
231 #define if_collisions if_data.ifi_collisions
232 #define if_ibytes if_data.ifi_ibytes
233 #define if_obytes if_data.ifi_obytes
234 #define if_imcasts if_data.ifi_imcasts
235 #define if_omcasts if_data.ifi_omcasts
236 #define if_iqdrops if_data.ifi_iqdrops
237 #define if_noproto if_data.ifi_noproto
238 #define if_lastchange if_data.ifi_lastchange
239
240 /* for compatibility with other BSDs */
241 #define if_addrlist if_addrhead
242 #define if_list if_link
243 #define if_name(ifp) ((ifp)->if_xname)
244
245 /*
246 * Locks for address lists on the network interface.
247 */
248 #define IF_ADDR_LOCK_INIT(if) mtx_init(&(if)->if_addr_mtx, \
249 "if_addr_mtx", NULL, MTX_DEF)
250 #define IF_ADDR_LOCK_DESTROY(if) mtx_destroy(&(if)->if_addr_mtx)
251 #define IF_ADDR_WLOCK(if) mtx_lock(&(if)->if_addr_mtx)
252 #define IF_ADDR_WUNLOCK(if) mtx_unlock(&(if)->if_addr_mtx)
253 #define IF_ADDR_RLOCK(if) mtx_lock(&(if)->if_addr_mtx)
254 #define IF_ADDR_RUNLOCK(if) mtx_unlock(&(if)->if_addr_mtx)
255 #define IF_ADDR_LOCK_ASSERT(if) mtx_assert(&(if)->if_addr_mtx, MA_OWNED)
256 #define IF_ADDR_WLOCK_ASSERT(if) mtx_assert(&(if)->if_addr_mtx, MA_OWNED)
257 /* XXX: Compat. */
258 #define IF_ADDR_LOCK(if) IF_ADDR_WLOCK(if)
259 #define IF_ADDR_UNLOCK(if) IF_ADDR_WUNLOCK(if)
260
261 /*
262 * Function variations on locking macros intended to be used by loadable
263 * kernel modules in order to divorce them from the internals of address list
264 * locking.
265 */
266 void if_addr_rlock(struct ifnet *ifp); /* if_addrhead */
267 void if_addr_runlock(struct ifnet *ifp); /* if_addrhead */
268 void if_maddr_rlock(struct ifnet *ifp); /* if_multiaddrs */
269 void if_maddr_runlock(struct ifnet *ifp); /* if_multiaddrs */
270
271 /*
272 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
273 * are queues of messages stored on ifqueue structures
274 * (defined above). Entries are added to and deleted from these structures
275 * by these macros, which should be called with ipl raised to splimp().
276 */
277 #define IF_LOCK(ifq) mtx_lock(&(ifq)->ifq_mtx)
278 #define IF_UNLOCK(ifq) mtx_unlock(&(ifq)->ifq_mtx)
279 #define IF_LOCK_ASSERT(ifq) mtx_assert(&(ifq)->ifq_mtx, MA_OWNED)
280 #define _IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
281 #define _IF_DROP(ifq) ((ifq)->ifq_drops++)
282 #define _IF_QLEN(ifq) ((ifq)->ifq_len)
283
284 #define _IF_ENQUEUE(ifq, m) do { \
285 (m)->m_nextpkt = NULL; \
286 if ((ifq)->ifq_tail == NULL) \
287 (ifq)->ifq_head = m; \
288 else \
289 (ifq)->ifq_tail->m_nextpkt = m; \
290 (ifq)->ifq_tail = m; \
291 (ifq)->ifq_len++; \
292 } while (0)
293
294 #define IF_ENQUEUE(ifq, m) do { \
295 IF_LOCK(ifq); \
296 _IF_ENQUEUE(ifq, m); \
297 IF_UNLOCK(ifq); \
298 } while (0)
299
300 #define _IF_PREPEND(ifq, m) do { \
301 (m)->m_nextpkt = (ifq)->ifq_head; \
302 if ((ifq)->ifq_tail == NULL) \
303 (ifq)->ifq_tail = (m); \
304 (ifq)->ifq_head = (m); \
305 (ifq)->ifq_len++; \
306 } while (0)
307
308 #define IF_PREPEND(ifq, m) do { \
309 IF_LOCK(ifq); \
310 _IF_PREPEND(ifq, m); \
311 IF_UNLOCK(ifq); \
312 } while (0)
313
314 #define _IF_DEQUEUE(ifq, m) do { \
315 (m) = (ifq)->ifq_head; \
316 if (m) { \
317 if (((ifq)->ifq_head = (m)->m_nextpkt) == NULL) \
318 (ifq)->ifq_tail = NULL; \
319 (m)->m_nextpkt = NULL; \
320 (ifq)->ifq_len--; \
321 } \
322 } while (0)
323
324 #define IF_DEQUEUE(ifq, m) do { \
325 IF_LOCK(ifq); \
326 _IF_DEQUEUE(ifq, m); \
327 IF_UNLOCK(ifq); \
328 } while (0)
329
330 #define _IF_DEQUEUE_ALL(ifq, m) do { \
331 (m) = (ifq)->ifq_head; \
332 (ifq)->ifq_head = (ifq)->ifq_tail = NULL; \
333 (ifq)->ifq_len = 0; \
334 } while (0)
335
336 #define IF_DEQUEUE_ALL(ifq, m) do { \
337 IF_LOCK(ifq); \
338 _IF_DEQUEUE_ALL(ifq, m); \
339 IF_UNLOCK(ifq); \
340 } while (0)
341
342 #define _IF_POLL(ifq, m) ((m) = (ifq)->ifq_head)
343 #define IF_POLL(ifq, m) _IF_POLL(ifq, m)
344
345 #define _IF_DRAIN(ifq) do { \
346 struct mbuf *m; \
347 for (;;) { \
348 _IF_DEQUEUE(ifq, m); \
349 if (m == NULL) \
350 break; \
351 m_freem(m); \
352 } \
353 } while (0)
354
355 #define IF_DRAIN(ifq) do { \
356 IF_LOCK(ifq); \
357 _IF_DRAIN(ifq); \
358 IF_UNLOCK(ifq); \
359 } while(0)
360
361 #ifdef _KERNEL
362 /* interface link layer address change event */
363 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
364 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
365 /* interface address change event */
366 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
367 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
368 /* new interface arrival event */
369 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
370 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
371 /* interface departure event */
372 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
373 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
374 /* Interface link state change event */
375 typedef void (*ifnet_link_event_handler_t)(void *, struct ifnet *, int);
376 EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t);
377
378 /*
379 * interface groups
380 */
381 struct ifg_group {
382 char ifg_group[IFNAMSIZ];
383 u_int ifg_refcnt;
384 void *ifg_pf_kif;
385 TAILQ_HEAD(, ifg_member) ifg_members;
386 TAILQ_ENTRY(ifg_group) ifg_next;
387 };
388
389 struct ifg_member {
390 TAILQ_ENTRY(ifg_member) ifgm_next;
391 struct ifnet *ifgm_ifp;
392 };
393
394 struct ifg_list {
395 struct ifg_group *ifgl_group;
396 TAILQ_ENTRY(ifg_list) ifgl_next;
397 };
398
399 /* group attach event */
400 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
401 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
402 /* group detach event */
403 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
404 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
405 /* group change event */
406 typedef void (*group_change_event_handler_t)(void *, const char *);
407 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
408
409 #define IF_AFDATA_LOCK_INIT(ifp) \
410 rw_init(&(ifp)->if_afdata_lock, "if_afdata")
411
412 #define IF_AFDATA_WLOCK(ifp) rw_wlock(&(ifp)->if_afdata_lock)
413 #define IF_AFDATA_RLOCK(ifp) rw_rlock(&(ifp)->if_afdata_lock)
414 #define IF_AFDATA_WUNLOCK(ifp) rw_wunlock(&(ifp)->if_afdata_lock)
415 #define IF_AFDATA_RUNLOCK(ifp) rw_runlock(&(ifp)->if_afdata_lock)
416 #define IF_AFDATA_LOCK(ifp) IF_AFDATA_WLOCK(ifp)
417 #define IF_AFDATA_UNLOCK(ifp) IF_AFDATA_WUNLOCK(ifp)
418 #define IF_AFDATA_TRYLOCK(ifp) rw_try_wlock(&(ifp)->if_afdata_lock)
419 #define IF_AFDATA_DESTROY(ifp) rw_destroy(&(ifp)->if_afdata_lock)
420
421 #define IF_AFDATA_LOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_LOCKED)
422 #define IF_AFDATA_UNLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_UNLOCKED)
423
424 int if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp,
425 int adjust);
426 #define IF_HANDOFF(ifq, m, ifp) \
427 if_handoff((struct ifqueue *)ifq, m, ifp, 0)
428 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj) \
429 if_handoff((struct ifqueue *)ifq, m, ifp, adj)
430
431 void if_start(struct ifnet *);
432
433 #define IFQ_ENQUEUE(ifq, m, err) \
434 do { \
435 IF_LOCK(ifq); \
436 if (ALTQ_IS_ENABLED(ifq)) \
437 ALTQ_ENQUEUE(ifq, m, NULL, err); \
438 else { \
439 if (_IF_QFULL(ifq)) { \
440 m_freem(m); \
441 (err) = ENOBUFS; \
442 } else { \
443 _IF_ENQUEUE(ifq, m); \
444 (err) = 0; \
445 } \
446 } \
447 if (err) \
448 (ifq)->ifq_drops++; \
449 IF_UNLOCK(ifq); \
450 } while (0)
451
452 #define IFQ_DEQUEUE_NOLOCK(ifq, m) \
453 do { \
454 if (TBR_IS_ENABLED(ifq)) \
455 (m) = tbr_dequeue_ptr(ifq, ALTDQ_REMOVE); \
456 else if (ALTQ_IS_ENABLED(ifq)) \
457 ALTQ_DEQUEUE(ifq, m); \
458 else \
459 _IF_DEQUEUE(ifq, m); \
460 } while (0)
461
462 #define IFQ_DEQUEUE(ifq, m) \
463 do { \
464 IF_LOCK(ifq); \
465 IFQ_DEQUEUE_NOLOCK(ifq, m); \
466 IF_UNLOCK(ifq); \
467 } while (0)
468
469 #define IFQ_POLL_NOLOCK(ifq, m) \
470 do { \
471 if (TBR_IS_ENABLED(ifq)) \
472 (m) = tbr_dequeue_ptr(ifq, ALTDQ_POLL); \
473 else if (ALTQ_IS_ENABLED(ifq)) \
474 ALTQ_POLL(ifq, m); \
475 else \
476 _IF_POLL(ifq, m); \
477 } while (0)
478
479 #define IFQ_POLL(ifq, m) \
480 do { \
481 IF_LOCK(ifq); \
482 IFQ_POLL_NOLOCK(ifq, m); \
483 IF_UNLOCK(ifq); \
484 } while (0)
485
486 #define IFQ_PURGE_NOLOCK(ifq) \
487 do { \
488 if (ALTQ_IS_ENABLED(ifq)) { \
489 ALTQ_PURGE(ifq); \
490 } else \
491 _IF_DRAIN(ifq); \
492 } while (0)
493
494 #define IFQ_PURGE(ifq) \
495 do { \
496 IF_LOCK(ifq); \
497 IFQ_PURGE_NOLOCK(ifq); \
498 IF_UNLOCK(ifq); \
499 } while (0)
500
501 #define IFQ_SET_READY(ifq) \
502 do { ((ifq)->altq_flags |= ALTQF_READY); } while (0)
503
504 #define IFQ_LOCK(ifq) IF_LOCK(ifq)
505 #define IFQ_UNLOCK(ifq) IF_UNLOCK(ifq)
506 #define IFQ_LOCK_ASSERT(ifq) IF_LOCK_ASSERT(ifq)
507 #define IFQ_IS_EMPTY(ifq) ((ifq)->ifq_len == 0)
508 #define IFQ_INC_LEN(ifq) ((ifq)->ifq_len++)
509 #define IFQ_DEC_LEN(ifq) (--(ifq)->ifq_len)
510 #define IFQ_INC_DROPS(ifq) ((ifq)->ifq_drops++)
511 #define IFQ_SET_MAXLEN(ifq, len) ((ifq)->ifq_maxlen = (len))
512
513 /*
514 * The IFF_DRV_OACTIVE test should really occur in the device driver, not in
515 * the handoff logic, as that flag is locked by the device driver.
516 */
517 #define IFQ_HANDOFF_ADJ(ifp, m, adj, err) \
518 do { \
519 int len; \
520 short mflags; \
521 \
522 len = (m)->m_pkthdr.len; \
523 mflags = (m)->m_flags; \
524 IFQ_ENQUEUE(&(ifp)->if_snd, m, err); \
525 if ((err) == 0) { \
526 (ifp)->if_obytes += len + (adj); \
527 if (mflags & M_MCAST) \
528 (ifp)->if_omcasts++; \
529 if (((ifp)->if_drv_flags & IFF_DRV_OACTIVE) == 0) \
530 if_start(ifp); \
531 } \
532 } while (0)
533
534 #define IFQ_HANDOFF(ifp, m, err) \
535 IFQ_HANDOFF_ADJ(ifp, m, 0, err)
536
537 #define IFQ_DRV_DEQUEUE(ifq, m) \
538 do { \
539 (m) = (ifq)->ifq_drv_head; \
540 if (m) { \
541 if (((ifq)->ifq_drv_head = (m)->m_nextpkt) == NULL) \
542 (ifq)->ifq_drv_tail = NULL; \
543 (m)->m_nextpkt = NULL; \
544 (ifq)->ifq_drv_len--; \
545 } else { \
546 IFQ_LOCK(ifq); \
547 IFQ_DEQUEUE_NOLOCK(ifq, m); \
548 while ((ifq)->ifq_drv_len < (ifq)->ifq_drv_maxlen) { \
549 struct mbuf *m0; \
550 IFQ_DEQUEUE_NOLOCK(ifq, m0); \
551 if (m0 == NULL) \
552 break; \
553 m0->m_nextpkt = NULL; \
554 if ((ifq)->ifq_drv_tail == NULL) \
555 (ifq)->ifq_drv_head = m0; \
556 else \
557 (ifq)->ifq_drv_tail->m_nextpkt = m0; \
558 (ifq)->ifq_drv_tail = m0; \
559 (ifq)->ifq_drv_len++; \
560 } \
561 IFQ_UNLOCK(ifq); \
562 } \
563 } while (0)
564
565 #define IFQ_DRV_PREPEND(ifq, m) \
566 do { \
567 (m)->m_nextpkt = (ifq)->ifq_drv_head; \
568 if ((ifq)->ifq_drv_tail == NULL) \
569 (ifq)->ifq_drv_tail = (m); \
570 (ifq)->ifq_drv_head = (m); \
571 (ifq)->ifq_drv_len++; \
572 } while (0)
573
574 #define IFQ_DRV_IS_EMPTY(ifq) \
575 (((ifq)->ifq_drv_len == 0) && ((ifq)->ifq_len == 0))
576
577 #define IFQ_DRV_PURGE(ifq) \
578 do { \
579 struct mbuf *m, *n = (ifq)->ifq_drv_head; \
580 while((m = n) != NULL) { \
581 n = m->m_nextpkt; \
582 m_freem(m); \
583 } \
584 (ifq)->ifq_drv_head = (ifq)->ifq_drv_tail = NULL; \
585 (ifq)->ifq_drv_len = 0; \
586 IFQ_PURGE(ifq); \
587 } while (0)
588
589 #ifdef _KERNEL
590 static __inline void
591 drbr_stats_update(struct ifnet *ifp, int len, int mflags)
592 {
593 #ifndef NO_SLOW_STATS
594 ifp->if_obytes += len;
595 if (mflags & M_MCAST)
596 ifp->if_omcasts++;
597 #endif
598 }
599
600 static __inline int
601 drbr_enqueue(struct ifnet *ifp, struct buf_ring *br, struct mbuf *m)
602 {
603 int error = 0;
604 int len = m->m_pkthdr.len;
605 int mflags = m->m_flags;
606
607 #ifdef ALTQ
608 if (ALTQ_IS_ENABLED(&ifp->if_snd)) {
609 IFQ_ENQUEUE(&ifp->if_snd, m, error);
610 return (error);
611 }
612 #endif
613 if ((error = buf_ring_enqueue_bytes(br, m, len)) == ENOBUFS) {
614 br->br_drops++;
615 m_freem(m);
616 } else
617 drbr_stats_update(ifp, len, mflags);
618
619 return (error);
620 }
621
622 static __inline void
623 drbr_flush(struct ifnet *ifp, struct buf_ring *br)
624 {
625 struct mbuf *m;
626
627 #ifdef ALTQ
628 if (ifp != NULL && ALTQ_IS_ENABLED(&ifp->if_snd))
629 IFQ_PURGE(&ifp->if_snd);
630 #endif
631 while ((m = buf_ring_dequeue_sc(br)) != NULL)
632 m_freem(m);
633 }
634
635 static __inline void
636 drbr_free(struct buf_ring *br, struct malloc_type *type)
637 {
638
639 drbr_flush(NULL, br);
640 buf_ring_free(br, type);
641 }
642
643 static __inline struct mbuf *
644 drbr_dequeue(struct ifnet *ifp, struct buf_ring *br)
645 {
646 #ifdef ALTQ
647 struct mbuf *m;
648
649 if (ALTQ_IS_ENABLED(&ifp->if_snd)) {
650 IFQ_DEQUEUE(&ifp->if_snd, m);
651 return (m);
652 }
653 #endif
654 return (buf_ring_dequeue_sc(br));
655 }
656
657 static __inline struct mbuf *
658 drbr_dequeue_cond(struct ifnet *ifp, struct buf_ring *br,
659 int (*func) (struct mbuf *, void *), void *arg)
660 {
661 struct mbuf *m;
662 #ifdef ALTQ
663 if (ALTQ_IS_ENABLED(&ifp->if_snd)) {
664 IFQ_LOCK(&ifp->if_snd);
665 IFQ_POLL_NOLOCK(&ifp->if_snd, m);
666 if (m != NULL && func(m, arg) == 0) {
667 IFQ_UNLOCK(&ifp->if_snd);
668 return (NULL);
669 }
670 IFQ_DEQUEUE_NOLOCK(&ifp->if_snd, m);
671 IFQ_UNLOCK(&ifp->if_snd);
672 return (m);
673 }
674 #endif
675 m = buf_ring_peek(br);
676 if (m == NULL || func(m, arg) == 0)
677 return (NULL);
678
679 return (buf_ring_dequeue_sc(br));
680 }
681
682 static __inline int
683 drbr_empty(struct ifnet *ifp, struct buf_ring *br)
684 {
685 #ifdef ALTQ
686 if (ALTQ_IS_ENABLED(&ifp->if_snd))
687 return (IFQ_IS_EMPTY(&ifp->if_snd));
688 #endif
689 return (buf_ring_empty(br));
690 }
691
692 static __inline int
693 drbr_needs_enqueue(struct ifnet *ifp, struct buf_ring *br)
694 {
695 #ifdef ALTQ
696 if (ALTQ_IS_ENABLED(&ifp->if_snd))
697 return (1);
698 #endif
699 return (!buf_ring_empty(br));
700 }
701
702 static __inline int
703 drbr_inuse(struct ifnet *ifp, struct buf_ring *br)
704 {
705 #ifdef ALTQ
706 if (ALTQ_IS_ENABLED(&ifp->if_snd))
707 return (ifp->if_snd.ifq_len);
708 #endif
709 return (buf_ring_count(br));
710 }
711 #endif
712 /*
713 * 72 was chosen below because it is the size of a TCP/IP
714 * header (40) + the minimum mss (32).
715 */
716 #define IF_MINMTU 72
717 #define IF_MAXMTU 65535
718
719 #endif /* _KERNEL */
720
721 /*
722 * The ifaddr structure contains information about one address
723 * of an interface. They are maintained by the different address families,
724 * are allocated and attached when an address is set, and are linked
725 * together so all addresses for an interface can be located.
726 *
727 * NOTE: a 'struct ifaddr' is always at the beginning of a larger
728 * chunk of malloc'ed memory, where we store the three addresses
729 * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
730 */
731 struct ifaddr {
732 struct sockaddr *ifa_addr; /* address of interface */
733 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
734 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
735 struct sockaddr *ifa_netmask; /* used to determine subnet */
736 struct if_data if_data; /* not all members are meaningful */
737 struct ifnet *ifa_ifp; /* back-pointer to interface */
738 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */
739 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
740 (int, struct rtentry *, struct rt_addrinfo *);
741 u_short ifa_flags; /* mostly rt_flags for cloning */
742 u_int ifa_refcnt; /* references to this structure */
743 int ifa_metric; /* cost of going out this interface */
744 int (*ifa_claim_addr) /* check if an addr goes to this if */
745 (struct ifaddr *, struct sockaddr *);
746 struct mtx ifa_mtx;
747 };
748 #define IFA_ROUTE RTF_UP /* route installed */
749 #define IFA_RTSELF RTF_HOST /* loopback route to self installed */
750
751 /* for compatibility with other BSDs */
752 #define ifa_list ifa_link
753
754 #ifdef _KERNEL
755 #define IFA_LOCK(ifa) mtx_lock(&(ifa)->ifa_mtx)
756 #define IFA_UNLOCK(ifa) mtx_unlock(&(ifa)->ifa_mtx)
757
758 void ifa_free(struct ifaddr *ifa);
759 void ifa_init(struct ifaddr *ifa);
760 void ifa_ref(struct ifaddr *ifa);
761 #endif
762
763 /*
764 * The prefix structure contains information about one prefix
765 * of an interface. They are maintained by the different address families,
766 * are allocated and attached when a prefix or an address is set,
767 * and are linked together so all prefixes for an interface can be located.
768 */
769 struct ifprefix {
770 struct sockaddr *ifpr_prefix; /* prefix of interface */
771 struct ifnet *ifpr_ifp; /* back-pointer to interface */
772 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
773 u_char ifpr_plen; /* prefix length in bits */
774 u_char ifpr_type; /* protocol dependent prefix type */
775 };
776
777 /*
778 * Multicast address structure. This is analogous to the ifaddr
779 * structure except that it keeps track of multicast addresses.
780 */
781 struct ifmultiaddr {
782 TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
783 struct sockaddr *ifma_addr; /* address this membership is for */
784 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
785 struct ifnet *ifma_ifp; /* back-pointer to interface */
786 u_int ifma_refcount; /* reference count */
787 void *ifma_protospec; /* protocol-specific state, if any */
788 struct ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
789 };
790
791 #ifdef _KERNEL
792
793 extern struct rwlock ifnet_rwlock;
794 extern struct sx ifnet_sxlock;
795
796 #define IFNET_LOCK_INIT() do { \
797 rw_init_flags(&ifnet_rwlock, "ifnet_rw", RW_RECURSE); \
798 sx_init_flags(&ifnet_sxlock, "ifnet_sx", SX_RECURSE); \
799 } while(0)
800
801 #define IFNET_WLOCK() do { \
802 sx_xlock(&ifnet_sxlock); \
803 rw_wlock(&ifnet_rwlock); \
804 } while (0)
805
806 #define IFNET_WUNLOCK() do { \
807 rw_wunlock(&ifnet_rwlock); \
808 sx_xunlock(&ifnet_sxlock); \
809 } while (0)
810
811 /*
812 * To assert the ifnet lock, you must know not only whether it's for read or
813 * write, but also whether it was acquired with sleep support or not.
814 */
815 #define IFNET_RLOCK_ASSERT() sx_assert(&ifnet_sxlock, SA_SLOCKED)
816 #define IFNET_RLOCK_NOSLEEP_ASSERT() rw_assert(&ifnet_rwlock, RA_RLOCKED)
817 #define IFNET_WLOCK_ASSERT() do { \
818 sx_assert(&ifnet_sxlock, SA_XLOCKED); \
819 rw_assert(&ifnet_rwlock, RA_WLOCKED); \
820 } while (0)
821
822 #define IFNET_RLOCK() sx_slock(&ifnet_sxlock)
823 #define IFNET_RLOCK_NOSLEEP() rw_rlock(&ifnet_rwlock)
824 #define IFNET_RUNLOCK() sx_sunlock(&ifnet_sxlock)
825 #define IFNET_RUNLOCK_NOSLEEP() rw_runlock(&ifnet_rwlock)
826
827 /*
828 * Look up an ifnet given its index; the _ref variant also acquires a
829 * reference that must be freed using if_rele(). It is almost always a bug
830 * to call ifnet_byindex() instead if ifnet_byindex_ref().
831 */
832 struct ifnet *ifnet_byindex(u_short idx);
833 struct ifnet *ifnet_byindex_locked(u_short idx);
834 struct ifnet *ifnet_byindex_ref(u_short idx);
835
836 /*
837 * Given the index, ifaddr_byindex() returns the one and only
838 * link-level ifaddr for the interface. You are not supposed to use
839 * it to traverse the list of addresses associated to the interface.
840 */
841 struct ifaddr *ifaddr_byindex(u_short idx);
842
843 VNET_DECLARE(struct ifnethead, ifnet);
844 VNET_DECLARE(struct ifgrouphead, ifg_head);
845 VNET_DECLARE(int, if_index);
846 VNET_DECLARE(struct ifnet *, loif); /* first loopback interface */
847 VNET_DECLARE(int, useloopback);
848
849 #define V_ifnet VNET(ifnet)
850 #define V_ifg_head VNET(ifg_head)
851 #define V_if_index VNET(if_index)
852 #define V_loif VNET(loif)
853 #define V_useloopback VNET(useloopback)
854
855 extern int ifqmaxlen;
856
857 int if_addgroup(struct ifnet *, const char *);
858 int if_delgroup(struct ifnet *, const char *);
859 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
860 int if_allmulti(struct ifnet *, int);
861 struct ifnet* if_alloc(u_char);
862 void if_attach(struct ifnet *);
863 void if_dead(struct ifnet *);
864 int if_delmulti(struct ifnet *, struct sockaddr *);
865 void if_delmulti_ifma(struct ifmultiaddr *);
866 void if_detach(struct ifnet *);
867 void if_vmove(struct ifnet *, struct vnet *);
868 void if_purgeaddrs(struct ifnet *);
869 void if_delallmulti(struct ifnet *);
870 void if_down(struct ifnet *);
871 struct ifmultiaddr *
872 if_findmulti(struct ifnet *, struct sockaddr *);
873 void if_free(struct ifnet *);
874 void if_free_type(struct ifnet *, u_char);
875 void if_initname(struct ifnet *, const char *, int);
876 void if_link_state_change(struct ifnet *, int);
877 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
878 void if_qflush(struct ifnet *);
879 void if_ref(struct ifnet *);
880 void if_rele(struct ifnet *);
881 int if_setlladdr(struct ifnet *, const u_char *, int);
882 void if_up(struct ifnet *);
883 int ifioctl(struct socket *, u_long, caddr_t, struct thread *);
884 int ifpromisc(struct ifnet *, int);
885 struct ifnet *ifunit(const char *);
886 struct ifnet *ifunit_ref(const char *);
887
888 void ifq_init(struct ifaltq *, struct ifnet *ifp);
889 void ifq_delete(struct ifaltq *);
890
891 int ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
892 int ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
893
894 struct ifaddr *ifa_ifwithaddr(struct sockaddr *);
895 int ifa_ifwithaddr_check(struct sockaddr *);
896 struct ifaddr *ifa_ifwithbroadaddr(struct sockaddr *);
897 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
898 struct ifaddr *ifa_ifwithnet(struct sockaddr *, int);
899 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
900 struct ifaddr *ifa_ifwithroute_fib(int, struct sockaddr *, struct sockaddr *, u_int);
901
902 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
903
904 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
905
906 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
907 typedef void if_com_free_t(void *com, u_char type);
908 void if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
909 void if_deregister_com_alloc(u_char type);
910
911 #define IF_LLADDR(ifp) \
912 LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr))
913
914 #ifdef DEVICE_POLLING
915 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS };
916
917 typedef int poll_handler_t(struct ifnet *ifp, enum poll_cmd cmd, int count);
918 int ether_poll_register(poll_handler_t *h, struct ifnet *ifp);
919 int ether_poll_deregister(struct ifnet *ifp);
920 #endif /* DEVICE_POLLING */
921
922 #endif /* _KERNEL */
923
924 #endif /* !_NET_IF_VAR_H_ */
Cache object: d0d0a53adac600212216bb8f040bcf1d
|