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
81 * Structures defining a network interface, providing a packet
82 * transport mechanism (ala level 0 of the PUP protocols).
84 * Each interface accepts output datagrams of a specified maximum
85 * length, and provides higher level routines with input datagrams
86 * received from its medium.
88 * Output occurs when the routine if_output is called, with three parameters:
89 * (*ifp->if_output)(ifp, m, dst, rt)
90 * Here m is the mbuf chain to be sent and dst is the destination address.
91 * The output routine encapsulates the supplied datagram if necessary,
92 * and then transmits it on its medium.
94 * On input, each interface unwraps the data received by it, and either
95 * places it on the input queue of a internetwork datagram routine
96 * and posts the associated software interrupt, or passes the datagram to a raw
97 * packet input routine.
99 * Routines exist for locating interfaces by their addresses
100 * or for locating a interface on a certain network, as well as more general
101 * routing and gateway routines maintaining information used to locate
102 * interfaces. These routines live in the files if.c and route.c
107 * Forward structure declarations for function prototypes [sic].
119 #include <sys/queue.h> /* get TAILQ macros */
121 #ifdef __APPLE_API_UNSTABLE
125 TAILQ_HEAD(tailq_head
, tqdummy
);
127 /* This belongs up in socket.h or socketvar.h, depending on how far the
131 struct net_event_data
{
134 char if_name
[IFNAMSIZ
];
139 TAILQ_HEAD(ifnethead
, ifnet
); /* we use TAILQs so that the order of */
140 TAILQ_HEAD(ifaddrhead
, ifaddr
); /* instantiation is preserved in the list */
141 TAILQ_HEAD(ifprefixhead
, ifprefix
);
142 LIST_HEAD(ifmultihead
, ifmultiaddr
);
146 * Structure describing information about an interface
147 * which may be of interest to management entities.
150 /* generic interface information */
151 u_char ifi_type
; /* ethernet, tokenring, etc */
153 u_char ifi_typelen
; /* Length of frame type id */
155 u_char ifi_physical
; /* e.g., AUI, Thinnet, 10base-T, etc */
156 u_char ifi_addrlen
; /* media address length */
157 u_char ifi_hdrlen
; /* media header length */
158 u_char ifi_recvquota
; /* polling quota for receive intrs */
159 u_char ifi_xmitquota
; /* polling quota for xmit intrs */
160 u_long ifi_mtu
; /* maximum transmission unit */
161 u_long ifi_metric
; /* routing metric (external only) */
162 u_long ifi_baudrate
; /* linespeed */
163 /* volatile statistics */
164 u_long ifi_ipackets
; /* packets received on interface */
165 u_long ifi_ierrors
; /* input errors on interface */
166 u_long ifi_opackets
; /* packets sent on interface */
167 u_long ifi_oerrors
; /* output errors on interface */
168 u_long ifi_collisions
; /* collisions on csma interfaces */
169 u_long ifi_ibytes
; /* total number of octets received */
170 u_long ifi_obytes
; /* total number of octets sent */
171 u_long ifi_imcasts
; /* packets received via multicast */
172 u_long ifi_omcasts
; /* packets sent via multicast */
173 u_long ifi_iqdrops
; /* dropped on input, this interface */
174 u_long ifi_noproto
; /* destined for unsupported protocol */
176 u_long ifi_recvtiming
; /* usec spent receiving when timing */
177 u_long ifi_xmittiming
; /* usec spent xmitting when timing */
179 struct timeval ifi_lastchange
; /* time of last administrative change */
181 u_long default_proto
; /* Default dl_tag when none is specified
184 u_long ifi_hwassist
; /* HW offload capabilities */
185 u_long ifi_reserved1
; /* for future use */
186 u_long ifi_reserved2
; /* for future use */
191 * Structure defining a queue for a network interface.
194 struct mbuf
*ifq_head
;
195 struct mbuf
*ifq_tail
;
202 * Structure defining a network interface.
204 * (Would like to call this struct ``if'', but C isn't PL/1.)
207 void *if_softc
; /* pointer to driver state */
208 char *if_name
; /* name, e.g. ``en'' or ``lo'' */
209 TAILQ_ENTRY(ifnet
) if_link
; /* all struct ifnets are chained */
210 struct ifaddrhead if_addrhead
; /* linked list of addresses per if */
212 struct tailq_head proto_head
; /* Head for if_proto structures */
214 int if_pcount
; /* number of promiscuous listeners */
215 struct bpf_if
*if_bpf
; /* packet filter structure */
216 u_short if_index
; /* numeric abbreviation for this if */
217 short if_unit
; /* sub-unit for lower level driver */
218 short if_timer
; /* time 'til if_watchdog called */
219 short if_flags
; /* up/down, broadcast, etc. */
220 int if_ipending
; /* interrupts pending */
221 void *if_linkmib
; /* link-type-specific MIB data */
222 size_t if_linkmiblen
; /* length of above data */
223 struct if_data if_data
;
229 int (*if_output
)(struct ifnet
*ifnet_ptr
, struct mbuf
*m
);
230 int (*if_ioctl
)(struct ifnet
*ifnet_ptr
, u_long ioctl_code
, void *ioctl_arg
);
231 int (*if_set_bpf_tap
)(struct ifnet
*ifp
, int mode
,
232 int (*bpf_callback
)(struct ifnet
*, struct mbuf
*));
233 int (*if_free
)(struct ifnet
*ifnet_ptr
);
234 int (*if_demux
)(struct ifnet
*ifnet_ptr
, struct mbuf
*mbuf_ptr
,
235 char *frame_ptr
, void *if_proto_ptr
);
237 int (*if_event
)(struct ifnet
*ifnet_ptr
, caddr_t event_ptr
);
239 int (*if_framer
)(struct ifnet
*ifp
,
241 struct sockaddr
*dest
,
245 u_long if_family
; /* ulong assigned by Apple */
246 struct tailq_head if_flt_head
;
248 /* End DLIL specific */
250 void *reserved0
; /* for future use */
251 void *if_private
; /* private to interface */
252 long if_eflags
; /* autoaddr, autoaddr done, etc. */
253 #endif /* __APPLE__ */
255 struct ifmultihead if_multiaddrs
; /* multicast addresses configured */
256 int if_amcount
; /* number of all-multicast requests */
257 /* procedure handles */
259 int (*if_output
) /* output routine (enqueue) */
260 __P((struct ifnet
*, struct mbuf
*, struct sockaddr
*,
262 void (*if_start
) /* initiate output routine */
263 __P((struct ifnet
*));
264 int (*if_done
) /* output complete routine */
265 __P((struct ifnet
*)); /* (XXX not used; fake prototype) */
266 int (*if_ioctl
) /* ioctl routine */
267 __P((struct ifnet
*, u_long
, caddr_t
));
268 void (*if_watchdog
) /* timer routine */
269 __P((struct ifnet
*));
271 int (*if_poll_recv
) /* polled receive routine */
272 __P((struct ifnet
*, int *));
273 int (*if_poll_xmit
) /* polled transmit routine */
274 __P((struct ifnet
*, int *));
275 void (*if_poll_intren
) /* polled interrupt reenable routine */
276 __P((struct ifnet
*));
277 void (*if_poll_slowinput
) /* input routine for slow devices */
278 __P((struct ifnet
*, struct mbuf
*));
279 void (*if_init
) /* Init routine */
281 int (*if_resolvemulti
) /* validate/resolve multicast */
282 __P((struct ifnet
*, struct sockaddr
**, struct sockaddr
*));
283 struct ifqueue if_snd
; /* output queue */
284 struct ifqueue
*if_poll_slowq
; /* input queue for slow devices */
286 u_long family_cookie
;
287 struct ifprefixhead if_prefixhead
; /* list of prefixes per if */
288 void *reserved1
; /* for future use */
290 struct ifprefixhead if_prefixhead
; /* list of prefixes per if */
291 #endif /* __APPLE__ */
293 typedef void if_init_f_t
__P((void *));
295 #define if_mtu if_data.ifi_mtu
296 #define if_type if_data.ifi_type
297 #define if_typelen if_data.ifi_typelen
298 #define if_physical if_data.ifi_physical
299 #define if_addrlen if_data.ifi_addrlen
300 #define if_hdrlen if_data.ifi_hdrlen
301 #define if_metric if_data.ifi_metric
302 #define if_baudrate if_data.ifi_baudrate
303 #define if_hwassist if_data.ifi_hwassist
304 #define if_ipackets if_data.ifi_ipackets
305 #define if_ierrors if_data.ifi_ierrors
306 #define if_opackets if_data.ifi_opackets
307 #define if_oerrors if_data.ifi_oerrors
308 #define if_collisions if_data.ifi_collisions
309 #define if_ibytes if_data.ifi_ibytes
310 #define if_obytes if_data.ifi_obytes
311 #define if_imcasts if_data.ifi_imcasts
312 #define if_omcasts if_data.ifi_omcasts
313 #define if_iqdrops if_data.ifi_iqdrops
314 #define if_noproto if_data.ifi_noproto
315 #define if_lastchange if_data.ifi_lastchange
316 #define if_recvquota if_data.ifi_recvquota
317 #define if_xmitquota if_data.ifi_xmitquota
318 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0)
321 /* for compatibility with other BSDs */
322 #define if_addrlist if_addrhead
323 #define if_list if_link
327 * Bit values in if_ipending
329 #define IFI_RECV 1 /* I want to receive */
330 #define IFI_XMIT 2 /* I want to transmit */
333 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
334 * are queues of messages stored on ifqueue structures
335 * (defined above). Entries are added to and deleted from these structures
336 * by these macros, which should be called with ipl raised to splimp().
338 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
339 #define IF_DROP(ifq) ((ifq)->ifq_drops++)
340 #define IF_ENQUEUE(ifq, m) { \
341 (m)->m_nextpkt = 0; \
342 if ((ifq)->ifq_tail == 0) \
343 (ifq)->ifq_head = m; \
345 (ifq)->ifq_tail->m_nextpkt = m; \
346 (ifq)->ifq_tail = m; \
349 #define IF_PREPEND(ifq, m) { \
350 (m)->m_nextpkt = (ifq)->ifq_head; \
351 if ((ifq)->ifq_tail == 0) \
352 (ifq)->ifq_tail = (m); \
353 (ifq)->ifq_head = (m); \
356 #define IF_DEQUEUE(ifq, m) { \
357 (m) = (ifq)->ifq_head; \
359 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
360 (ifq)->ifq_tail = 0; \
361 (m)->m_nextpkt = 0; \
367 #define IF_ENQ_DROP(ifq, m) if_enq_drop(ifq, m)
369 #if defined(__GNUC__) && defined(MT_HEADER)
371 if_queue_drop(struct ifqueue
*ifq
, struct mbuf
*m
)
378 if_enq_drop(struct ifqueue
*ifq
, struct mbuf
*m
)
381 !if_queue_drop(ifq
, m
))
389 int if_enq_drop
__P((struct ifqueue
*, struct mbuf
*));
393 #endif /* __APPLE_API_UNSTABLE */
396 * 72 was chosen below because it is the size of a TCP/IP
397 * header (40) + the minimum mss (32).
400 #define IF_MAXMTU 65535
404 #ifdef __APPLE_API_UNSTABLE
406 * The ifaddr structure contains information about one address
407 * of an interface. They are maintained by the different address families,
408 * are allocated and attached when an address is set, and are linked
409 * together so all addresses for an interface can be located.
412 struct sockaddr
*ifa_addr
; /* address of interface */
413 struct sockaddr
*ifa_dstaddr
; /* other end of p-to-p link */
414 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
415 struct sockaddr
*ifa_netmask
; /* used to determine subnet */
417 /* Use of if_data doesn't justify change of API */
418 struct if_data if_data
; /* not all members are meaningful */
420 struct ifnet
*ifa_ifp
; /* back-pointer to interface */
421 TAILQ_ENTRY(ifaddr
) ifa_link
; /* queue macro glue */
422 void (*ifa_rtrequest
) /* check or clean routes (+ or -)'d */
423 __P((int, struct rtentry
*, struct sockaddr
*));
424 u_short ifa_flags
; /* mostly rt_flags for cloning */
425 short ifa_refcnt
;/* 16bit ref count, use ifaref, ifafree */
426 int ifa_metric
; /* cost of going out this interface */
428 struct rtentry
*ifa_rt
; /* XXXX for ROUTETOIF ????? */
431 int (*ifa_claim_addr
) /* check if an addr goes to this if */
432 __P((struct ifaddr
*, struct sockaddr
*));
434 #define IFA_ROUTE RTF_UP /* route installed */
437 * The prefix structure contains information about one prefix
438 * of an interface. They are maintained by the different address families,
439 * are allocated and attached when an prefix or an address is set,
440 * and are linked together so all prefixes for an interface can be located.
443 struct sockaddr
*ifpr_prefix
; /* prefix of interface */
444 struct ifnet
*ifpr_ifp
; /* back-pointer to interface */
445 TAILQ_ENTRY(ifprefix
) ifpr_list
; /* queue macro glue */
446 u_char ifpr_plen
; /* prefix length in bits */
447 u_char ifpr_type
; /* protocol dependent prefix type */
451 * Multicast address structure. This is analogous to the ifaddr
452 * structure except that it keeps track of multicast addresses.
453 * Also, the reference count here is a count of requests for this
454 * address, not a count of pointers to this structure.
457 LIST_ENTRY(ifmultiaddr
) ifma_link
; /* queue macro glue */
458 struct sockaddr
*ifma_addr
; /* address this membership is for */
459 struct sockaddr
*ifma_lladdr
; /* link-layer translation, if any */
460 struct ifnet
*ifma_ifp
; /* back-pointer to interface */
461 u_int ifma_refcount
; /* reference count */
462 void *ifma_protospec
; /* protocol-specific state, if any */
466 #define IFAREF(ifa) ifaref(ifa)
467 #define IFAFREE(ifa) ifafree(ifa)
469 #ifdef __APPLE_API_PRIVATE
470 extern struct ifnethead ifnet
;
471 extern struct ifnet
**ifindex2ifnet
;
472 extern int ifqmaxlen
;
473 extern struct ifnet loif
[];
475 extern struct ifaddr
**ifnet_addrs
;
476 #endif /* __APPLE_API_PRIVATE */
479 void ether_ifattach
__P((struct ifnet
*, int));
480 void ether_ifdetach
__P((struct ifnet
*, int));
481 void ether_input
__P((struct ifnet
*, struct ether_header
*, struct mbuf
*));
482 void ether_demux
__P((struct ifnet
*, struct ether_header
*, struct mbuf
*));
483 int ether_output
__P((struct ifnet
*,
484 struct mbuf
*, struct sockaddr
*, struct rtentry
*));
485 int ether_output_frame
__P((struct ifnet
*, struct mbuf
*));
486 int ether_ioctl
__P((struct ifnet
*, int, caddr_t
));
489 int if_addmulti
__P((struct ifnet
*, struct sockaddr
*,
490 struct ifmultiaddr
**));
491 int if_allmulti
__P((struct ifnet
*, int));
492 void if_attach
__P((struct ifnet
*));
493 int if_delmulti
__P((struct ifnet
*, struct sockaddr
*));
494 void if_down
__P((struct ifnet
*));
495 void if_route
__P((struct ifnet
*, int flag
, int fam
));
496 void if_unroute
__P((struct ifnet
*, int flag
, int fam
));
497 void if_up
__P((struct ifnet
*));
498 /*void ifinit __P((void));*/ /* declared in systm.h for main() */
499 int ifioctl
__P((struct socket
*, u_long
, caddr_t
, struct proc
*));
500 int ifpromisc
__P((struct ifnet
*, int));
501 struct ifnet
*ifunit
__P((const char *));
502 struct ifnet
*if_withname
__P((struct sockaddr
*));
504 int if_poll_recv_slow
__P((struct ifnet
*ifp
, int *quotap
));
505 void if_poll_xmit_slow
__P((struct ifnet
*ifp
, int *quotap
));
506 void if_poll_throttle
__P((void));
507 void if_poll_unthrottle
__P((void *));
508 void if_poll_init
__P((void));
509 void if_poll
__P((void));
511 struct ifaddr
*ifa_ifwithaddr
__P((struct sockaddr
*));
512 struct ifaddr
*ifa_ifwithdstaddr
__P((struct sockaddr
*));
513 struct ifaddr
*ifa_ifwithnet
__P((struct sockaddr
*));
514 struct ifaddr
*ifa_ifwithroute
__P((int, struct sockaddr
*,
516 struct ifaddr
*ifaof_ifpforaddr
__P((struct sockaddr
*, struct ifnet
*));
517 void ifafree
__P((struct ifaddr
*));
518 void ifaref
__P((struct ifaddr
*));
520 struct ifmultiaddr
*ifmaof_ifpforaddr
__P((struct sockaddr
*,
523 int if_simloop
__P((struct ifnet
*ifp
, struct mbuf
*m
,
524 struct sockaddr
*dst
, int hlen
));
530 #endif /* __APPLE_API_UNSTABLE */
531 #endif /* !_NET_IF_VAR_H_ */