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$
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 #endif
73
74 #include <sys/queue.h> /* get TAILQ macros */
75
76 #ifdef _KERNEL
77 #include <sys/mbuf.h>
78 #include <sys/eventhandler.h>
79 #endif /* _KERNEL */
80 #include <sys/lock.h> /* XXX */
81 #include <sys/mutex.h> /* XXX */
82 #include <sys/event.h> /* XXX */
83 #include <sys/_task.h>
84
85 #define IF_DUNIT_NONE -1
86
87 #if 1 /* ALTQ */
88 #include <altq/if_altq.h>
89 #endif
90
91 TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */
92 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */
93 TAILQ_HEAD(ifprefixhead, ifprefix);
94 TAILQ_HEAD(ifmultihead, ifmultiaddr);
95
96 /*
97 * Structure defining a queue for a network interface.
98 */
99 struct ifqueue {
100 struct mbuf *ifq_head;
101 struct mbuf *ifq_tail;
102 int ifq_len;
103 int ifq_maxlen;
104 int ifq_drops;
105 struct mtx ifq_mtx;
106 };
107
108 /*
109 * Structure defining a network interface.
110 *
111 * (Would like to call this struct ``if'', but C isn't PL/1.)
112 */
113
114 /*
115 * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with
116 * one of these structures, typically held within an arpcom structure.
117 *
118 * struct <foo>_softc {
119 * struct arpcom {
120 * struct ifnet ac_if;
121 * ...
122 * } <arpcom> ;
123 * ...
124 * };
125 *
126 * The assumption is used in a number of places, including many
127 * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
128 *
129 * Unfortunately devices' softc are opaque, so we depend on this layout
130 * to locate the struct ifnet from the softc in the generic code.
131 *
132 */
133 struct ifnet {
134 void *if_softc; /* pointer to driver state */
135 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */
136 char if_xname[IFNAMSIZ]; /* external name (name + unit) */
137 const char *if_dname; /* driver name */
138 int if_dunit; /* unit or IF_DUNIT_NONE */
139 struct ifaddrhead if_addrhead; /* linked list of addresses per if */
140 /*
141 * if_addrhead is the list of all addresses associated to
142 * an interface.
143 * Some code in the kernel assumes that first element
144 * of the list has type AF_LINK, and contains sockaddr_dl
145 * addresses which store the link-level address and the name
146 * of the interface.
147 * However, access to the AF_LINK address through this
148 * field is deprecated. Use ifaddr_byindex() instead.
149 */
150 struct knlist if_klist; /* events attached to this if */
151 int if_pcount; /* number of promiscuous listeners */
152 struct carp_if *if_carp; /* carp interface structure */
153 struct bpf_if *if_bpf; /* packet filter structure */
154 u_short if_index; /* numeric abbreviation for this if */
155 short if_timer; /* time 'til if_watchdog called */
156 u_short if_nvlans; /* number of active vlans */
157 int if_flags; /* up/down, broadcast, etc. */
158 int if_capabilities; /* interface capabilities */
159 int if_capenable; /* enabled features */
160 void *if_linkmib; /* link-type-specific MIB data */
161 size_t if_linkmiblen; /* length of above data */
162 struct if_data if_data;
163 struct ifmultihead if_multiaddrs; /* multicast addresses configured */
164 int if_amcount; /* number of all-multicast requests */
165 /* procedure handles */
166 int (*if_output) /* output routine (enqueue) */
167 (struct ifnet *, struct mbuf *, struct sockaddr *,
168 struct rtentry *);
169 void (*if_input) /* input routine (from h/w driver) */
170 (struct ifnet *, struct mbuf *);
171 void (*if_start) /* initiate output routine */
172 (struct ifnet *);
173 int (*if_ioctl) /* ioctl routine */
174 (struct ifnet *, u_long, caddr_t);
175 void (*if_watchdog) /* timer routine */
176 (struct ifnet *);
177 void (*if_init) /* Init routine */
178 (void *);
179 int (*if_resolvemulti) /* validate/resolve multicast */
180 (struct ifnet *, struct sockaddr **, struct sockaddr *);
181 void *if_bridge; /* bridge glue */
182 void *if_spare2; /* spare pointer 2 */
183 void *if_spare3; /* spare pointer 3 */
184 u_int if_spare_flags1; /* spare flags 1 */
185 u_int if_spare_flags2; /* spare flags 2 */
186 #if 1 /* ALTQ */
187 struct ifaltq if_snd; /* output queue (includes altq) */
188 #else
189 struct ifqueue if_snd; /* output queue */
190 #endif
191 const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
192
193 struct lltable *lltables; /* list of L3-L2 resolution tables */
194
195 struct label *if_label; /* interface MAC label */
196
197 /* these are only used by IPv6 */
198 struct ifprefixhead if_prefixhead; /* list of prefixes per if */
199 void *if_afdata[AF_MAX];
200 int if_afdata_initialized;
201 struct mtx if_afdata_mtx;
202 struct task if_starttask; /* task for IFF_NEEDSGIANT */
203 };
204
205 typedef void if_init_f_t(void *);
206
207 /*
208 * XXX These aliases are terribly dangerous because they could apply
209 * to anything.
210 */
211 #define if_mtu if_data.ifi_mtu
212 #define if_type if_data.ifi_type
213 #define if_physical if_data.ifi_physical
214 #define if_addrlen if_data.ifi_addrlen
215 #define if_hdrlen if_data.ifi_hdrlen
216 #define if_metric if_data.ifi_metric
217 #define if_link_state if_data.ifi_link_state
218 #define if_baudrate if_data.ifi_baudrate
219 #define if_hwassist if_data.ifi_hwassist
220 #define if_ipackets if_data.ifi_ipackets
221 #define if_ierrors if_data.ifi_ierrors
222 #define if_opackets if_data.ifi_opackets
223 #define if_oerrors if_data.ifi_oerrors
224 #define if_collisions if_data.ifi_collisions
225 #define if_ibytes if_data.ifi_ibytes
226 #define if_obytes if_data.ifi_obytes
227 #define if_imcasts if_data.ifi_imcasts
228 #define if_omcasts if_data.ifi_omcasts
229 #define if_iqdrops if_data.ifi_iqdrops
230 #define if_noproto if_data.ifi_noproto
231 #define if_lastchange if_data.ifi_lastchange
232 #define if_recvquota if_data.ifi_recvquota
233 #define if_xmitquota if_data.ifi_xmitquota
234 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)NULL)
235
236 /* for compatibility with other BSDs */
237 #define if_addrlist if_addrhead
238 #define if_list if_link
239
240 /*
241 * Locks for address lists on the network interface. In FreeBSD 6 and
242 * later, the if_addr_mtx was added to struct ifnet. In order to
243 * maintain ABI compatibility with drivers compiled for earlier FreeBSD 5
244 * releases, we can't do that here. Instead, a global if_addr_mtx is
245 * shared for all link layer address lists. These macros still take a
246 * dummy "if" argument to maintain API compatibility with FreeBSD 6 and
247 * later.
248 */
249 extern struct mtx if_addr_mtx;
250 #define IF_ADDR_LOCK_INIT(if) mtx_init(&if_addr_mtx, \
251 "if_addr_mtx", NULL, MTX_DEF)
252 #define IF_ADDR_LOCK_DESTROY(if) mtx_destroy(&if_addr_mtx)
253 #define IF_ADDR_LOCK(if) mtx_lock(&if_addr_mtx)
254 #define IF_ADDR_UNLOCK(if) mtx_unlock(&if_addr_mtx)
255 #define IF_ADDR_LOCK_ASSERT(if) mtx_assert(&if_addr_mtx, MA_OWNED)
256
257 /*
258 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
259 * are queues of messages stored on ifqueue structures
260 * (defined above). Entries are added to and deleted from these structures
261 * by these macros, which should be called with ipl raised to splimp().
262 */
263 #define IF_LOCK(ifq) mtx_lock(&(ifq)->ifq_mtx)
264 #define IF_UNLOCK(ifq) mtx_unlock(&(ifq)->ifq_mtx)
265 #define IF_LOCK_ASSERT(ifq) mtx_assert(&(ifq)->ifq_mtx, MA_OWNED)
266 #define _IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
267 #define _IF_DROP(ifq) ((ifq)->ifq_drops++)
268 #define _IF_QLEN(ifq) ((ifq)->ifq_len)
269
270 #define _IF_ENQUEUE(ifq, m) do { \
271 (m)->m_nextpkt = NULL; \
272 if ((ifq)->ifq_tail == NULL) \
273 (ifq)->ifq_head = m; \
274 else \
275 (ifq)->ifq_tail->m_nextpkt = m; \
276 (ifq)->ifq_tail = m; \
277 (ifq)->ifq_len++; \
278 } while (0)
279
280 #define IF_ENQUEUE(ifq, m) do { \
281 IF_LOCK(ifq); \
282 _IF_ENQUEUE(ifq, m); \
283 IF_UNLOCK(ifq); \
284 } while (0)
285
286 #define _IF_PREPEND(ifq, m) do { \
287 (m)->m_nextpkt = (ifq)->ifq_head; \
288 if ((ifq)->ifq_tail == NULL) \
289 (ifq)->ifq_tail = (m); \
290 (ifq)->ifq_head = (m); \
291 (ifq)->ifq_len++; \
292 } while (0)
293
294 #define IF_PREPEND(ifq, m) do { \
295 IF_LOCK(ifq); \
296 _IF_PREPEND(ifq, m); \
297 IF_UNLOCK(ifq); \
298 } while (0)
299
300 #define _IF_DEQUEUE(ifq, m) do { \
301 (m) = (ifq)->ifq_head; \
302 if (m) { \
303 if (((ifq)->ifq_head = (m)->m_nextpkt) == NULL) \
304 (ifq)->ifq_tail = NULL; \
305 (m)->m_nextpkt = NULL; \
306 (ifq)->ifq_len--; \
307 } \
308 } while (0)
309
310 #define IF_DEQUEUE(ifq, m) do { \
311 IF_LOCK(ifq); \
312 _IF_DEQUEUE(ifq, m); \
313 IF_UNLOCK(ifq); \
314 } while (0)
315
316 #define _IF_POLL(ifq, m) ((m) = (ifq)->ifq_head)
317 #define IF_POLL(ifq, m) _IF_POLL(ifq, m)
318
319 #define _IF_DRAIN(ifq) do { \
320 struct mbuf *m; \
321 for (;;) { \
322 _IF_DEQUEUE(ifq, m); \
323 if (m == NULL) \
324 break; \
325 m_freem(m); \
326 } \
327 } while (0)
328
329 #define IF_DRAIN(ifq) do { \
330 IF_LOCK(ifq); \
331 _IF_DRAIN(ifq); \
332 IF_UNLOCK(ifq); \
333 } while(0)
334
335 #ifdef _KERNEL
336 /* interface address change event */
337 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
338 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
339 /* new interface arrival event */
340 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
341 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
342 /* interface departure event */
343 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
344 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
345
346 #define IF_AFDATA_LOCK_INIT(ifp) \
347 mtx_init(&(ifp)->if_afdata_mtx, "if_afdata", NULL, MTX_DEF)
348 #define IF_AFDATA_LOCK(ifp) mtx_lock(&(ifp)->if_afdata_mtx)
349 #define IF_AFDATA_TRYLOCK(ifp) mtx_trylock(&(ifp)->if_afdata_mtx)
350 #define IF_AFDATA_UNLOCK(ifp) mtx_unlock(&(ifp)->if_afdata_mtx)
351 #define IF_AFDATA_DESTROY(ifp) mtx_destroy(&(ifp)->if_afdata_mtx)
352
353 #define IFF_LOCKGIANT(ifp) do { \
354 if ((ifp)->if_flags & IFF_NEEDSGIANT) \
355 mtx_lock(&Giant); \
356 } while (0)
357
358 #define IFF_UNLOCKGIANT(ifp) do { \
359 if ((ifp)->if_flags & IFF_NEEDSGIANT) \
360 mtx_unlock(&Giant); \
361 } while (0)
362
363 int if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp,
364 int adjust);
365 #define IF_HANDOFF(ifq, m, ifp) \
366 if_handoff((struct ifqueue *)ifq, m, ifp, 0)
367 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj) \
368 if_handoff((struct ifqueue *)ifq, m, ifp, adj)
369
370 void if_start(struct ifnet *);
371
372 #if 1 /* ALTQ */
373 #define IFQ_ENQUEUE(ifq, m, err) \
374 do { \
375 IF_LOCK(ifq); \
376 if (ALTQ_IS_ENABLED(ifq)) \
377 ALTQ_ENQUEUE(ifq, m, NULL, err); \
378 else { \
379 if (_IF_QFULL(ifq)) { \
380 m_freem(m); \
381 (err) = ENOBUFS; \
382 } else { \
383 _IF_ENQUEUE(ifq, m); \
384 (err) = 0; \
385 } \
386 } \
387 if (err) \
388 (ifq)->ifq_drops++; \
389 IF_UNLOCK(ifq); \
390 } while (0)
391
392 #define IFQ_DEQUEUE_NOLOCK(ifq, m) \
393 do { \
394 if (TBR_IS_ENABLED(ifq)) \
395 (m) = tbr_dequeue_ptr(ifq, ALTDQ_REMOVE); \
396 else if (ALTQ_IS_ENABLED(ifq)) \
397 ALTQ_DEQUEUE(ifq, m); \
398 else \
399 _IF_DEQUEUE(ifq, m); \
400 } while (0)
401
402 #define IFQ_DEQUEUE(ifq, m) \
403 do { \
404 IF_LOCK(ifq); \
405 IFQ_DEQUEUE_NOLOCK(ifq, m); \
406 IF_UNLOCK(ifq); \
407 } while (0)
408
409 #define IFQ_POLL_NOLOCK(ifq, m) \
410 do { \
411 if (TBR_IS_ENABLED(ifq)) \
412 (m) = tbr_dequeue_ptr(ifq, ALTDQ_POLL); \
413 else if (ALTQ_IS_ENABLED(ifq)) \
414 ALTQ_POLL(ifq, m); \
415 else \
416 _IF_POLL(ifq, m); \
417 } while (0)
418
419 #define IFQ_POLL(ifq, m) \
420 do { \
421 IF_LOCK(ifq); \
422 IFQ_POLL_NOLOCK(ifq, m); \
423 IF_UNLOCK(ifq); \
424 } while (0)
425
426 #define IFQ_PURGE_NOLOCK(ifq) \
427 do { \
428 if (ALTQ_IS_ENABLED(ifq)) { \
429 ALTQ_PURGE(ifq); \
430 } else \
431 _IF_DRAIN(ifq); \
432 } while (0)
433
434 #define IFQ_PURGE(ifq) \
435 do { \
436 IF_LOCK(ifq); \
437 IFQ_PURGE_NOLOCK(ifq); \
438 IF_UNLOCK(ifq); \
439 } while (0)
440
441 #define IFQ_SET_READY(ifq) \
442 do { ((ifq)->altq_flags |= ALTQF_READY); } while (0)
443
444 #else /* !ALTQ */
445 #define IFQ_ENQUEUE(ifq, m, err) \
446 do { \
447 IF_LOCK(ifq); \
448 if (_IF_QFULL(ifq)) { \
449 m_freem(m); \
450 (err) = ENOBUFS; \
451 } else { \
452 _IF_ENQUEUE(ifq, m); \
453 (err) = 0; \
454 } \
455 if (err) \
456 (ifq)->ifq_drops++; \
457 IF_UNLOCK(ifq); \
458 } while (0)
459
460 #define IFQ_DEQUEUE_NOLOCK(ifq, m) _IF_DEQUEUE(ifq, m)
461 #define IFQ_DEQUEUE(ifq, m) IF_DEQUEUE(ifq, m)
462 #define IFQ_POLL_NOLOCK(ifq, m) _IF_POLL(ifq, m)
463 #define IFQ_POLL(ifq, m) IF_POLL(ifq, m)
464 #define IFQ_PURGE_NOLOCK(ifq) _IF_DRAIN(ifq)
465 #define IFQ_PURGE(ifq) IF_DRAIN(ifq)
466
467 #define IFQ_SET_READY(ifq) /* nothing */
468
469 #endif /* !ALTQ */
470
471 #define IFQ_LOCK(ifq) IF_LOCK(ifq)
472 #define IFQ_UNLOCK(ifq) IF_UNLOCK(ifq)
473 #define IFQ_LOCK_ASSERT(ifq) IF_LOCK_ASSERT(ifq)
474 #define IFQ_IS_EMPTY(ifq) ((ifq)->ifq_len == 0)
475 #define IFQ_INC_LEN(ifq) ((ifq)->ifq_len++)
476 #define IFQ_DEC_LEN(ifq) (--(ifq)->ifq_len)
477 #define IFQ_INC_DROPS(ifq) ((ifq)->ifq_drops++)
478 #define IFQ_SET_MAXLEN(ifq, len) ((ifq)->ifq_maxlen = (len))
479
480 #define IFQ_HANDOFF_ADJ(ifp, m, adj, err) \
481 do { \
482 int len; \
483 short mflags; \
484 \
485 len = (m)->m_pkthdr.len; \
486 mflags = (m)->m_flags; \
487 IFQ_ENQUEUE(&(ifp)->if_snd, m, err); \
488 if ((err) == 0) { \
489 (ifp)->if_obytes += len + (adj); \
490 if (mflags & M_MCAST) \
491 (ifp)->if_omcasts++; \
492 if (((ifp)->if_flags & IFF_OACTIVE) == 0) \
493 if_start(ifp); \
494 } \
495 } while (0)
496
497 #define IFQ_HANDOFF(ifp, m, err) \
498 IFQ_HANDOFF_ADJ(ifp, m, 0, err)
499
500 #define IFQ_DRV_DEQUEUE(ifq, m) \
501 do { \
502 (m) = (ifq)->ifq_drv_head; \
503 if (m) { \
504 if (((ifq)->ifq_drv_head = (m)->m_nextpkt) == NULL) \
505 (ifq)->ifq_drv_tail = NULL; \
506 (m)->m_nextpkt = NULL; \
507 (ifq)->ifq_drv_len--; \
508 } else { \
509 IFQ_LOCK(ifq); \
510 IFQ_DEQUEUE_NOLOCK(ifq, m); \
511 while ((ifq)->ifq_drv_len < (ifq)->ifq_drv_maxlen) { \
512 struct mbuf *m0; \
513 IFQ_DEQUEUE_NOLOCK(ifq, m0); \
514 if (m0 == NULL) \
515 break; \
516 m0->m_nextpkt = NULL; \
517 if ((ifq)->ifq_drv_tail == NULL) \
518 (ifq)->ifq_drv_head = m0; \
519 else \
520 (ifq)->ifq_drv_tail->m_nextpkt = m0; \
521 (ifq)->ifq_drv_tail = m0; \
522 (ifq)->ifq_drv_len++; \
523 } \
524 IFQ_UNLOCK(ifq); \
525 } \
526 } while (0)
527
528 #define IFQ_DRV_PREPEND(ifq, m) \
529 do { \
530 (m)->m_nextpkt = (ifq)->ifq_drv_head; \
531 if ((ifq)->ifq_drv_tail == NULL) \
532 (ifq)->ifq_drv_tail = (m); \
533 (ifq)->ifq_drv_head = (m); \
534 (ifq)->ifq_drv_len++; \
535 } while (0)
536
537 #define IFQ_DRV_IS_EMPTY(ifq) \
538 (((ifq)->ifq_drv_len == 0) && ((ifq)->ifq_len == 0))
539
540 #define IFQ_DRV_PURGE(ifq) \
541 do { \
542 struct mbuf *m, *n = (ifq)->ifq_drv_head; \
543 while((m = n) != NULL) { \
544 n = m->m_nextpkt; \
545 m_freem(m); \
546 } \
547 (ifq)->ifq_drv_head = (ifq)->ifq_drv_tail = NULL; \
548 (ifq)->ifq_drv_len = 0; \
549 IFQ_PURGE(ifq); \
550 } while (0)
551
552 /*
553 * 72 was chosen below because it is the size of a TCP/IP
554 * header (40) + the minimum mss (32).
555 */
556 #define IF_MINMTU 72
557 #define IF_MAXMTU 65535
558
559 #endif /* _KERNEL */
560
561 /*
562 * The ifaddr structure contains information about one address
563 * of an interface. They are maintained by the different address families,
564 * are allocated and attached when an address is set, and are linked
565 * together so all addresses for an interface can be located.
566 *
567 * NOTE: a 'struct ifaddr' is always at the beginning of a larger
568 * chunk of malloc'ed memory, where we store the three addresses
569 * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
570 */
571 struct ifaddr {
572 struct sockaddr *ifa_addr; /* address of interface */
573 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
574 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
575 struct sockaddr *ifa_netmask; /* used to determine subnet */
576 struct if_data if_data; /* not all members are meaningful */
577 struct ifnet *ifa_ifp; /* back-pointer to interface */
578 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */
579 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
580 (int, struct rtentry *, struct rt_addrinfo *);
581 u_short ifa_flags; /* mostly rt_flags for cloning */
582 u_int ifa_refcnt; /* references to this structure */
583 int ifa_metric; /* cost of going out this interface */
584 int (*ifa_claim_addr) /* check if an addr goes to this if */
585 (struct ifaddr *, struct sockaddr *);
586 struct mtx ifa_mtx;
587 };
588 #define IFA_ROUTE RTF_UP /* route installed */
589
590 /* for compatibility with other BSDs */
591 #define ifa_list ifa_link
592
593 #define IFA_LOCK_INIT(ifa) \
594 mtx_init(&(ifa)->ifa_mtx, "ifaddr", NULL, MTX_DEF)
595 #define IFA_LOCK(ifa) mtx_lock(&(ifa)->ifa_mtx)
596 #define IFA_UNLOCK(ifa) mtx_unlock(&(ifa)->ifa_mtx)
597 #define IFA_DESTROY(ifa) mtx_destroy(&(ifa)->ifa_mtx)
598
599 /*
600 * The prefix structure contains information about one prefix
601 * of an interface. They are maintained by the different address families,
602 * are allocated and attached when a prefix or an address is set,
603 * and are linked together so all prefixes for an interface can be located.
604 */
605 struct ifprefix {
606 struct sockaddr *ifpr_prefix; /* prefix of interface */
607 struct ifnet *ifpr_ifp; /* back-pointer to interface */
608 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
609 u_char ifpr_plen; /* prefix length in bits */
610 u_char ifpr_type; /* protocol dependent prefix type */
611 };
612
613 /*
614 * Multicast address structure. This is analogous to the ifaddr
615 * structure except that it keeps track of multicast addresses.
616 * Also, the reference count here is a count of requests for this
617 * address, not a count of pointers to this structure.
618 */
619 struct ifmultiaddr {
620 TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
621 struct sockaddr *ifma_addr; /* address this membership is for */
622 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
623 struct ifnet *ifma_ifp; /* back-pointer to interface */
624 u_int ifma_refcount; /* reference count */
625 void *ifma_protospec; /* protocol-specific state, if any */
626 };
627
628 #ifdef _KERNEL
629 #define IFAFREE(ifa) \
630 do { \
631 IFA_LOCK(ifa); \
632 KASSERT((ifa)->ifa_refcnt > 0, \
633 ("ifa %p !(ifa_refcnt > 0)", ifa)); \
634 if (--(ifa)->ifa_refcnt == 0) { \
635 IFA_DESTROY(ifa); \
636 free(ifa, M_IFADDR); \
637 } else \
638 IFA_UNLOCK(ifa); \
639 } while (0)
640
641 #define IFAREF(ifa) \
642 do { \
643 IFA_LOCK(ifa); \
644 ++(ifa)->ifa_refcnt; \
645 IFA_UNLOCK(ifa); \
646 } while (0)
647
648 extern struct mtx ifnet_lock;
649 #define IFNET_LOCK_INIT() \
650 mtx_init(&ifnet_lock, "ifnet", NULL, MTX_DEF | MTX_RECURSE)
651 #define IFNET_WLOCK() mtx_lock(&ifnet_lock)
652 #define IFNET_WUNLOCK() mtx_unlock(&ifnet_lock)
653 #define IFNET_RLOCK() IFNET_WLOCK()
654 #define IFNET_RUNLOCK() IFNET_WUNLOCK()
655
656 struct ifindex_entry {
657 struct ifnet *ife_ifnet;
658 struct ifaddr *ife_ifnet_addr;
659 struct cdev *ife_dev;
660 };
661
662 #define ifnet_byindex(idx) ifindex_table[(idx)].ife_ifnet
663 /*
664 * Given the index, ifaddr_byindex() returns the one and only
665 * link-level ifaddr for the interface. You are not supposed to use
666 * it to traverse the list of addresses associated to the interface.
667 */
668 #define ifaddr_byindex(idx) ifindex_table[(idx)].ife_ifnet_addr
669 #define ifdev_byindex(idx) ifindex_table[(idx)].ife_dev
670
671 extern struct ifnethead ifnet;
672 extern struct ifindex_entry *ifindex_table;
673 extern int ifqmaxlen;
674 extern struct ifnet *loif; /* first loopback interface */
675 extern int if_index;
676
677 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
678 int if_allmulti(struct ifnet *, int);
679 void if_attach(struct ifnet *);
680 int if_delmulti(struct ifnet *, struct sockaddr *);
681 void if_detach(struct ifnet *);
682 void if_down(struct ifnet *);
683 void if_initname(struct ifnet *, const char *, int);
684 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
685 int if_setlladdr(struct ifnet *, const u_char *, int);
686 void if_up(struct ifnet *);
687 /*void ifinit(void);*/ /* declared in systm.h for main() */
688 int ifioctl(struct socket *, u_long, caddr_t, struct thread *);
689 int ifpromisc(struct ifnet *, int);
690 struct ifnet *ifunit(const char *);
691
692 struct ifaddr *ifa_ifwithaddr(struct sockaddr *);
693 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
694 struct ifaddr *ifa_ifwithnet(struct sockaddr *);
695 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
696 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
697
698 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
699
700 #define IF_LLADDR(ifp) \
701 LLADDR((struct sockaddr_dl *) ifaddr_byindex((ifp)->if_index)->ifa_addr)
702
703 #ifdef DEVICE_POLLING
704 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER };
705
706 typedef void poll_handler_t(struct ifnet *ifp, enum poll_cmd cmd, int count);
707 int ether_poll_register(poll_handler_t *h, struct ifnet *ifp);
708 int ether_poll_deregister(struct ifnet *ifp);
709 #endif /* DEVICE_POLLING */
710
711 #endif /* _KERNEL */
712
713 #endif /* !_NET_IF_VAR_H_ */
Cache object: b3745f6dbf43a20aa3b29bf5e0dc1537
|