]> git.saurik.com Git - apple/xnu.git/blob - bsd/net/if_var.h
xnu-344.23.tar.gz
[apple/xnu.git] / bsd / net / if_var.h
1 /*
2 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * The contents of this file constitute Original Code as defined in and
7 * are subject to the Apple Public Source License Version 1.1 (the
8 * "License"). You may not use this file except in compliance with the
9 * License. Please obtain a copy of the License at
10 * http://www.apple.com/publicsource and read it before using this file.
11 *
12 * This Original Code and all software distributed under the License are
13 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
14 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
15 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
17 * License for the specific language governing rights and limitations
18 * under the License.
19 *
20 * @APPLE_LICENSE_HEADER_END@
21 */
22 /*
23 * Copyright (c) 1982, 1986, 1989, 1993
24 * The Regents of the University of California. All rights reserved.
25 *
26 * Redistribution and use in source and binary forms, with or without
27 * modification, are permitted provided that the following conditions
28 * are met:
29 * 1. Redistributions of source code must retain the above copyright
30 * notice, this list of conditions and the following disclaimer.
31 * 2. Redistributions in binary form must reproduce the above copyright
32 * notice, this list of conditions and the following disclaimer in the
33 * documentation and/or other materials provided with the distribution.
34 * 3. All advertising materials mentioning features or use of this software
35 * must display the following acknowledgement:
36 * This product includes software developed by the University of
37 * California, Berkeley and its contributors.
38 * 4. Neither the name of the University nor the names of its contributors
39 * may be used to endorse or promote products derived from this software
40 * without specific prior written permission.
41 *
42 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
43 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
46 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
48 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
49 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
50 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
51 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 *
54 * From: @(#)if.h 8.1 (Berkeley) 6/10/93
55 * $FreeBSD: src/sys/net/if_var.h,v 1.18.2.7 2001/07/24 19:10:18 brooks Exp $
56 */
57
58 #ifndef _NET_IF_VAR_H_
59 #define _NET_IF_VAR_H_
60 #include <sys/appleapiopts.h>
61
62 #ifdef __APPLE__
63 #define APPLE_IF_FAM_LOOPBACK 1
64 #define APPLE_IF_FAM_ETHERNET 2
65 #define APPLE_IF_FAM_SLIP 3
66 #define APPLE_IF_FAM_TUN 4
67 #define APPLE_IF_FAM_VLAN 5
68 #define APPLE_IF_FAM_PPP 6
69 #define APPLE_IF_FAM_PVC 7
70 #define APPLE_IF_FAM_DISC 8
71 #define APPLE_IF_FAM_MDECAP 9
72 #define APPLE_IF_FAM_GIF 10
73 #define APPLE_IF_FAM_FAITH 11
74 #define APPLE_IF_FAM_STF 12
75 #endif
76
77 /*
78 * Structures defining a network interface, providing a packet
79 * transport mechanism (ala level 0 of the PUP protocols).
80 *
81 * Each interface accepts output datagrams of a specified maximum
82 * length, and provides higher level routines with input datagrams
83 * received from its medium.
84 *
85 * Output occurs when the routine if_output is called, with three parameters:
86 * (*ifp->if_output)(ifp, m, dst, rt)
87 * Here m is the mbuf chain to be sent and dst is the destination address.
88 * The output routine encapsulates the supplied datagram if necessary,
89 * and then transmits it on its medium.
90 *
91 * On input, each interface unwraps the data received by it, and either
92 * places it on the input queue of a internetwork datagram routine
93 * and posts the associated software interrupt, or passes the datagram to a raw
94 * packet input routine.
95 *
96 * Routines exist for locating interfaces by their addresses
97 * or for locating a interface on a certain network, as well as more general
98 * routing and gateway routines maintaining information used to locate
99 * interfaces. These routines live in the files if.c and route.c
100 */
101
102 #ifdef __STDC__
103 /*
104 * Forward structure declarations for function prototypes [sic].
105 */
106 struct mbuf;
107 struct proc;
108 struct rtentry;
109 struct socket;
110 struct ether_header;
111 struct sockaddr_dl;
112 #endif
113
114 #define IFNAMSIZ 16
115
116 #include <sys/queue.h> /* get TAILQ macros */
117
118 #ifdef __APPLE_API_UNSTABLE
119 #ifdef __APPLE__
120 struct tqdummy;
121
122 TAILQ_HEAD(tailq_head, tqdummy);
123
124 /* This belongs up in socket.h or socketvar.h, depending on how far the
125 * event bubbles up.
126 */
127
128 struct net_event_data {
129 u_long if_family;
130 u_long if_unit;
131 char if_name[IFNAMSIZ];
132 };
133 #endif
134
135
136 TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */
137 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */
138 TAILQ_HEAD(ifprefixhead, ifprefix);
139 LIST_HEAD(ifmultihead, ifmultiaddr);
140
141 #ifdef __APPLE__
142 /*
143 * Structure describing information about an interface
144 * which may be of interest to management entities.
145 */
146 struct if_data {
147 /* generic interface information */
148 u_char ifi_type; /* ethernet, tokenring, etc */
149 #ifdef __APPLE__
150 u_char ifi_typelen; /* Length of frame type id */
151 #endif
152 u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */
153 u_char ifi_addrlen; /* media address length */
154 u_char ifi_hdrlen; /* media header length */
155 u_char ifi_recvquota; /* polling quota for receive intrs */
156 u_char ifi_xmitquota; /* polling quota for xmit intrs */
157 u_long ifi_mtu; /* maximum transmission unit */
158 u_long ifi_metric; /* routing metric (external only) */
159 u_long ifi_baudrate; /* linespeed */
160 /* volatile statistics */
161 u_long ifi_ipackets; /* packets received on interface */
162 u_long ifi_ierrors; /* input errors on interface */
163 u_long ifi_opackets; /* packets sent on interface */
164 u_long ifi_oerrors; /* output errors on interface */
165 u_long ifi_collisions; /* collisions on csma interfaces */
166 u_long ifi_ibytes; /* total number of octets received */
167 u_long ifi_obytes; /* total number of octets sent */
168 u_long ifi_imcasts; /* packets received via multicast */
169 u_long ifi_omcasts; /* packets sent via multicast */
170 u_long ifi_iqdrops; /* dropped on input, this interface */
171 u_long ifi_noproto; /* destined for unsupported protocol */
172 #ifdef __APPLE__
173 u_long ifi_recvtiming; /* usec spent receiving when timing */
174 u_long ifi_xmittiming; /* usec spent xmitting when timing */
175 #endif
176 struct timeval ifi_lastchange; /* time of last administrative change */
177 #ifdef __APPLE__
178 u_long default_proto; /* Default dl_tag when none is specified
179 * on dlil_output */
180 #endif
181 u_long ifi_hwassist; /* HW offload capabilities */
182 u_long ifi_reserved1; /* for future use */
183 u_long ifi_reserved2; /* for future use */
184 };
185 #endif
186
187 /*
188 * Structure defining a queue for a network interface.
189 */
190 struct ifqueue {
191 struct mbuf *ifq_head;
192 struct mbuf *ifq_tail;
193 int ifq_len;
194 int ifq_maxlen;
195 int ifq_drops;
196 };
197
198 /*
199 * Structure defining a network interface.
200 *
201 * (Would like to call this struct ``if'', but C isn't PL/1.)
202 */
203 struct ifnet {
204 void *if_softc; /* pointer to driver state */
205 char *if_name; /* name, e.g. ``en'' or ``lo'' */
206 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */
207 struct ifaddrhead if_addrhead; /* linked list of addresses per if */
208 #ifdef __APPLE__
209 struct tailq_head proto_head; /* Head for if_proto structures */
210 #endif
211 int if_pcount; /* number of promiscuous listeners */
212 struct bpf_if *if_bpf; /* packet filter structure */
213 u_short if_index; /* numeric abbreviation for this if */
214 short if_unit; /* sub-unit for lower level driver */
215 short if_timer; /* time 'til if_watchdog called */
216 short if_flags; /* up/down, broadcast, etc. */
217 int if_ipending; /* interrupts pending */
218 void *if_linkmib; /* link-type-specific MIB data */
219 size_t if_linkmiblen; /* length of above data */
220 struct if_data if_data;
221
222 #ifdef __APPLE__
223 /* New with DLIL */
224 int refcnt;
225 int offercnt;
226 int (*if_output)(struct ifnet *ifnet_ptr, struct mbuf *m);
227 int (*if_ioctl)(struct ifnet *ifnet_ptr, u_long ioctl_code, void *ioctl_arg);
228 int (*if_set_bpf_tap)(struct ifnet *ifp, int mode,
229 int (*bpf_callback)(struct ifnet *, struct mbuf *));
230 int (*if_free)(struct ifnet *ifnet_ptr);
231 int (*if_demux)(struct ifnet *ifnet_ptr, struct mbuf *mbuf_ptr,
232 char *frame_ptr, void *if_proto_ptr);
233
234 int (*if_event)(struct ifnet *ifnet_ptr, caddr_t event_ptr);
235
236 int (*if_framer)(struct ifnet *ifp,
237 struct mbuf **m,
238 struct sockaddr *dest,
239 char *dest_linkaddr,
240 char *frame_type);
241
242 u_long if_family; /* ulong assigned by Apple */
243 struct tailq_head if_flt_head;
244
245 /* End DLIL specific */
246
247 void *reserved0; /* for future use */
248 void *if_private; /* private to interface */
249 long if_eflags; /* autoaddr, autoaddr done, etc. */
250 #endif /* __APPLE__ */
251
252 struct ifmultihead if_multiaddrs; /* multicast addresses configured */
253 int if_amcount; /* number of all-multicast requests */
254 /* procedure handles */
255 #ifndef __APPLE__
256 int (*if_output) /* output routine (enqueue) */
257 __P((struct ifnet *, struct mbuf *, struct sockaddr *,
258 struct rtentry *));
259 void (*if_start) /* initiate output routine */
260 __P((struct ifnet *));
261 int (*if_done) /* output complete routine */
262 __P((struct ifnet *)); /* (XXX not used; fake prototype) */
263 int (*if_ioctl) /* ioctl routine */
264 __P((struct ifnet *, u_long, caddr_t));
265 void (*if_watchdog) /* timer routine */
266 __P((struct ifnet *));
267 #endif
268 int (*if_poll_recv) /* polled receive routine */
269 __P((struct ifnet *, int *));
270 int (*if_poll_xmit) /* polled transmit routine */
271 __P((struct ifnet *, int *));
272 void (*if_poll_intren) /* polled interrupt reenable routine */
273 __P((struct ifnet *));
274 void (*if_poll_slowinput) /* input routine for slow devices */
275 __P((struct ifnet *, struct mbuf *));
276 void (*if_init) /* Init routine */
277 __P((void *));
278 int (*if_resolvemulti) /* validate/resolve multicast */
279 __P((struct ifnet *, struct sockaddr **, struct sockaddr *));
280 struct ifqueue if_snd; /* output queue */
281 struct ifqueue *if_poll_slowq; /* input queue for slow devices */
282 #ifdef __APPLE__
283 u_long family_cookie;
284 struct ifprefixhead if_prefixhead; /* list of prefixes per if */
285 void *reserved1; /* for future use */
286 #else
287 struct ifprefixhead if_prefixhead; /* list of prefixes per if */
288 #endif /* __APPLE__ */
289 };
290 typedef void if_init_f_t __P((void *));
291
292 #define if_mtu if_data.ifi_mtu
293 #define if_type if_data.ifi_type
294 #define if_typelen if_data.ifi_typelen
295 #define if_physical if_data.ifi_physical
296 #define if_addrlen if_data.ifi_addrlen
297 #define if_hdrlen if_data.ifi_hdrlen
298 #define if_metric if_data.ifi_metric
299 #define if_baudrate if_data.ifi_baudrate
300 #define if_hwassist if_data.ifi_hwassist
301 #define if_ipackets if_data.ifi_ipackets
302 #define if_ierrors if_data.ifi_ierrors
303 #define if_opackets if_data.ifi_opackets
304 #define if_oerrors if_data.ifi_oerrors
305 #define if_collisions if_data.ifi_collisions
306 #define if_ibytes if_data.ifi_ibytes
307 #define if_obytes if_data.ifi_obytes
308 #define if_imcasts if_data.ifi_imcasts
309 #define if_omcasts if_data.ifi_omcasts
310 #define if_iqdrops if_data.ifi_iqdrops
311 #define if_noproto if_data.ifi_noproto
312 #define if_lastchange if_data.ifi_lastchange
313 #define if_recvquota if_data.ifi_recvquota
314 #define if_xmitquota if_data.ifi_xmitquota
315 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0)
316
317 #ifndef __APPLE__
318 /* for compatibility with other BSDs */
319 #define if_addrlist if_addrhead
320 #define if_list if_link
321 #endif
322
323 /*
324 * Bit values in if_ipending
325 */
326 #define IFI_RECV 1 /* I want to receive */
327 #define IFI_XMIT 2 /* I want to transmit */
328
329 /*
330 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
331 * are queues of messages stored on ifqueue structures
332 * (defined above). Entries are added to and deleted from these structures
333 * by these macros, which should be called with ipl raised to splimp().
334 */
335 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
336 #define IF_DROP(ifq) ((ifq)->ifq_drops++)
337 #define IF_ENQUEUE(ifq, m) { \
338 (m)->m_nextpkt = 0; \
339 if ((ifq)->ifq_tail == 0) \
340 (ifq)->ifq_head = m; \
341 else \
342 (ifq)->ifq_tail->m_nextpkt = m; \
343 (ifq)->ifq_tail = m; \
344 (ifq)->ifq_len++; \
345 }
346 #define IF_PREPEND(ifq, m) { \
347 (m)->m_nextpkt = (ifq)->ifq_head; \
348 if ((ifq)->ifq_tail == 0) \
349 (ifq)->ifq_tail = (m); \
350 (ifq)->ifq_head = (m); \
351 (ifq)->ifq_len++; \
352 }
353 #define IF_DEQUEUE(ifq, m) { \
354 (m) = (ifq)->ifq_head; \
355 if (m) { \
356 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
357 (ifq)->ifq_tail = 0; \
358 (m)->m_nextpkt = 0; \
359 (ifq)->ifq_len--; \
360 } \
361 }
362
363 #ifdef KERNEL
364 #define IF_ENQ_DROP(ifq, m) if_enq_drop(ifq, m)
365
366 #if defined(__GNUC__) && defined(MT_HEADER)
367 static __inline int
368 if_queue_drop(struct ifqueue *ifq, struct mbuf *m)
369 {
370 IF_DROP(ifq);
371 return 0;
372 }
373
374 static __inline int
375 if_enq_drop(struct ifqueue *ifq, struct mbuf *m)
376 {
377 if (IF_QFULL(ifq) &&
378 !if_queue_drop(ifq, m))
379 return 0;
380 IF_ENQUEUE(ifq, m);
381 return 1;
382 }
383 #else
384
385 #ifdef MT_HEADER
386 int if_enq_drop __P((struct ifqueue *, struct mbuf *));
387 #endif
388
389 #endif
390 #endif /* __APPLE_API_UNSTABLE */
391
392 /*
393 * 72 was chosen below because it is the size of a TCP/IP
394 * header (40) + the minimum mss (32).
395 */
396 #define IF_MINMTU 72
397 #define IF_MAXMTU 65535
398
399 #endif /* KERNEL */
400
401 #ifdef __APPLE_API_UNSTABLE
402 /*
403 * The ifaddr structure contains information about one address
404 * of an interface. They are maintained by the different address families,
405 * are allocated and attached when an address is set, and are linked
406 * together so all addresses for an interface can be located.
407 */
408 struct ifaddr {
409 struct sockaddr *ifa_addr; /* address of interface */
410 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
411 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
412 struct sockaddr *ifa_netmask; /* used to determine subnet */
413 #ifndef __APPLE__
414 /* Use of if_data doesn't justify change of API */
415 struct if_data if_data; /* not all members are meaningful */
416 #endif
417 struct ifnet *ifa_ifp; /* back-pointer to interface */
418 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */
419 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
420 __P((int, struct rtentry *, struct sockaddr *));
421 u_short ifa_flags; /* mostly rt_flags for cloning */
422 short ifa_refcnt;/* 16bit ref count, use ifaref, ifafree */
423 int ifa_metric; /* cost of going out this interface */
424 #ifdef notdef
425 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */
426 #endif
427 u_long ifa_dlt;
428 int (*ifa_claim_addr) /* check if an addr goes to this if */
429 __P((struct ifaddr *, struct sockaddr *));
430 };
431 #define IFA_ROUTE RTF_UP /* route installed */
432
433 /*
434 * The prefix structure contains information about one prefix
435 * of an interface. They are maintained by the different address families,
436 * are allocated and attached when an prefix or an address is set,
437 * and are linked together so all prefixes for an interface can be located.
438 */
439 struct ifprefix {
440 struct sockaddr *ifpr_prefix; /* prefix of interface */
441 struct ifnet *ifpr_ifp; /* back-pointer to interface */
442 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
443 u_char ifpr_plen; /* prefix length in bits */
444 u_char ifpr_type; /* protocol dependent prefix type */
445 };
446
447 /*
448 * Multicast address structure. This is analogous to the ifaddr
449 * structure except that it keeps track of multicast addresses.
450 * Also, the reference count here is a count of requests for this
451 * address, not a count of pointers to this structure.
452 */
453 struct ifmultiaddr {
454 LIST_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
455 struct sockaddr *ifma_addr; /* address this membership is for */
456 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */
457 struct ifnet *ifma_ifp; /* back-pointer to interface */
458 u_int ifma_refcount; /* reference count */
459 void *ifma_protospec; /* protocol-specific state, if any */
460 };
461
462 #ifdef KERNEL
463 #define IFAREF(ifa) ifaref(ifa)
464 #define IFAFREE(ifa) ifafree(ifa)
465
466 #ifdef __APPLE_API_PRIVATE
467 extern struct ifnethead ifnet;
468 extern struct ifnet **ifindex2ifnet;
469 extern int ifqmaxlen;
470 extern struct ifnet loif[];
471 extern int if_index;
472 extern struct ifaddr **ifnet_addrs;
473 #endif /* __APPLE_API_PRIVATE */
474
475 #ifndef __APPLE__
476 void ether_ifattach __P((struct ifnet *, int));
477 void ether_ifdetach __P((struct ifnet *, int));
478 void ether_input __P((struct ifnet *, struct ether_header *, struct mbuf *));
479 void ether_demux __P((struct ifnet *, struct ether_header *, struct mbuf *));
480 int ether_output __P((struct ifnet *,
481 struct mbuf *, struct sockaddr *, struct rtentry *));
482 int ether_output_frame __P((struct ifnet *, struct mbuf *));
483 int ether_ioctl __P((struct ifnet *, int, caddr_t));
484 #endif
485
486 int if_addmulti __P((struct ifnet *, struct sockaddr *,
487 struct ifmultiaddr **));
488 int if_allmulti __P((struct ifnet *, int));
489 void if_attach __P((struct ifnet *));
490 int if_delmulti __P((struct ifnet *, struct sockaddr *));
491 void if_down __P((struct ifnet *));
492 void if_route __P((struct ifnet *, int flag, int fam));
493 void if_unroute __P((struct ifnet *, int flag, int fam));
494 void if_up __P((struct ifnet *));
495 /*void ifinit __P((void));*/ /* declared in systm.h for main() */
496 int ifioctl __P((struct socket *, u_long, caddr_t, struct proc *));
497 int ifpromisc __P((struct ifnet *, int));
498 struct ifnet *ifunit __P((const char *));
499 struct ifnet *if_withname __P((struct sockaddr *));
500
501 int if_poll_recv_slow __P((struct ifnet *ifp, int *quotap));
502 void if_poll_xmit_slow __P((struct ifnet *ifp, int *quotap));
503 void if_poll_throttle __P((void));
504 void if_poll_unthrottle __P((void *));
505 void if_poll_init __P((void));
506 void if_poll __P((void));
507
508 struct ifaddr *ifa_ifwithaddr __P((struct sockaddr *));
509 struct ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *));
510 struct ifaddr *ifa_ifwithnet __P((struct sockaddr *));
511 struct ifaddr *ifa_ifwithroute __P((int, struct sockaddr *,
512 struct sockaddr *));
513 struct ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *));
514 void ifafree __P((struct ifaddr *));
515 void ifaref __P((struct ifaddr *));
516
517 struct ifmultiaddr *ifmaof_ifpforaddr __P((struct sockaddr *,
518 struct ifnet *));
519 #ifndef __APPLE__
520 int if_simloop __P((struct ifnet *ifp, struct mbuf *m,
521 struct sockaddr *dst, int hlen));
522 #endif
523
524 #endif /* KERNEL */
525
526
527 #endif /* __APPLE_API_UNSTABLE */
528 #endif /* !_NET_IF_VAR_H_ */