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