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