2 * Copyright (c) 1982, 1986, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
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 * $DragonFly: src/sys/net/if_var.h,v 1.48 2008/03/20 12:55:32 sephe Exp $
38 #ifndef _NET_IF_VAR_H_
39 #define _NET_IF_VAR_H_
41 #ifndef _SYS_SERIALIZE_H_
42 #include <sys/serialize.h>
49 * Structures defining a network interface, providing a packet
50 * transport mechanism (ala level 0 of the PUP protocols).
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.
56 * Output occurs when the routine if_output is called, with four parameters:
57 * ifp->if_output(ifp, m, dst, rt)
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.
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
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:
66 * ifp->if_input(ifp, m)
67 * The input routine removes the protocol dependent header if necessary.
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
76 * Forward structure declarations for function prototypes [sic].
86 struct lwkt_serialize
;
87 struct ifaddr_container
;
91 #include <sys/queue.h> /* get TAILQ macros */
93 #include <net/altq/if_altq.h>
96 #include <sys/eventhandler.h>
98 #include <sys/systm.h> /* XXX */
99 #include <sys/thread2.h>
102 #define IF_DUNIT_NONE -1
104 TAILQ_HEAD(ifnethead
, ifnet
); /* we use TAILQs so that the order of */
105 TAILQ_HEAD(ifaddrhead
, ifaddr_container
); /* instantiation is preserved in the list */
106 TAILQ_HEAD(ifprefixhead
, ifprefix
);
107 LIST_HEAD(ifmultihead
, ifmultiaddr
);
110 * Structure defining a queue for a network interface.
113 struct mbuf
*ifq_head
;
114 struct mbuf
*ifq_tail
;
121 * Note of DEVICE_POLLING
122 * 1) Any file(*.c) that depends on DEVICE_POLLING supports in this
123 * file should include opt_polling.h at its beginning.
124 * 2) When struct changes, which are conditioned by DEVICE_POLLING,
125 * are to be introduced, please keep the struct's size and layout
126 * same, no matter whether DEVICE_POLLING is defined or not.
127 * See ifnet.if_poll and ifnet.if_poll_unused for example.
130 #ifdef DEVICE_POLLING
131 enum poll_cmd
{ POLL_ONLY
, POLL_AND_CHECK_STATUS
, POLL_DEREGISTER
,
136 * Structure defining a network interface.
138 * (Would like to call this struct ``if'', but C isn't PL/1.)
142 * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with
143 * one of these structures, typically held within an arpcom structure.
145 * struct <foo>_softc {
147 * struct ifnet ac_if;
153 * The assumption is used in a number of places, including many
154 * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
156 * Unfortunately devices' softc are opaque, so we depend on this layout
157 * to locate the struct ifnet from the softc in the generic code.
161 * ifnet and its related packet queues are protected by if_serializer.
162 * Callers of if_output, if_ioctl, if_start, if_watchdog, if_init,
163 * if_resolvemulti, and if_poll hold if_serializer. Device drivers usually
164 * use the same serializer for their interrupt but this is not required.
165 * However, the device driver must be holding if_serializer when it
166 * calls if_input. Note that the serializer may be temporarily released
167 * within if_input to avoid a deadlock (e.g. when fast-forwarding or
168 * bridging packets between interfaces).
170 * If a device driver installs the same serializer for its interrupt
171 * as for ifnet, then the driver only really needs to worry about further
172 * serialization in timeout based entry points. All other entry points
173 * will already be serialized. Older ISA drivers still using the old
174 * interrupt infrastructure will have to obtain and release the serializer
175 * in their interrupt routine themselves.
178 void *if_softc
; /* pointer to driver state */
179 TAILQ_ENTRY(ifnet
) if_link
; /* all struct ifnets are chained */
180 char if_xname
[IFNAMSIZ
]; /* external name (name + unit) */
181 const char *if_dname
; /* driver name */
182 int if_dunit
; /* unit or IF_DUNIT_NONE */
183 void *if_vlantrunks
; /* vlan trunks */
184 struct ifaddrhead
*if_addrheads
; /* linked lists of addresses per if */
185 int if_pcount
; /* number of promiscuous listeners */
186 struct carp_if
*if_carp
; /* carp interface structure */
187 struct bpf_if
*if_bpf
; /* packet filter structure */
188 u_short if_index
; /* numeric abbreviation for this if */
189 short if_timer
; /* time 'til if_watchdog called */
190 int if_flags
; /* up/down, broadcast, etc. */
191 int if_capabilities
; /* interface capabilities */
192 int if_capenable
; /* enabled features */
193 void *if_linkmib
; /* link-type-specific MIB data */
194 size_t if_linkmiblen
; /* length of above data */
195 struct if_data if_data
;
196 struct ifmultihead if_multiaddrs
; /* multicast addresses configured */
197 int if_amcount
; /* number of all-multicast requests */
198 /* procedure handles */
199 int (*if_output
) /* output routine (enqueue) */
200 (struct ifnet
*, struct mbuf
*, struct sockaddr
*,
202 void (*if_input
) /* input routine from hardware driver */
203 (struct ifnet
*, struct mbuf
*);
204 void (*if_start
) /* initiate output routine */
206 int (*if_ioctl
) /* ioctl routine */
207 (struct ifnet
*, u_long
, caddr_t
, struct ucred
*);
208 void (*if_watchdog
) /* timer routine */
210 void (*if_init
) /* Init routine */
212 int (*if_resolvemulti
) /* validate/resolve multicast */
213 (struct ifnet
*, struct sockaddr
**, struct sockaddr
*);
214 #ifdef DEVICE_POLLING
215 void (*if_poll
) /* IFF_POLLING support */
216 (struct ifnet
*, enum poll_cmd
, int);
220 void (*if_poll_unused
)(void);
221 int if_poll_cpuid_used
;
223 struct ifaltq if_snd
; /* output queue (includes altq) */
224 struct ifprefixhead if_prefixhead
; /* list of prefixes per if */
225 const uint8_t *if_broadcastaddr
;
226 void *if_bridge
; /* bridge glue */
227 void *if_afdata
[AF_MAX
];
228 struct ifaddr
*if_lladdr
;
229 struct lwkt_serialize
*if_serializer
; /* serializer or MP lock */
230 struct lwkt_serialize if_default_serializer
; /* if not supplied */
232 typedef void if_init_f_t (void *);
234 #define if_mtu if_data.ifi_mtu
235 #define if_type if_data.ifi_type
236 #define if_physical if_data.ifi_physical
237 #define if_addrlen if_data.ifi_addrlen
238 #define if_hdrlen if_data.ifi_hdrlen
239 #define if_metric if_data.ifi_metric
240 #define if_link_state if_data.ifi_link_state
241 #define if_baudrate if_data.ifi_baudrate
242 #define if_hwassist if_data.ifi_hwassist
243 #define if_ipackets if_data.ifi_ipackets
244 #define if_ierrors if_data.ifi_ierrors
245 #define if_opackets if_data.ifi_opackets
246 #define if_oerrors if_data.ifi_oerrors
247 #define if_collisions if_data.ifi_collisions
248 #define if_ibytes if_data.ifi_ibytes
249 #define if_obytes if_data.ifi_obytes
250 #define if_imcasts if_data.ifi_imcasts
251 #define if_omcasts if_data.ifi_omcasts
252 #define if_iqdrops if_data.ifi_iqdrops
253 #define if_noproto if_data.ifi_noproto
254 #define if_lastchange if_data.ifi_lastchange
255 #define if_recvquota if_data.ifi_recvquota
256 #define if_xmitquota if_data.ifi_xmitquota
257 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0)
259 /* for compatibility with other BSDs */
260 #define if_list if_link
264 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
265 * are queues of messages stored on ifqueue structures
266 * (defined above). Entries are added to and deleted from these structures
267 * by these macros, which should be called with ipl raised to splimp().
269 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
270 #define IF_DROP(ifq) ((ifq)->ifq_drops++)
271 #define IF_QLEN(ifq) ((ifq)->ifq_len)
272 #define IF_QEMPTY(ifq) (IF_QLEN(ifq) == 0)
273 #define IF_ENQUEUE(ifq, m) do { \
274 (m)->m_nextpkt = 0; \
275 if ((ifq)->ifq_tail == 0) \
276 (ifq)->ifq_head = m; \
278 (ifq)->ifq_tail->m_nextpkt = m; \
279 (ifq)->ifq_tail = m; \
282 #define IF_PREPEND(ifq, m) do { \
283 (m)->m_nextpkt = (ifq)->ifq_head; \
284 if ((ifq)->ifq_tail == 0) \
285 (ifq)->ifq_tail = (m); \
286 (ifq)->ifq_head = (m); \
289 #define IF_DEQUEUE(ifq, m) do { \
290 (m) = (ifq)->ifq_head; \
292 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
293 (ifq)->ifq_tail = 0; \
294 (m)->m_nextpkt = 0; \
299 #define IF_POLL(ifq, m) ((m) = (ifq)->ifq_head)
301 #define IF_DRAIN(ifq) do { \
304 IF_DEQUEUE(ifq, m); \
314 * DEPRECATED - should not be used by any new driver. This code uses the
315 * old queueing interface and if_start ABI and does not use the ifp's
318 #define IF_HANDOFF(ifq, m, ifp) if_handoff(ifq, m, ifp, 0)
319 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj) if_handoff(ifq, m, ifp, adj)
322 if_handoff(struct ifqueue
*_ifq
, struct mbuf
*_m
, struct ifnet
*_ifp
,
325 int _need_if_start
= 0;
329 if (IF_QFULL(_ifq
)) {
336 _ifp
->if_obytes
+= _m
->m_pkthdr
.len
+ _adjust
;
337 if (_m
->m_flags
& M_MCAST
)
339 _need_if_start
= !(_ifp
->if_flags
& IFF_OACTIVE
);
341 IF_ENQUEUE(_ifq
, _m
);
342 if (_need_if_start
) {
343 (*_ifp
->if_start
)(_ifp
);
350 * 72 was chosen below because it is the size of a TCP/IP
351 * header (40) + the minimum mss (32).
354 #define IF_MAXMTU 65535
358 struct ifaddr_container
{
359 #define IFA_CONTAINER_MAGIC 0x19810219
360 #define IFA_CONTAINER_DEAD 0xc0dedead
361 uint32_t ifa_magic
; /* IFA_CONTAINER_MAGIC */
363 TAILQ_ENTRY(ifaddr_container
) ifa_link
; /* queue macro glue */
364 u_int ifa_refcnt
; /* references to this structure */
368 * The ifaddr structure contains information about one address
369 * of an interface. They are maintained by the different address families,
370 * are allocated and attached when an address is set, and are linked
371 * together so all addresses for an interface can be located.
374 struct sockaddr
*ifa_addr
; /* address of interface */
375 struct sockaddr
*ifa_dstaddr
; /* other end of p-to-p link */
376 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
377 struct sockaddr
*ifa_netmask
; /* used to determine subnet */
378 struct if_data if_data
; /* not all members are meaningful */
379 struct ifnet
*ifa_ifp
; /* back-pointer to interface */
381 struct ifaddr_container
*ifa_containers
;
382 void (*ifa_rtrequest
) /* check or clean routes (+ or -)'d */
383 (int, struct rtentry
*, struct rt_addrinfo
*);
384 u_short ifa_flags
; /* mostly rt_flags for cloning */
385 cpumask_t ifa_cpumask
;
386 int ifa_metric
; /* cost of going out this interface */
388 struct rtentry
*ifa_rt
; /* XXXX for ROUTETOIF ????? */
390 int (*ifa_claim_addr
) /* check if an addr goes to this if */
391 (struct ifaddr
*, struct sockaddr
*);
394 #define IFA_ROUTE RTF_UP /* route installed */
396 /* for compatibility with other BSDs */
397 #define ifa_list ifa_link
400 * The prefix structure contains information about one prefix
401 * of an interface. They are maintained by the different address families,
402 * are allocated and attached when an prefix or an address is set,
403 * and are linked together so all prefixes for an interface can be located.
406 struct sockaddr
*ifpr_prefix
; /* prefix of interface */
407 struct ifnet
*ifpr_ifp
; /* back-pointer to interface */
408 TAILQ_ENTRY(ifprefix
) ifpr_list
; /* queue macro glue */
409 u_char ifpr_plen
; /* prefix length in bits */
410 u_char ifpr_type
; /* protocol dependent prefix type */
414 * Multicast address structure. This is analogous to the ifaddr
415 * structure except that it keeps track of multicast addresses.
416 * Also, the reference count here is a count of requests for this
417 * address, not a count of pointers to this structure.
420 LIST_ENTRY(ifmultiaddr
) ifma_link
; /* queue macro glue */
421 struct sockaddr
*ifma_addr
; /* address this membership is for */
422 struct sockaddr
*ifma_lladdr
; /* link-layer translation, if any */
423 struct ifnet
*ifma_ifp
; /* back-pointer to interface */
424 u_int ifma_refcount
; /* reference count */
425 void *ifma_protospec
; /* protocol-specific state, if any */
429 /* interface address change event */
430 typedef void (*ifaddr_event_handler_t
)(void *, struct ifnet
*);
431 EVENTHANDLER_DECLARE(ifaddr_event
, ifaddr_event_handler_t
);
432 /* new interface attach event */
433 typedef void (*ifnet_attach_event_handler_t
)(void *, struct ifnet
*);
434 EVENTHANDLER_DECLARE(ifnet_attach_event
, ifnet_attach_event_handler_t
);
435 /* interface detach event */
436 typedef void (*ifnet_detach_event_handler_t
)(void *, struct ifnet
*);
437 EVENTHANDLER_DECLARE(ifnet_detach_event
, ifnet_detach_event_handler_t
);
440 _IFAREF(struct ifaddr
*_ifa
, int _cpu_id
)
442 struct ifaddr_container
*_ifac
= &_ifa
->ifa_containers
[_cpu_id
];
445 KKASSERT(_ifac
->ifa_magic
== IFA_CONTAINER_MAGIC
);
451 IFAREF(struct ifaddr
*_ifa
)
453 _IFAREF(_ifa
, mycpuid
);
456 #include <sys/malloc.h>
458 MALLOC_DECLARE(M_IFADDR
);
459 MALLOC_DECLARE(M_IFMADDR
);
461 void ifac_free(struct ifaddr_container
*, int);
464 _IFAFREE(struct ifaddr
*_ifa
, int _cpu_id
)
466 struct ifaddr_container
*_ifac
= &_ifa
->ifa_containers
[_cpu_id
];
469 KKASSERT(_ifac
->ifa_magic
== IFA_CONTAINER_MAGIC
);
470 KKASSERT(_ifac
->ifa_refcnt
> 0);
471 if (--_ifac
->ifa_refcnt
== 0)
472 ifac_free(_ifac
, _cpu_id
);
477 IFAFREE(struct ifaddr
*_ifa
)
479 _IFAFREE(_ifa
, mycpuid
);
482 extern struct ifnethead ifnet
;
483 extern struct ifnet
**ifindex2ifnet
;
484 extern int ifqmaxlen
;
485 extern struct ifnet loif
[];
488 void ether_ifattach(struct ifnet
*, uint8_t *, struct lwkt_serialize
*);
489 void ether_ifattach_bpf(struct ifnet
*, uint8_t *, u_int
, u_int
,
490 struct lwkt_serialize
*);
491 void ether_ifdetach(struct ifnet
*);
492 void ether_input(struct ifnet
*, struct mbuf
*);
493 void ether_demux(struct ifnet
*, struct mbuf
*);
494 int ether_output_frame(struct ifnet
*, struct mbuf
*);
495 int ether_ioctl(struct ifnet
*, int, caddr_t
);
496 uint32_t ether_crc32_le(const uint8_t *, size_t);
497 uint32_t ether_crc32_be(const uint8_t *, size_t);
499 int if_addmulti(struct ifnet
*, struct sockaddr
*, struct ifmultiaddr
**);
500 int if_allmulti(struct ifnet
*, int);
501 void if_attach(struct ifnet
*, struct lwkt_serialize
*);
502 int if_delmulti(struct ifnet
*, struct sockaddr
*);
503 void if_purgeaddrs_nolink(struct ifnet
*);
504 void if_detach(struct ifnet
*);
505 void if_down(struct ifnet
*);
506 void if_link_state_change(struct ifnet
*);
507 void if_initname(struct ifnet
*, const char *, int);
508 int if_getanyethermac(uint16_t *, int);
509 int if_printf(struct ifnet
*, const char *, ...) __printflike(2, 3);
510 void if_route(struct ifnet
*, int flag
, int fam
);
511 int if_setlladdr(struct ifnet
*, const u_char
*, int);
512 void if_unroute(struct ifnet
*, int flag
, int fam
);
513 void if_up(struct ifnet
*);
514 /*void ifinit(void);*/ /* declared in systm.h for main() */
515 int ifioctl(struct socket
*, u_long
, caddr_t
, struct ucred
*);
516 int ifpromisc(struct ifnet
*, int);
517 struct ifnet
*ifunit(const char *);
518 struct ifnet
*if_withname(struct sockaddr
*);
520 struct ifaddr
*ifa_ifwithaddr(struct sockaddr
*);
521 struct ifaddr
*ifa_ifwithdstaddr(struct sockaddr
*);
522 struct ifaddr
*ifa_ifwithnet(struct sockaddr
*);
523 struct ifaddr
*ifa_ifwithroute(int, struct sockaddr
*, struct sockaddr
*);
524 struct ifaddr
*ifaof_ifpforaddr(struct sockaddr
*, struct ifnet
*);
526 void *ifa_create(int, int);
527 void ifa_destroy(struct ifaddr
*);
528 void ifa_iflink(struct ifaddr
*, struct ifnet
*, int);
529 void ifa_ifunlink(struct ifaddr
*, struct ifnet
*);
530 struct lwkt_port
*ifa_portfn(int);
532 struct ifmultiaddr
*ifmaof_ifpforaddr(struct sockaddr
*, struct ifnet
*);
533 int if_simloop(struct ifnet
*ifp
, struct mbuf
*m
, int af
, int hlen
);
535 #define IF_LLSOCKADDR(ifp) \
536 ((struct sockaddr_dl *)(ifp)->if_lladdr->ifa_addr)
537 #define IF_LLADDR(ifp) LLADDR(IF_LLSOCKADDR(ifp))
539 #ifdef DEVICE_POLLING
540 typedef void poll_handler_t (struct ifnet
*ifp
, enum poll_cmd cmd
, int count
);
541 int ether_poll_register(struct ifnet
*);
542 int ether_poll_deregister(struct ifnet
*);
543 int ether_pollcpu_register(struct ifnet
*, int);
544 #endif /* DEVICE_POLLING */
547 #endif /* !_NET_IF_VAR_H_ */