nataraid(4): Add devstat support.
[dragonfly.git] / sys / net / if_var.h
CommitLineData
984263bc
MD
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: src/sys/net/if_var.h,v 1.18.2.16 2003/04/15 18:11:19 fjoe Exp $
b9ed4403 35 * $DragonFly: src/sys/net/if_var.h,v 1.71 2008/11/22 04:00:53 sephe Exp $
984263bc
MD
36 */
37
38#ifndef _NET_IF_VAR_H_
39#define _NET_IF_VAR_H_
40
78195a76
MD
41#ifndef _SYS_SERIALIZE_H_
42#include <sys/serialize.h>
43#endif
1bd40720
MD
44#ifndef _NET_IF_H_
45#include <net/if.h>
46#endif
9683f229
MD
47#ifndef _SYS_MUTEX_H_
48#include <sys/mutex.h>
49#endif
78195a76 50
984263bc
MD
51/*
52 * Structures defining a network interface, providing a packet
53 * transport mechanism (ala level 0 of the PUP protocols).
54 *
55 * Each interface accepts output datagrams of a specified maximum
56 * length, and provides higher level routines with input datagrams
57 * received from its medium.
58 *
78195a76
MD
59 * Output occurs when the routine if_output is called, with four parameters:
60 * ifp->if_output(ifp, m, dst, rt)
984263bc
MD
61 * Here m is the mbuf chain to be sent and dst is the destination address.
62 * The output routine encapsulates the supplied datagram if necessary,
63 * and then transmits it on its medium.
64 *
65 * On input, each interface unwraps the data received by it, and either
66 * places it on the input queue of a internetwork datagram routine
3013ac0e
JS
67 * and posts the associated software interrupt, or passes the datagram to
68 * the routine if_input. It is called with the mbuf chain as parameter:
78195a76 69 * ifp->if_input(ifp, m)
3013ac0e 70 * The input routine removes the protocol dependent header if necessary.
984263bc
MD
71 *
72 * Routines exist for locating interfaces by their addresses
73 * or for locating a interface on a certain network, as well as more general
74 * routing and gateway routines maintaining information used to locate
75 * interfaces. These routines live in the files if.c and route.c
76 */
77
984263bc
MD
78/*
79 * Forward structure declarations for function prototypes [sic].
80 */
81struct mbuf;
68b67450 82struct mbuf_chain;
984263bc
MD
83struct proc;
84struct rtentry;
85struct rt_addrinfo;
86struct socket;
87struct ether_header;
bd4539cc 88struct ucred;
78195a76 89struct lwkt_serialize;
b2632176
SZ
90struct ifaddr_container;
91struct ifaddr;
92struct lwkt_port;
fb908635 93struct lwkt_msg;
002c1265 94union netmsg;
2eb0d069 95struct pktinfo;
b3a7093f 96struct ifpoll_info;
984263bc
MD
97
98#include <sys/queue.h> /* get TAILQ macros */
99
4d723e5a
JS
100#include <net/altq/if_altq.h>
101
984263bc 102#ifdef _KERNEL
f2bd8b67 103#include <sys/eventhandler.h>
984263bc
MD
104#include <sys/mbuf.h>
105#include <sys/systm.h> /* XXX */
4986965b 106#include <sys/thread2.h>
984263bc
MD
107#endif /* _KERNEL */
108
1550dfd9
MD
109#define IF_DUNIT_NONE -1
110
984263bc 111TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */
b2632176 112TAILQ_HEAD(ifaddrhead, ifaddr_container); /* instantiation is preserved in the list */
984263bc 113TAILQ_HEAD(ifprefixhead, ifprefix);
441d34b2 114TAILQ_HEAD(ifmultihead, ifmultiaddr);
984263bc
MD
115
116/*
117 * Structure defining a queue for a network interface.
118 */
119struct ifqueue {
120 struct mbuf *ifq_head;
121 struct mbuf *ifq_tail;
122 int ifq_len;
123 int ifq_maxlen;
124 int ifq_drops;
125};
126
2b71c8f1
SZ
127/*
128 * Note of DEVICE_POLLING
129 * 1) Any file(*.c) that depends on DEVICE_POLLING supports in this
130 * file should include opt_polling.h at its beginning.
131 * 2) When struct changes, which are conditioned by DEVICE_POLLING,
132 * are to be introduced, please keep the struct's size and layout
133 * same, no matter whether DEVICE_POLLING is defined or not.
134 * See ifnet.if_poll and ifnet.if_poll_unused for example.
135 */
136
9c095379
MD
137#ifdef DEVICE_POLLING
138enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER,
139 POLL_REGISTER };
140#endif
141
a3dd34d2
SZ
142enum ifnet_serialize {
143 IFNET_SERIALIZE_ALL,
aabfe6fb 144 IFNET_SERIALIZE_MAIN,
a3dd34d2
SZ
145 IFNET_SERIALIZE_TX_BASE = 0x10000000,
146 IFNET_SERIALIZE_RX_BASE = 0x20000000
147};
148#define IFNET_SERIALIZE_TX IFNET_SERIALIZE_TX_BASE
067b3d6b 149#define IFNET_SERIALIZE_RX(i) (IFNET_SERIALIZE_RX_BASE + (i))
a3dd34d2 150
1afbcbac
MD
151#if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
152
984263bc
MD
153/*
154 * Structure defining a network interface.
155 *
156 * (Would like to call this struct ``if'', but C isn't PL/1.)
157 */
158
159/*
160 * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with
161 * one of these structures, typically held within an arpcom structure.
162 *
163 * struct <foo>_softc {
164 * struct arpcom {
165 * struct ifnet ac_if;
166 * ...
167 * } <arpcom> ;
168 * ...
169 * };
170 *
171 * The assumption is used in a number of places, including many
172 * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
173 *
174 * Unfortunately devices' softc are opaque, so we depend on this layout
175 * to locate the struct ifnet from the softc in the generic code.
176 *
78195a76
MD
177 * MPSAFE NOTES:
178 *
a3dd34d2
SZ
179 * ifnet is protected by calling if_serialize, if_tryserialize and
180 * if_deserialize serialize functions with the ifnet_serialize parameter.
181 * ifnet.if_snd is protected by its own spinlock. Callers of if_ioctl,
182 * if_watchdog, if_init, if_resolvemulti, and if_poll should call the
183 * ifnet serialize functions with IFNET_SERIALIZE_ALL. Callers of if_start
184 * sould call the ifnet serialize functions with IFNET_SERIALIZE_TX.
185 *
186 * FIXME: Device drivers usually use the same serializer for their interrupt
187 * FIXME: but this is not required.
188 *
189 * Caller of if_output must not serialize ifnet by calling ifnet serialize
190 * functions; if_output will call the ifnet serialize functions based on
bb16d5d2
SZ
191 * its own needs. Caller of if_input does not necessarily hold the related
192 * serializer.
78195a76
MD
193 *
194 * If a device driver installs the same serializer for its interrupt
195 * as for ifnet, then the driver only really needs to worry about further
196 * serialization in timeout based entry points. All other entry points
197 * will already be serialized. Older ISA drivers still using the old
198 * interrupt infrastructure will have to obtain and release the serializer
199 * in their interrupt routine themselves.
984263bc
MD
200 */
201struct ifnet {
202 void *if_softc; /* pointer to driver state */
30809119 203 void *if_l2com; /* pointer to protocol bits */
f23061d4 204 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */
1550dfd9 205 char if_xname[IFNAMSIZ]; /* external name (name + unit) */
3e4a09e7
MD
206 const char *if_dname; /* driver name */
207 int if_dunit; /* unit or IF_DUNIT_NONE */
9433ab01 208 void *if_vlantrunks; /* vlan trunks */
e71d70c2 209 struct ifaddrhead *if_addrheads; /* array[NCPU] of TAILQs of addresses per if */
984263bc 210 int if_pcount; /* number of promiscuous listeners */
5bd4422e 211 void *if_carp; /* carp interfaces */
984263bc
MD
212 struct bpf_if *if_bpf; /* packet filter structure */
213 u_short if_index; /* numeric abbreviation for this if */
984263bc 214 short if_timer; /* time 'til if_watchdog called */
3e4a09e7 215 int if_flags; /* up/down, broadcast, etc. */
34b4b6a2
JS
216 int if_capabilities; /* interface capabilities */
217 int if_capenable; /* enabled features */
984263bc
MD
218 void *if_linkmib; /* link-type-specific MIB data */
219 size_t if_linkmiblen; /* length of above data */
220 struct if_data if_data;
221 struct ifmultihead if_multiaddrs; /* multicast addresses configured */
222 int if_amcount; /* number of all-multicast requests */
223/* procedure handles */
224 int (*if_output) /* output routine (enqueue) */
225 (struct ifnet *, struct mbuf *, struct sockaddr *,
226 struct rtentry *);
3013ac0e
JS
227 void (*if_input) /* input routine from hardware driver */
228 (struct ifnet *, struct mbuf *);
984263bc
MD
229 void (*if_start) /* initiate output routine */
230 (struct ifnet *);
984263bc 231 int (*if_ioctl) /* ioctl routine */
bd4539cc 232 (struct ifnet *, u_long, caddr_t, struct ucred *);
984263bc
MD
233 void (*if_watchdog) /* timer routine */
234 (struct ifnet *);
984263bc
MD
235 void (*if_init) /* Init routine */
236 (void *);
237 int (*if_resolvemulti) /* validate/resolve multicast */
238 (struct ifnet *, struct sockaddr **, struct sockaddr *);
9db4b353
SZ
239 int (*if_start_cpuid) /* cpuid to run if_start */
240 (struct ifnet *);
70224baa 241 TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
9c095379
MD
242#ifdef DEVICE_POLLING
243 void (*if_poll) /* IFF_POLLING support */
244 (struct ifnet *, enum poll_cmd, int);
1630efc5 245 int if_poll_cpuid;
9c095379 246#else
1630efc5
SZ
247 /* Place holders */
248 void (*if_poll_unused)(void);
249 int if_poll_cpuid_used;
9c095379 250#endif
a3dd34d2
SZ
251 void (*if_serialize)
252 (struct ifnet *, enum ifnet_serialize);
253 void (*if_deserialize)
254 (struct ifnet *, enum ifnet_serialize);
255 int (*if_tryserialize)
256 (struct ifnet *, enum ifnet_serialize);
2c9effcf
SZ
257#ifdef INVARIANTS
258 void (*if_serialize_assert)
259 (struct ifnet *, enum ifnet_serialize, boolean_t);
260#else
b3a7093f 261 /* Place holders */
2c9effcf 262 void (*if_serialize_unused)(void);
b3a7093f
SZ
263#endif
264#ifdef IFPOLL_ENABLE
265 void (*if_qpoll)
266 (struct ifnet *, struct ifpoll_info *);
267#else
268 /* Place holders */
269 void (*if_qpoll_unused)(void);
2c9effcf 270#endif
4d723e5a 271 struct ifaltq if_snd; /* output queue (includes altq) */
984263bc 272 struct ifprefixhead if_prefixhead; /* list of prefixes per if */
c401f0fd 273 const uint8_t *if_broadcastaddr;
db37145f 274 void *if_bridge; /* bridge glue */
698ac46c 275 void *if_afdata[AF_MAX];
141697b6 276 struct ifaddr *if_lladdr;
78195a76
MD
277 struct lwkt_serialize *if_serializer; /* serializer or MP lock */
278 struct lwkt_serialize if_default_serializer; /* if not supplied */
9683f229 279 struct mtx if_ioctl_mtx; /* high-level ioctl serializing mutex */
9db4b353 280 int if_cpuid;
002c1265 281 struct netmsg_base *if_start_nmsg; /* percpu msgs to sched if_start */
70224baa 282 void *if_pf_kif; /* pf interface abstraction */
315a7da3
JL
283 union {
284 void *carp_s; /* carp structure (used by !carp ifs) */
285 struct ifnet *carp_d; /* ptr to carpdev (used by carp ifs) */
286 } if_carp_ptr;
287 #define if_carp if_carp_ptr.carp_s
288 #define if_carpdev if_carp_ptr.carp_d
984263bc
MD
289};
290typedef void if_init_f_t (void *);
291
984263bc
MD
292#define if_mtu if_data.ifi_mtu
293#define if_type if_data.ifi_type
294#define if_physical if_data.ifi_physical
295#define if_addrlen if_data.ifi_addrlen
296#define if_hdrlen if_data.ifi_hdrlen
297#define if_metric if_data.ifi_metric
6de83abe 298#define if_link_state if_data.ifi_link_state
984263bc
MD
299#define if_baudrate if_data.ifi_baudrate
300#define if_hwassist if_data.ifi_hwassist
301#define if_ipackets if_data.ifi_ipackets
302#define if_ierrors if_data.ifi_ierrors
303#define if_opackets if_data.ifi_opackets
304#define if_oerrors if_data.ifi_oerrors
305#define if_collisions if_data.ifi_collisions
306#define if_ibytes if_data.ifi_ibytes
307#define if_obytes if_data.ifi_obytes
308#define if_imcasts if_data.ifi_imcasts
309#define if_omcasts if_data.ifi_omcasts
310#define if_iqdrops if_data.ifi_iqdrops
311#define if_noproto if_data.ifi_noproto
312#define if_lastchange if_data.ifi_lastchange
313#define if_recvquota if_data.ifi_recvquota
314#define if_xmitquota if_data.ifi_xmitquota
60233e58 315#define if_rawoutput(if, m, sa) if_output(if, m, sa, NULL)
984263bc
MD
316
317/* for compatibility with other BSDs */
984263bc
MD
318#define if_list if_link
319
1afbcbac 320#endif
b2632176 321
984263bc
MD
322/*
323 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
324 * are queues of messages stored on ifqueue structures
325 * (defined above). Entries are added to and deleted from these structures
326 * by these macros, which should be called with ipl raised to splimp().
327 */
328#define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
329#define IF_DROP(ifq) ((ifq)->ifq_drops++)
8e22f1e8 330#define IF_QLEN(ifq) ((ifq)->ifq_len)
fd81ccf9 331#define IF_QEMPTY(ifq) (IF_QLEN(ifq) == 0)
1afbcbac 332
501ade14
HT
333#define IF_ENQUEUE(ifq, m) do { \
334 (m)->m_nextpkt = 0; \
335 if ((ifq)->ifq_tail == 0) \
336 (ifq)->ifq_head = m; \
337 else \
338 (ifq)->ifq_tail->m_nextpkt = m; \
339 (ifq)->ifq_tail = m; \
340 (ifq)->ifq_len++; \
341} while (0)
1afbcbac 342
501ade14
HT
343#define IF_PREPEND(ifq, m) do { \
344 (m)->m_nextpkt = (ifq)->ifq_head; \
345 if ((ifq)->ifq_tail == 0) \
346 (ifq)->ifq_tail = (m); \
347 (ifq)->ifq_head = (m); \
348 (ifq)->ifq_len++; \
349} while (0)
1afbcbac 350
501ade14
HT
351#define IF_DEQUEUE(ifq, m) do { \
352 (m) = (ifq)->ifq_head; \
353 if (m) { \
354 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
355 (ifq)->ifq_tail = 0; \
356 (m)->m_nextpkt = 0; \
357 (ifq)->ifq_len--; \
358 } \
359} while (0)
8e22f1e8
JS
360
361#define IF_POLL(ifq, m) ((m) = (ifq)->ifq_head)
362
8bde602d
JH
363#define IF_DRAIN(ifq) do { \
364 struct mbuf *m; \
365 while (1) { \
366 IF_DEQUEUE(ifq, m); \
367 if (m == NULL) \
368 break; \
369 m_freem(m); \
370 } \
371} while (0)
984263bc
MD
372
373#ifdef _KERNEL
374
19f10c78
RP
375/* interface link layer address change event */
376typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
377EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
378
2c9effcf
SZ
379#ifdef INVARIANTS
380#define ASSERT_IFNET_SERIALIZED_ALL(ifp) \
381 (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, TRUE)
382#define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp) \
383 (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, FALSE)
384
385#define ASSERT_IFNET_SERIALIZED_TX(ifp) \
386 (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_TX, TRUE)
387#define ASSERT_IFNET_NOT_SERIALIZED_TX(ifp) \
388 (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_TX, FALSE)
aabfe6fb
SZ
389
390#define ASSERT_IFNET_SERIALIZED_MAIN(ifp) \
391 (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_MAIN, TRUE)
392#define ASSERT_IFNET_NOT_SERIALIZED_MAIN(ifp) \
393 (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_MAIN, FALSE)
2c9effcf
SZ
394#else
395#define ASSERT_IFNET_SERIALIZED_ALL(ifp) ((void)0)
396#define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp) ((void)0)
397#define ASSERT_IFNET_SERIALIZED_TX(ifp) ((void)0)
398#define ASSERT_IFNET_NOT_SERIALIZED_TX(ifp) ((void)0)
aabfe6fb
SZ
399#define ASSERT_IFNET_SERIALIZED_MAIN(ifp) ((void)0)
400#define ASSERT_IFNET_NOT_SERIALIZED_MAIN(ifp) ((void)0)
2c9effcf
SZ
401#endif
402
a3dd34d2
SZ
403static __inline void
404ifnet_serialize_all(struct ifnet *_ifp)
405{
406 _ifp->if_serialize(_ifp, IFNET_SERIALIZE_ALL);
407}
408
409static __inline void
410ifnet_deserialize_all(struct ifnet *_ifp)
411{
412 _ifp->if_deserialize(_ifp, IFNET_SERIALIZE_ALL);
413}
414
415static __inline int
416ifnet_tryserialize_all(struct ifnet *_ifp)
417{
418 return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_ALL);
419}
420
421static __inline void
422ifnet_serialize_tx(struct ifnet *_ifp)
423{
424 _ifp->if_serialize(_ifp, IFNET_SERIALIZE_TX);
425}
426
427static __inline void
428ifnet_deserialize_tx(struct ifnet *_ifp)
429{
430 _ifp->if_deserialize(_ifp, IFNET_SERIALIZE_TX);
431}
432
433static __inline int
434ifnet_tryserialize_tx(struct ifnet *_ifp)
435{
436 return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_TX);
437}
438
aabfe6fb
SZ
439static __inline void
440ifnet_serialize_main(struct ifnet *_ifp)
441{
442 _ifp->if_serialize(_ifp, IFNET_SERIALIZE_MAIN);
443}
444
445static __inline void
446ifnet_deserialize_main(struct ifnet *_ifp)
447{
448 _ifp->if_deserialize(_ifp, IFNET_SERIALIZE_MAIN);
449}
450
451static __inline int
452ifnet_tryserialize_main(struct ifnet *_ifp)
453{
454 return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_MAIN);
455}
456
78195a76
MD
457/*
458 * DEPRECATED - should not be used by any new driver. This code uses the
459 * old queueing interface and if_start ABI and does not use the ifp's
460 * serializer.
461 */
984263bc
MD
462#define IF_HANDOFF(ifq, m, ifp) if_handoff(ifq, m, ifp, 0)
463#define IF_HANDOFF_ADJ(ifq, m, ifp, adj) if_handoff(ifq, m, ifp, adj)
464
465static __inline int
f5703be1
JS
466if_handoff(struct ifqueue *_ifq, struct mbuf *_m, struct ifnet *_ifp,
467 int _adjust)
984263bc 468{
235f6526 469 int _need_if_start = 0;
4986965b
JS
470
471 crit_enter();
472
235f6526
JS
473 if (IF_QFULL(_ifq)) {
474 IF_DROP(_ifq);
4986965b 475 crit_exit();
235f6526 476 m_freem(_m);
984263bc
MD
477 return (0);
478 }
235f6526
JS
479 if (_ifp != NULL) {
480 _ifp->if_obytes += _m->m_pkthdr.len + _adjust;
481 if (_m->m_flags & M_MCAST)
482 _ifp->if_omcasts++;
483 _need_if_start = !(_ifp->if_flags & IFF_OACTIVE);
984263bc 484 }
235f6526 485 IF_ENQUEUE(_ifq, _m);
78195a76 486 if (_need_if_start) {
235f6526 487 (*_ifp->if_start)(_ifp);
78195a76 488 }
4986965b 489 crit_exit();
984263bc
MD
490 return (1);
491}
492
493/*
494 * 72 was chosen below because it is the size of a TCP/IP
495 * header (40) + the minimum mss (32).
496 */
497#define IF_MINMTU 72
498#define IF_MAXMTU 65535
499
500#endif /* _KERNEL */
501
1b562c24
SZ
502struct in_ifaddr;
503
504struct in_ifaddr_container {
505 struct in_ifaddr *ia;
506 LIST_ENTRY(in_ifaddr_container) ia_hash;
507 /* entry in bucket of inet addresses */
508 TAILQ_ENTRY(in_ifaddr_container) ia_link;
509 /* list of internet addresses */
510 struct ifaddr_container *ia_ifac; /* parent ifaddr_container */
511};
512
b2632176
SZ
513struct ifaddr_container {
514#define IFA_CONTAINER_MAGIC 0x19810219
515#define IFA_CONTAINER_DEAD 0xc0dedead
516 uint32_t ifa_magic; /* IFA_CONTAINER_MAGIC */
517 struct ifaddr *ifa;
518 TAILQ_ENTRY(ifaddr_container) ifa_link; /* queue macro glue */
519 u_int ifa_refcnt; /* references to this structure */
5bd4422e
SZ
520 uint16_t ifa_listmask; /* IFA_LIST_ */
521 uint16_t ifa_prflags; /* protocol specific flags */
1b562c24
SZ
522
523 /*
524 * Protocol specific states
525 */
526 union {
527 struct in_ifaddr_container u_in_ifac;
528 } ifa_proto_u;
b2632176
SZ
529};
530
5bd4422e
SZ
531#define IFA_LIST_IFADDRHEAD 0x01 /* on ifnet.if_addrheads[cpuid] */
532#define IFA_LIST_IN_IFADDRHEAD 0x02 /* on in_ifaddrheads[cpuid] */
533#define IFA_LIST_IN_IFADDRHASH 0x04 /* on in_ifaddrhashtbls[cpuid] */
534
535#define IFA_PRF_FLAG0 0x01
536#define IFA_PRF_FLAG1 0x02
537#define IFA_PRF_FLAG2 0x04
538#define IFA_PRF_FLAG3 0x08
40f667f2 539
984263bc
MD
540/*
541 * The ifaddr structure contains information about one address
542 * of an interface. They are maintained by the different address families,
543 * are allocated and attached when an address is set, and are linked
544 * together so all addresses for an interface can be located.
545 */
546struct ifaddr {
547 struct sockaddr *ifa_addr; /* address of interface */
548 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
549#define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
550 struct sockaddr *ifa_netmask; /* used to determine subnet */
551 struct if_data if_data; /* not all members are meaningful */
552 struct ifnet *ifa_ifp; /* back-pointer to interface */
b2632176
SZ
553 void *ifa_link_pad;
554 struct ifaddr_container *ifa_containers;
984263bc
MD
555 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
556 (int, struct rtentry *, struct rt_addrinfo *);
557 u_short ifa_flags; /* mostly rt_flags for cloning */
d5a2b87c 558 int ifa_ncnt; /* # of valid ifaddr_container */
984263bc
MD
559 int ifa_metric; /* cost of going out this interface */
560#ifdef notdef
561 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */
562#endif
563 int (*ifa_claim_addr) /* check if an addr goes to this if */
564 (struct ifaddr *, struct sockaddr *);
565
566};
567#define IFA_ROUTE RTF_UP /* route installed */
568
569/* for compatibility with other BSDs */
570#define ifa_list ifa_link
571
572/*
573 * The prefix structure contains information about one prefix
574 * of an interface. They are maintained by the different address families,
575 * are allocated and attached when an prefix or an address is set,
576 * and are linked together so all prefixes for an interface can be located.
577 */
578struct ifprefix {
579 struct sockaddr *ifpr_prefix; /* prefix of interface */
580 struct ifnet *ifpr_ifp; /* back-pointer to interface */
581 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
582 u_char ifpr_plen; /* prefix length in bits */
583 u_char ifpr_type; /* protocol dependent prefix type */
584};
585
586/*
587 * Multicast address structure. This is analogous to the ifaddr
588 * structure except that it keeps track of multicast addresses.
589 * Also, the reference count here is a count of requests for this
590 * address, not a count of pointers to this structure.
591 */
592struct ifmultiaddr {
441d34b2 593 TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
f23061d4 594 struct sockaddr *ifma_addr; /* address this membership is for */
984263bc
MD
595 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
596 struct ifnet *ifma_ifp; /* back-pointer to interface */
597 u_int ifma_refcount; /* reference count */
598 void *ifma_protospec; /* protocol-specific state, if any */
599};
600
601#ifdef _KERNEL
5bd4422e
SZ
602
603enum ifaddr_event {
604 IFADDR_EVENT_ADD,
605 IFADDR_EVENT_DELETE,
606 IFADDR_EVENT_CHANGE
607};
608
f2bd8b67 609/* interface address change event */
5bd4422e
SZ
610typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *,
611 enum ifaddr_event, struct ifaddr *);
f2bd8b67
JS
612EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
613/* new interface attach event */
614typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *);
615EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t);
616/* interface detach event */
617typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *);
618EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t);
f2bd8b67 619
70224baa
JL
620/*
621 * interface groups
622 */
623struct ifg_group {
624 char ifg_group[IFNAMSIZ];
625 u_int ifg_refcnt;
626 void *ifg_pf_kif;
315a7da3 627 int ifg_carp_demoted;
70224baa
JL
628 TAILQ_HEAD(, ifg_member) ifg_members;
629 TAILQ_ENTRY(ifg_group) ifg_next;
630};
631
632struct ifg_member {
633 TAILQ_ENTRY(ifg_member) ifgm_next;
634 struct ifnet *ifgm_ifp;
635};
636
637struct ifg_list {
638 struct ifg_group *ifgl_group;
639 TAILQ_ENTRY(ifg_list) ifgl_next;
640};
641
642/* group attach event */
643typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
644EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
645/* group detach event */
646typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
647EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
648/* group change event */
649typedef void (*group_change_event_handler_t)(void *, const char *);
650EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
651
652
09ff6081
SZ
653#ifdef INVARIANTS
654#define ASSERT_IFAC_VALID(ifac) do { \
655 KKASSERT((ifac)->ifa_magic == IFA_CONTAINER_MAGIC); \
656 KKASSERT((ifac)->ifa_refcnt > 0); \
657} while (0)
658#else
659#define ASSERT_IFAC_VALID(ifac) ((void)0)
660#endif
661
b2632176
SZ
662static __inline void
663_IFAREF(struct ifaddr *_ifa, int _cpu_id)
664{
665 struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
666
667 crit_enter();
09ff6081 668 ASSERT_IFAC_VALID(_ifac);
b2632176
SZ
669 ++_ifac->ifa_refcnt;
670 crit_exit();
671}
672
f23061d4 673static __inline void
235f6526 674IFAREF(struct ifaddr *_ifa)
f23061d4 675{
b2632176 676 _IFAREF(_ifa, mycpuid);
f23061d4
JH
677}
678
679#include <sys/malloc.h>
680
681MALLOC_DECLARE(M_IFADDR);
682MALLOC_DECLARE(M_IFMADDR);
cb80735c 683MALLOC_DECLARE(M_IFNET);
f23061d4 684
b2632176
SZ
685void ifac_free(struct ifaddr_container *, int);
686
687static __inline void
688_IFAFREE(struct ifaddr *_ifa, int _cpu_id)
689{
690 struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
691
692 crit_enter();
09ff6081 693 ASSERT_IFAC_VALID(_ifac);
b2632176
SZ
694 if (--_ifac->ifa_refcnt == 0)
695 ifac_free(_ifac, _cpu_id);
696 crit_exit();
697}
698
f23061d4 699static __inline void
235f6526 700IFAFREE(struct ifaddr *_ifa)
f23061d4 701{
b2632176 702 _IFAFREE(_ifa, mycpuid);
f23061d4 703}
984263bc 704
d7944f0b 705struct lwkt_port *ifnet_portfn(int);
2a3e1dbd 706int ifnet_domsg(struct lwkt_msg *, int);
8967ddc7 707void ifnet_sendmsg(struct lwkt_msg *, int);
c4882b7e 708void ifnet_forwardmsg(struct lwkt_msg *, int);
bd08b792 709struct ifnet *ifnet_byindex(unsigned short);
d7944f0b 710
2a3e1dbd 711static __inline int
c4882b7e
SZ
712ifa_domsg(struct lwkt_msg *_lmsg, int _cpu)
713{
2a3e1dbd 714 return ifnet_domsg(_lmsg, _cpu);
c4882b7e
SZ
715}
716
8967ddc7
SZ
717static __inline void
718ifa_sendmsg(struct lwkt_msg *_lmsg, int _cpu)
719{
720 ifnet_sendmsg(_lmsg, _cpu);
721}
722
c4882b7e
SZ
723static __inline void
724ifa_forwardmsg(struct lwkt_msg *_lmsg, int _nextcpu)
d7944f0b 725{
c4882b7e 726 ifnet_forwardmsg(_lmsg, _nextcpu);
d7944f0b
SZ
727}
728
4ee4f753
MD
729#define REINPUT_KEEPRCVIF 0x0001 /* ether_reinput_oncpu() */
730#define REINPUT_RUNBPF 0x0002 /* ether_reinput_oncpu() */
731
732
984263bc
MD
733extern struct ifnethead ifnet;
734extern struct ifnet **ifindex2ifnet;
735extern int ifqmaxlen;
736extern struct ifnet loif[];
737extern int if_index;
984263bc 738
78195a76
MD
739void ether_ifattach(struct ifnet *, uint8_t *, struct lwkt_serialize *);
740void ether_ifattach_bpf(struct ifnet *, uint8_t *, u_int, u_int,
741 struct lwkt_serialize *);
0a8b5977 742void ether_ifdetach(struct ifnet *);
48242f47 743void ether_demux(struct mbuf *);
297c8124 744void ether_demux_oncpu(struct ifnet *, struct mbuf *);
b9ed4403 745void ether_reinput_oncpu(struct ifnet *, struct mbuf *, int);
2eb0d069
SZ
746void ether_input_chain(struct ifnet *, struct mbuf *,
747 const struct pktinfo *, struct mbuf_chain *);
57ccf5a2 748void ether_input_chain_init(struct mbuf_chain *);
68b67450 749void ether_input_dispatch(struct mbuf_chain *);
984263bc 750int ether_output_frame(struct ifnet *, struct mbuf *);
fecfec53 751int ether_ioctl(struct ifnet *, u_long, caddr_t);
70d9a675 752struct ifnet *ether_bridge_interface(struct ifnet *ifp);
d6018c31
JS
753uint32_t ether_crc32_le(const uint8_t *, size_t);
754uint32_t ether_crc32_be(const uint8_t *, size_t);
984263bc
MD
755
756int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
757int if_allmulti(struct ifnet *, int);
78195a76 758void if_attach(struct ifnet *, struct lwkt_serialize *);
984263bc 759int if_delmulti(struct ifnet *, struct sockaddr *);
3976c93a 760void if_delallmulti(struct ifnet *ifp);
c727e142 761void if_purgeaddrs_nolink(struct ifnet *);
984263bc
MD
762void if_detach(struct ifnet *);
763void if_down(struct ifnet *);
6de83abe 764void if_link_state_change(struct ifnet *);
1550dfd9 765void if_initname(struct ifnet *, const char *, int);
e9bd1548 766int if_getanyethermac(uint16_t *, int);
984263bc 767int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
cb80735c
RP
768struct ifnet *if_alloc(uint8_t);
769void if_free(struct ifnet *);
984263bc
MD
770void if_route(struct ifnet *, int flag, int fam);
771int if_setlladdr(struct ifnet *, const u_char *, int);
772void if_unroute(struct ifnet *, int flag, int fam);
773void if_up(struct ifnet *);
774/*void ifinit(void);*/ /* declared in systm.h for main() */
87de5057 775int ifioctl(struct socket *, u_long, caddr_t, struct ucred *);
984263bc
MD
776int ifpromisc(struct ifnet *, int);
777struct ifnet *ifunit(const char *);
778struct ifnet *if_withname(struct sockaddr *);
779
315a7da3
JL
780struct ifg_group *if_creategroup(const char *);
781int if_addgroup(struct ifnet *, const char *);
782int if_delgroup(struct ifnet *, const char *);
783int if_getgroup(caddr_t, struct ifnet *);
784int if_getgroupmembers(caddr_t);
785
984263bc
MD
786struct ifaddr *ifa_ifwithaddr(struct sockaddr *);
787struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
788struct ifaddr *ifa_ifwithnet(struct sockaddr *);
789struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
790struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
984263bc 791
aeb3c11e
RP
792typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
793typedef void if_com_free_t(void *com, u_char type);
794void if_register_com_alloc(u_char, if_com_alloc_t *a, if_com_free_t *);
795void if_deregister_com_alloc(u_char);
796
b2632176
SZ
797void *ifa_create(int, int);
798void ifa_destroy(struct ifaddr *);
799void ifa_iflink(struct ifaddr *, struct ifnet *, int);
800void ifa_ifunlink(struct ifaddr *, struct ifnet *);
b2632176 801
bd08b792
RP
802struct ifaddr *ifaddr_byindex(unsigned short);
803
984263bc
MD
804struct ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
805int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
9db4b353 806void if_devstart(struct ifnet *ifp);
984263bc 807
f2682cb9 808#define IF_LLSOCKADDR(ifp) \
141697b6 809 ((struct sockaddr_dl *)(ifp)->if_lladdr->ifa_addr)
f2682cb9 810#define IF_LLADDR(ifp) LLADDR(IF_LLSOCKADDR(ifp))
984263bc
MD
811
812#ifdef DEVICE_POLLING
f5703be1
JS
813typedef void poll_handler_t (struct ifnet *ifp, enum poll_cmd cmd, int count);
814int ether_poll_register(struct ifnet *);
815int ether_poll_deregister(struct ifnet *);
1630efc5 816int ether_pollcpu_register(struct ifnet *, int);
984263bc 817#endif /* DEVICE_POLLING */
b3a7093f
SZ
818
819#ifdef IFPOLL_ENABLE
820int ifpoll_register(struct ifnet *);
821int ifpoll_deregister(struct ifnet *);
822#endif /* IFPOLL_ENABLE */
823
984263bc
MD
824#endif /* _KERNEL */
825
826#endif /* !_NET_IF_VAR_H_ */