2 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
8 * This file contains Original Code and/or Modifications of Original Code
9 * as defined in and that are subject to the Apple Public Source License
10 * Version 2.0 (the 'License'). You may not use this file except in
11 * compliance with the License. Please obtain a copy of the License at
12 * http://www.opensource.apple.com/apsl/ and read it before using this
15 * The Original Code and all software distributed under the License are
16 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
17 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
18 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
20 * Please see the License for the specific language governing rights and
21 * limitations under the License.
23 * @APPLE_LICENSE_HEADER_END@
26 * Copyright (c) 1982, 1986, 1989, 1993
27 * The Regents of the University of California. All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
32 * 1. Redistributions of source code must retain the above copyright
33 * notice, this list of conditions and the following disclaimer.
34 * 2. Redistributions in binary form must reproduce the above copyright
35 * notice, this list of conditions and the following disclaimer in the
36 * documentation and/or other materials provided with the distribution.
37 * 3. All advertising materials mentioning features or use of this software
38 * must display the following acknowledgement:
39 * This product includes software developed by the University of
40 * California, Berkeley and its contributors.
41 * 4. Neither the name of the University nor the names of its contributors
42 * may be used to endorse or promote products derived from this software
43 * without specific prior written permission.
45 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
46 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
49 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
51 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
53 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
54 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
57 * From: @(#)if.h 8.1 (Berkeley) 6/10/93
58 * $FreeBSD: src/sys/net/if_var.h,v 1.18.2.7 2001/07/24 19:10:18 brooks Exp $
61 #ifndef _NET_IF_VAR_H_
62 #define _NET_IF_VAR_H_
63 #include <sys/appleapiopts.h>
66 #define APPLE_IF_FAM_LOOPBACK 1
67 #define APPLE_IF_FAM_ETHERNET 2
68 #define APPLE_IF_FAM_SLIP 3
69 #define APPLE_IF_FAM_TUN 4
70 #define APPLE_IF_FAM_VLAN 5
71 #define APPLE_IF_FAM_PPP 6
72 #define APPLE_IF_FAM_PVC 7
73 #define APPLE_IF_FAM_DISC 8
74 #define APPLE_IF_FAM_MDECAP 9
75 #define APPLE_IF_FAM_GIF 10
76 #define APPLE_IF_FAM_FAITH 11
77 #define APPLE_IF_FAM_STF 12
78 #define APPLE_IF_FAM_FIREWIRE 13
82 * Structures defining a network interface, providing a packet
83 * transport mechanism (ala level 0 of the PUP protocols).
85 * Each interface accepts output datagrams of a specified maximum
86 * length, and provides higher level routines with input datagrams
87 * received from its medium.
89 * Output occurs when the routine if_output is called, with three parameters:
90 * (*ifp->if_output)(ifp, m, dst, rt)
91 * Here m is the mbuf chain to be sent and dst is the destination address.
92 * The output routine encapsulates the supplied datagram if necessary,
93 * and then transmits it on its medium.
95 * On input, each interface unwraps the data received by it, and either
96 * places it on the input queue of a internetwork datagram routine
97 * and posts the associated software interrupt, or passes the datagram to a raw
98 * packet input routine.
100 * Routines exist for locating interfaces by their addresses
101 * or for locating a interface on a certain network, as well as more general
102 * routing and gateway routines maintaining information used to locate
103 * interfaces. These routines live in the files if.c and route.c
108 * Forward structure declarations for function prototypes [sic].
120 #include <sys/queue.h> /* get TAILQ macros */
122 #ifdef __APPLE_API_UNSTABLE
126 TAILQ_HEAD(tailq_head
, tqdummy
);
128 /* This belongs up in socket.h or socketvar.h, depending on how far the
132 struct net_event_data
{
135 char if_name
[IFNAMSIZ
];
140 TAILQ_HEAD(ifnethead
, ifnet
); /* we use TAILQs so that the order of */
141 TAILQ_HEAD(ifaddrhead
, ifaddr
); /* instantiation is preserved in the list */
142 TAILQ_HEAD(ifprefixhead
, ifprefix
);
143 LIST_HEAD(ifmultihead
, ifmultiaddr
);
146 #ifdef KERNEL_PRIVATE
147 /* bottom 16 bits reserved for hardware checksum */
148 #define IF_HWASSIST_CSUM_IP 0x0001 /* will csum IP */
149 #define IF_HWASSIST_CSUM_TCP 0x0002 /* will csum TCP */
150 #define IF_HWASSIST_CSUM_UDP 0x0004 /* will csum UDP */
151 #define IF_HWASSIST_CSUM_IP_FRAGS 0x0008 /* will csum IP fragments */
152 #define IF_HWASSIST_CSUM_FRAGMENT 0x0010 /* will do IP fragmentation */
153 #define IF_HWASSIST_CSUM_TCP_SUM16 0x1000 /* simple TCP Sum16 computation */
154 #define IF_HWASSIST_CSUM_MASK 0xffff
155 #define IF_HWASSIST_CSUM_FLAGS(hwassist) ((hwassist) & IF_HWASSIST_CSUM_MASK)
158 #define IF_HWASSIST_VLAN_TAGGING 0x10000 /* supports VLAN tagging */
159 #define IF_HWASSIST_VLAN_MTU 0x20000 /* supports VLAN MTU-sized packet (for software VLAN) */
160 #endif KERNEL_PRIVATE
162 * Structure describing information about an interface
163 * which may be of interest to management entities.
166 /* generic interface information */
167 u_char ifi_type
; /* ethernet, tokenring, etc */
169 u_char ifi_typelen
; /* Length of frame type id */
171 u_char ifi_physical
; /* e.g., AUI, Thinnet, 10base-T, etc */
172 u_char ifi_addrlen
; /* media address length */
173 u_char ifi_hdrlen
; /* media header length */
174 u_char ifi_recvquota
; /* polling quota for receive intrs */
175 u_char ifi_xmitquota
; /* polling quota for xmit intrs */
176 u_long ifi_mtu
; /* maximum transmission unit */
177 u_long ifi_metric
; /* routing metric (external only) */
178 u_long ifi_baudrate
; /* linespeed */
179 /* volatile statistics */
180 u_long ifi_ipackets
; /* packets received on interface */
181 u_long ifi_ierrors
; /* input errors on interface */
182 u_long ifi_opackets
; /* packets sent on interface */
183 u_long ifi_oerrors
; /* output errors on interface */
184 u_long ifi_collisions
; /* collisions on csma interfaces */
185 u_long ifi_ibytes
; /* total number of octets received */
186 u_long ifi_obytes
; /* total number of octets sent */
187 u_long ifi_imcasts
; /* packets received via multicast */
188 u_long ifi_omcasts
; /* packets sent via multicast */
189 u_long ifi_iqdrops
; /* dropped on input, this interface */
190 u_long ifi_noproto
; /* destined for unsupported protocol */
192 u_long ifi_recvtiming
; /* usec spent receiving when timing */
193 u_long ifi_xmittiming
; /* usec spent xmitting when timing */
195 struct timeval ifi_lastchange
; /* time of last administrative change */
197 u_long default_proto
; /* Default dl_tag when none is specified
200 u_long ifi_hwassist
; /* HW offload capabilities */
201 #ifdef KERNEL_PRIVATE
202 u_short ifi_nvlans
; /* number of attached vlans */
203 u_short ifi_reserved_1
; /* for future use */
205 u_long ifi_reserved1
; /* for future use */
206 #endif KERNEL_PRIVATE
207 u_long ifi_reserved2
; /* for future use */
212 * Structure defining a queue for a network interface.
215 struct mbuf
*ifq_head
;
216 struct mbuf
*ifq_tail
;
223 * Structure defining a network interface.
225 * (Would like to call this struct ``if'', but C isn't PL/1.)
228 void *if_softc
; /* pointer to driver state */
229 char *if_name
; /* name, e.g. ``en'' or ``lo'' */
230 TAILQ_ENTRY(ifnet
) if_link
; /* all struct ifnets are chained */
231 struct ifaddrhead if_addrhead
; /* linked list of addresses per if */
233 struct tailq_head proto_head
; /* Head for if_proto structures */
235 int if_pcount
; /* number of promiscuous listeners */
236 struct bpf_if
*if_bpf
; /* packet filter structure */
237 u_short if_index
; /* numeric abbreviation for this if */
238 short if_unit
; /* sub-unit for lower level driver */
239 short if_timer
; /* time 'til if_watchdog called */
240 short if_flags
; /* up/down, broadcast, etc. */
241 int if_ipending
; /* interrupts pending */
242 void *if_linkmib
; /* link-type-specific MIB data */
243 size_t if_linkmiblen
; /* length of above data */
244 struct if_data if_data
;
250 int (*if_output
)(struct ifnet
*ifnet_ptr
, struct mbuf
*m
);
251 int (*if_ioctl
)(struct ifnet
*ifnet_ptr
, u_long ioctl_code
, void *ioctl_arg
);
252 int (*if_set_bpf_tap
)(struct ifnet
*ifp
, int mode
,
253 int (*bpf_callback
)(struct ifnet
*, struct mbuf
*));
254 int (*if_free
)(struct ifnet
*ifnet_ptr
);
255 int (*if_demux
)(struct ifnet
*ifnet_ptr
, struct mbuf
*mbuf_ptr
,
256 char *frame_ptr
, void *if_proto_ptr
);
258 int (*if_event
)(struct ifnet
*ifnet_ptr
, caddr_t event_ptr
);
260 int (*if_framer
)(struct ifnet
*ifp
,
262 struct sockaddr
*dest
,
266 u_long if_family
; /* ulong assigned by Apple */
267 struct tailq_head if_flt_head
;
269 /* End DLIL specific */
271 void *reserved0
; /* for future use */
272 void *if_private
; /* private to interface */
273 long if_eflags
; /* autoaddr, autoaddr done, etc. */
274 #endif /* __APPLE__ */
276 struct ifmultihead if_multiaddrs
; /* multicast addresses configured */
277 int if_amcount
; /* number of all-multicast requests */
278 /* procedure handles */
280 int (*if_output
) /* output routine (enqueue) */
281 __P((struct ifnet
*, struct mbuf
*, struct sockaddr
*,
283 void (*if_start
) /* initiate output routine */
284 __P((struct ifnet
*));
285 int (*if_done
) /* output complete routine */
286 __P((struct ifnet
*)); /* (XXX not used; fake prototype) */
287 int (*if_ioctl
) /* ioctl routine */
288 __P((struct ifnet
*, u_long
, caddr_t
));
289 void (*if_watchdog
) /* timer routine */
290 __P((struct ifnet
*));
292 int (*if_poll_recv
) /* polled receive routine */
293 __P((struct ifnet
*, int *));
294 int (*if_poll_xmit
) /* polled transmit routine */
295 __P((struct ifnet
*, int *));
296 void (*if_poll_intren
) /* polled interrupt reenable routine */
297 __P((struct ifnet
*));
298 void (*if_poll_slowinput
) /* input routine for slow devices */
299 __P((struct ifnet
*, struct mbuf
*));
300 void (*if_init
) /* Init routine */
302 int (*if_resolvemulti
) /* validate/resolve multicast */
303 __P((struct ifnet
*, struct sockaddr
**, struct sockaddr
*));
304 struct ifqueue if_snd
; /* output queue */
305 struct ifqueue
*if_poll_slowq
; /* input queue for slow devices */
307 u_long family_cookie
;
308 struct ifprefixhead if_prefixhead
; /* list of prefixes per if */
309 void *reserved1
; /* for future use */
311 struct ifprefixhead if_prefixhead
; /* list of prefixes per if */
312 #endif /* __APPLE__ */
314 typedef void if_init_f_t
__P((void *));
316 #define if_mtu if_data.ifi_mtu
317 #define if_type if_data.ifi_type
318 #define if_typelen if_data.ifi_typelen
319 #define if_physical if_data.ifi_physical
320 #define if_addrlen if_data.ifi_addrlen
321 #define if_hdrlen if_data.ifi_hdrlen
322 #define if_metric if_data.ifi_metric
323 #define if_baudrate if_data.ifi_baudrate
324 #define if_hwassist if_data.ifi_hwassist
325 #define if_ipackets if_data.ifi_ipackets
326 #define if_ierrors if_data.ifi_ierrors
327 #define if_opackets if_data.ifi_opackets
328 #define if_oerrors if_data.ifi_oerrors
329 #define if_collisions if_data.ifi_collisions
330 #define if_ibytes if_data.ifi_ibytes
331 #define if_obytes if_data.ifi_obytes
332 #define if_imcasts if_data.ifi_imcasts
333 #define if_omcasts if_data.ifi_omcasts
334 #define if_iqdrops if_data.ifi_iqdrops
335 #define if_noproto if_data.ifi_noproto
336 #define if_lastchange if_data.ifi_lastchange
337 #define if_recvquota if_data.ifi_recvquota
338 #define if_xmitquota if_data.ifi_xmitquota
339 #ifdef KERNEL_PRIVATE
340 #define if_nvlans if_data.ifi_nvlans
341 #endif KERNEL_PRIVATE
342 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0)
345 /* for compatibility with other BSDs */
346 #define if_addrlist if_addrhead
347 #define if_list if_link
349 #ifdef KERNEL_PRIVATE
351 * Structure describing a `cloning' interface.
354 LIST_ENTRY(if_clone
) ifc_list
; /* on list of cloners */
355 const char *ifc_name
; /* name of device, e.g. `vlan' */
356 size_t ifc_namelen
; /* length of name */
357 int ifc_minifs
; /* minimum number of interfaces */
358 int ifc_maxunit
; /* maximum unit number */
359 unsigned char *ifc_units
; /* bitmap to handle units */
360 int ifc_bmlen
; /* bitmap length */
362 int (*ifc_create
)(struct if_clone
*, int);
363 void (*ifc_destroy
)(struct ifnet
*);
366 #define IF_CLONE_INITIALIZER(name, create, destroy, minifs, maxunit) \
367 { { 0 }, name, sizeof(name) - 1, minifs, maxunit, NULL, 0, create, destroy }
371 * Bit values in if_ipending
373 #define IFI_RECV 1 /* I want to receive */
374 #define IFI_XMIT 2 /* I want to transmit */
377 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
378 * are queues of messages stored on ifqueue structures
379 * (defined above). Entries are added to and deleted from these structures
380 * by these macros, which should be called with ipl raised to splimp().
382 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
383 #define IF_DROP(ifq) ((ifq)->ifq_drops++)
384 #define IF_ENQUEUE(ifq, m) { \
385 (m)->m_nextpkt = 0; \
386 if ((ifq)->ifq_tail == 0) \
387 (ifq)->ifq_head = m; \
389 (ifq)->ifq_tail->m_nextpkt = m; \
390 (ifq)->ifq_tail = m; \
393 #define IF_PREPEND(ifq, m) { \
394 (m)->m_nextpkt = (ifq)->ifq_head; \
395 if ((ifq)->ifq_tail == 0) \
396 (ifq)->ifq_tail = (m); \
397 (ifq)->ifq_head = (m); \
400 #define IF_DEQUEUE(ifq, m) { \
401 (m) = (ifq)->ifq_head; \
403 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
404 (ifq)->ifq_tail = 0; \
405 (m)->m_nextpkt = 0; \
411 #define IF_ENQ_DROP(ifq, m) if_enq_drop(ifq, m)
413 #if defined(__GNUC__) && defined(MT_HEADER)
415 if_queue_drop(struct ifqueue
*ifq
, struct mbuf
*m
)
422 if_enq_drop(struct ifqueue
*ifq
, struct mbuf
*m
)
425 !if_queue_drop(ifq
, m
))
433 int if_enq_drop
__P((struct ifqueue
*, struct mbuf
*));
437 #endif /* __APPLE_API_UNSTABLE */
440 * 72 was chosen below because it is the size of a TCP/IP
441 * header (40) + the minimum mss (32).
444 #define IF_MAXMTU 65535
448 #ifdef __APPLE_API_UNSTABLE
450 * The ifaddr structure contains information about one address
451 * of an interface. They are maintained by the different address families,
452 * are allocated and attached when an address is set, and are linked
453 * together so all addresses for an interface can be located.
456 struct sockaddr
*ifa_addr
; /* address of interface */
457 struct sockaddr
*ifa_dstaddr
; /* other end of p-to-p link */
458 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
459 struct sockaddr
*ifa_netmask
; /* used to determine subnet */
461 /* Use of if_data doesn't justify change of API */
462 struct if_data if_data
; /* not all members are meaningful */
464 struct ifnet
*ifa_ifp
; /* back-pointer to interface */
465 TAILQ_ENTRY(ifaddr
) ifa_link
; /* queue macro glue */
466 void (*ifa_rtrequest
) /* check or clean routes (+ or -)'d */
467 __P((int, struct rtentry
*, struct sockaddr
*));
468 u_short ifa_flags
; /* mostly rt_flags for cloning */
469 short ifa_refcnt
;/* 16bit ref count, use ifaref, ifafree */
470 int ifa_metric
; /* cost of going out this interface */
472 struct rtentry
*ifa_rt
; /* XXXX for ROUTETOIF ????? */
475 int (*ifa_claim_addr
) /* check if an addr goes to this if */
476 __P((struct ifaddr
*, struct sockaddr
*));
478 #define IFA_ROUTE RTF_UP /* route installed */
481 * The prefix structure contains information about one prefix
482 * of an interface. They are maintained by the different address families,
483 * are allocated and attached when an prefix or an address is set,
484 * and are linked together so all prefixes for an interface can be located.
487 struct sockaddr
*ifpr_prefix
; /* prefix of interface */
488 struct ifnet
*ifpr_ifp
; /* back-pointer to interface */
489 TAILQ_ENTRY(ifprefix
) ifpr_list
; /* queue macro glue */
490 u_char ifpr_plen
; /* prefix length in bits */
491 u_char ifpr_type
; /* protocol dependent prefix type */
495 * Multicast address structure. This is analogous to the ifaddr
496 * structure except that it keeps track of multicast addresses.
497 * Also, the reference count here is a count of requests for this
498 * address, not a count of pointers to this structure.
501 LIST_ENTRY(ifmultiaddr
) ifma_link
; /* queue macro glue */
502 struct sockaddr
*ifma_addr
; /* address this membership is for */
503 struct sockaddr
*ifma_lladdr
; /* link-layer translation, if any */
504 struct ifnet
*ifma_ifp
; /* back-pointer to interface */
505 u_int ifma_refcount
; /* reference count */
506 void *ifma_protospec
; /* protocol-specific state, if any */
510 #define IFAREF(ifa) ifaref(ifa)
511 #define IFAFREE(ifa) ifafree(ifa)
513 #ifdef __APPLE_API_PRIVATE
514 extern struct ifnethead ifnet
;
515 extern struct ifnet
**ifindex2ifnet
;
516 extern int ifqmaxlen
;
517 extern struct ifnet loif
[];
519 extern struct ifaddr
**ifnet_addrs
;
520 #endif /* __APPLE_API_PRIVATE */
523 void ether_ifattach
__P((struct ifnet
*, int));
524 void ether_ifdetach
__P((struct ifnet
*, int));
525 void ether_input
__P((struct ifnet
*, struct ether_header
*, struct mbuf
*));
526 void ether_demux
__P((struct ifnet
*, struct ether_header
*, struct mbuf
*));
527 int ether_output
__P((struct ifnet
*,
528 struct mbuf
*, struct sockaddr
*, struct rtentry
*));
529 int ether_output_frame
__P((struct ifnet
*, struct mbuf
*));
530 int ether_ioctl
__P((struct ifnet
*, int, caddr_t
));
533 int if_addmulti
__P((struct ifnet
*, struct sockaddr
*,
534 struct ifmultiaddr
**));
535 int if_allmulti
__P((struct ifnet
*, int));
536 void if_attach
__P((struct ifnet
*));
537 int if_delmultiaddr
__P((struct ifmultiaddr
*ifma
));
538 int if_delmulti
__P((struct ifnet
*, struct sockaddr
*));
539 void if_down
__P((struct ifnet
*));
540 void if_route
__P((struct ifnet
*, int flag
, int fam
));
541 void if_unroute
__P((struct ifnet
*, int flag
, int fam
));
542 void if_up
__P((struct ifnet
*));
543 /*void ifinit __P((void));*/ /* declared in systm.h for main() */
544 int ifioctl
__P((struct socket
*, u_long
, caddr_t
, struct proc
*));
545 int ifpromisc
__P((struct ifnet
*, int));
546 struct ifnet
*ifunit
__P((const char *));
547 struct ifnet
*if_withname
__P((struct sockaddr
*));
549 int if_poll_recv_slow
__P((struct ifnet
*ifp
, int *quotap
));
550 void if_poll_xmit_slow
__P((struct ifnet
*ifp
, int *quotap
));
551 void if_poll_throttle
__P((void));
552 void if_poll_unthrottle
__P((void *));
553 void if_poll_init
__P((void));
554 void if_poll
__P((void));
555 #ifdef KERNEL_PRIVATE
556 void if_clone_attach(struct if_clone
*);
557 void if_clone_detach(struct if_clone
*);
558 #endif KERNEL_PRIVATE
560 struct ifaddr
*ifa_ifwithaddr
__P((struct sockaddr
*));
561 struct ifaddr
*ifa_ifwithdstaddr
__P((struct sockaddr
*));
562 struct ifaddr
*ifa_ifwithnet
__P((struct sockaddr
*));
563 struct ifaddr
*ifa_ifwithroute
__P((int, struct sockaddr
*,
565 struct ifaddr
*ifaof_ifpforaddr
__P((struct sockaddr
*, struct ifnet
*));
566 void ifafree
__P((struct ifaddr
*));
567 void ifaref
__P((struct ifaddr
*));
569 struct ifmultiaddr
*ifmaof_ifpforaddr
__P((struct sockaddr
*,
572 int if_simloop
__P((struct ifnet
*ifp
, struct mbuf
*m
,
573 struct sockaddr
*dst
, int hlen
));
579 #endif /* __APPLE_API_UNSTABLE */
580 #endif /* !_NET_IF_VAR_H_ */