]> git.saurik.com Git - apple/xnu.git/blob - bsd/net/if_var.h
xnu-792.17.14.tar.gz
[apple/xnu.git] / bsd / net / if_var.h
1 /*
2 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28 /*
29 * Copyright (c) 1982, 1986, 1989, 1993
30 * The Regents of the University of California. All rights reserved.
31 *
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
34 * are met:
35 * 1. Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * 2. Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in the
39 * documentation and/or other materials provided with the distribution.
40 * 3. All advertising materials mentioning features or use of this software
41 * must display the following acknowledgement:
42 * This product includes software developed by the University of
43 * California, Berkeley and its contributors.
44 * 4. Neither the name of the University nor the names of its contributors
45 * may be used to endorse or promote products derived from this software
46 * without specific prior written permission.
47 *
48 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58 * SUCH DAMAGE.
59 *
60 * From: @(#)if.h 8.1 (Berkeley) 6/10/93
61 * $FreeBSD: src/sys/net/if_var.h,v 1.18.2.7 2001/07/24 19:10:18 brooks Exp $
62 */
63
64 #ifndef _NET_IF_VAR_H_
65 #define _NET_IF_VAR_H_
66
67 #include <sys/appleapiopts.h>
68 #include <sys/types.h>
69 #include <sys/time.h>
70 #include <sys/queue.h> /* get TAILQ macros */
71 #ifdef KERNEL_PRIVATE
72 #include <kern/locks.h>
73 #endif /* KERNEL_PRIVATE */
74
75 #ifdef KERNEL
76 #include <net/kpi_interface.h>
77 #endif KERNEL
78
79 #ifdef __APPLE__
80 #define APPLE_IF_FAM_LOOPBACK 1
81 #define APPLE_IF_FAM_ETHERNET 2
82 #define APPLE_IF_FAM_SLIP 3
83 #define APPLE_IF_FAM_TUN 4
84 #define APPLE_IF_FAM_VLAN 5
85 #define APPLE_IF_FAM_PPP 6
86 #define APPLE_IF_FAM_PVC 7
87 #define APPLE_IF_FAM_DISC 8
88 #define APPLE_IF_FAM_MDECAP 9
89 #define APPLE_IF_FAM_GIF 10
90 #define APPLE_IF_FAM_FAITH 11
91 #define APPLE_IF_FAM_STF 12
92 #define APPLE_IF_FAM_FIREWIRE 13
93 #define APPLE_IF_FAM_BOND 14
94 #endif __APPLE__
95
96 /*
97 * 72 was chosen below because it is the size of a TCP/IP
98 * header (40) + the minimum mss (32).
99 */
100 #define IF_MINMTU 72
101 #define IF_MAXMTU 65535
102
103 /*
104 * Structures defining a network interface, providing a packet
105 * transport mechanism (ala level 0 of the PUP protocols).
106 *
107 * Each interface accepts output datagrams of a specified maximum
108 * length, and provides higher level routines with input datagrams
109 * received from its medium.
110 *
111 * Output occurs when the routine if_output is called, with three parameters:
112 * (*ifp->if_output)(ifp, m, dst, rt)
113 * Here m is the mbuf chain to be sent and dst is the destination address.
114 * The output routine encapsulates the supplied datagram if necessary,
115 * and then transmits it on its medium.
116 *
117 * On input, each interface unwraps the data received by it, and either
118 * places it on the input queue of a internetwork datagram routine
119 * and posts the associated software interrupt, or passes the datagram to a raw
120 * packet input routine.
121 *
122 * Routines exist for locating interfaces by their addresses
123 * or for locating a interface on a certain network, as well as more general
124 * routing and gateway routines maintaining information used to locate
125 * interfaces. These routines live in the files if.c and route.c
126 */
127
128 #define IFNAMSIZ 16
129
130 /* This belongs up in socket.h or socketvar.h, depending on how far the
131 * event bubbles up.
132 */
133
134 struct net_event_data {
135 unsigned long if_family;
136 unsigned long if_unit;
137 char if_name[IFNAMSIZ];
138 };
139
140 /*
141 * Structure describing information about an interface
142 * which may be of interest to management entities.
143 */
144 struct if_data {
145 /* generic interface information */
146 unsigned char ifi_type; /* ethernet, tokenring, etc */
147 #ifdef __APPLE__
148 unsigned char ifi_typelen; /* Length of frame type id */
149 #endif
150 unsigned char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */
151 unsigned char ifi_addrlen; /* media address length */
152 unsigned char ifi_hdrlen; /* media header length */
153 unsigned char ifi_recvquota; /* polling quota for receive intrs */
154 unsigned char ifi_xmitquota; /* polling quota for xmit intrs */
155 unsigned char ifi_unused1; /* for future use */
156 unsigned long ifi_mtu; /* maximum transmission unit */
157 unsigned long ifi_metric; /* routing metric (external only) */
158 unsigned long ifi_baudrate; /* linespeed */
159 /* volatile statistics */
160 unsigned long ifi_ipackets; /* packets received on interface */
161 unsigned long ifi_ierrors; /* input errors on interface */
162 unsigned long ifi_opackets; /* packets sent on interface */
163 unsigned long ifi_oerrors; /* output errors on interface */
164 unsigned long ifi_collisions; /* collisions on csma interfaces */
165 unsigned long ifi_ibytes; /* total number of octets received */
166 unsigned long ifi_obytes; /* total number of octets sent */
167 unsigned long ifi_imcasts; /* packets received via multicast */
168 unsigned long ifi_omcasts; /* packets sent via multicast */
169 unsigned long ifi_iqdrops; /* dropped on input, this interface */
170 unsigned long ifi_noproto; /* destined for unsupported protocol */
171 unsigned long ifi_recvtiming; /* usec spent receiving when timing */
172 unsigned long ifi_xmittiming; /* usec spent xmitting when timing */
173 struct timeval ifi_lastchange; /* time of last administrative change */
174 unsigned long ifi_unused2; /* used to be the default_proto */
175 unsigned long ifi_hwassist; /* HW offload capabilities */
176 unsigned long ifi_reserved1; /* for future use */
177 unsigned long ifi_reserved2; /* for future use */
178 };
179
180 /*
181 * Structure describing information about an interface
182 * which may be of interest to management entities.
183 */
184 struct if_data64 {
185 /* generic interface information */
186 u_char ifi_type; /* ethernet, tokenring, etc */
187 #ifdef __APPLE__
188 u_char ifi_typelen; /* Length of frame type id */
189 #endif
190 u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */
191 u_char ifi_addrlen; /* media address length */
192 u_char ifi_hdrlen; /* media header length */
193 u_char ifi_recvquota; /* polling quota for receive intrs */
194 u_char ifi_xmitquota; /* polling quota for xmit intrs */
195 u_char ifi_unused1; /* for future use */
196 u_long ifi_mtu; /* maximum transmission unit */
197 u_long ifi_metric; /* routing metric (external only) */
198 u_int64_t ifi_baudrate; /* linespeed */
199 /* volatile statistics */
200 u_int64_t ifi_ipackets; /* packets received on interface */
201 u_int64_t ifi_ierrors; /* input errors on interface */
202 u_int64_t ifi_opackets; /* packets sent on interface */
203 u_int64_t ifi_oerrors; /* output errors on interface */
204 u_int64_t ifi_collisions; /* collisions on csma interfaces */
205 u_int64_t ifi_ibytes; /* total number of octets received */
206 u_int64_t ifi_obytes; /* total number of octets sent */
207 u_int64_t ifi_imcasts; /* packets received via multicast */
208 u_int64_t ifi_omcasts; /* packets sent via multicast */
209 u_int64_t ifi_iqdrops; /* dropped on input, this interface */
210 u_int64_t ifi_noproto; /* destined for unsupported protocol */
211 u_long ifi_recvtiming; /* usec spent receiving when timing */
212 u_long ifi_xmittiming; /* usec spent xmitting when timing */
213 struct timeval ifi_lastchange; /* time of last administrative change */
214 };
215
216 #ifdef PRIVATE
217 /*
218 * Internal storage of if_data. This is bound to change. Various places in the
219 * stack will translate this data structure in to the externally visible
220 * if_data structure above.
221 */
222 struct if_data_internal {
223 /* generic interface information */
224 u_char ifi_type; /* ethernet, tokenring, etc */
225 u_char ifi_typelen; /* Length of frame type id */
226 u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */
227 u_char ifi_addrlen; /* media address length */
228 u_char ifi_hdrlen; /* media header length */
229 u_char ifi_recvquota; /* polling quota for receive intrs */
230 u_char ifi_xmitquota; /* polling quota for xmit intrs */
231 u_char ifi_unused1; /* for future use */
232 u_long ifi_mtu; /* maximum transmission unit */
233 u_long ifi_metric; /* routing metric (external only) */
234 u_long ifi_baudrate; /* linespeed */
235 /* volatile statistics */
236 u_int64_t ifi_ipackets; /* packets received on interface */
237 u_int64_t ifi_ierrors; /* input errors on interface */
238 u_int64_t ifi_opackets; /* packets sent on interface */
239 u_int64_t ifi_oerrors; /* output errors on interface */
240 u_int64_t ifi_collisions; /* collisions on csma interfaces */
241 u_int64_t ifi_ibytes; /* total number of octets received */
242 u_int64_t ifi_obytes; /* total number of octets sent */
243 u_int64_t ifi_imcasts; /* packets received via multicast */
244 u_int64_t ifi_omcasts; /* packets sent via multicast */
245 u_int64_t ifi_iqdrops; /* dropped on input, this interface */
246 u_int64_t ifi_noproto; /* destined for unsupported protocol */
247 u_long ifi_recvtiming; /* usec spent receiving when timing */
248 u_long ifi_xmittiming; /* usec spent xmitting when timing */
249 #define IF_LASTCHANGEUPTIME 1 /* lastchange: 1-uptime 0-calendar time */
250 struct timeval ifi_lastchange; /* time of last administrative change */
251 u_long ifi_hwassist; /* HW offload capabilities */
252 };
253
254 #define if_mtu if_data.ifi_mtu
255 #define if_type if_data.ifi_type
256 #define if_typelen if_data.ifi_typelen
257 #define if_physical if_data.ifi_physical
258 #define if_addrlen if_data.ifi_addrlen
259 #define if_hdrlen if_data.ifi_hdrlen
260 #define if_metric if_data.ifi_metric
261 #define if_baudrate if_data.ifi_baudrate
262 #define if_hwassist if_data.ifi_hwassist
263 #define if_ipackets if_data.ifi_ipackets
264 #define if_ierrors if_data.ifi_ierrors
265 #define if_opackets if_data.ifi_opackets
266 #define if_oerrors if_data.ifi_oerrors
267 #define if_collisions if_data.ifi_collisions
268 #define if_ibytes if_data.ifi_ibytes
269 #define if_obytes if_data.ifi_obytes
270 #define if_imcasts if_data.ifi_imcasts
271 #define if_omcasts if_data.ifi_omcasts
272 #define if_iqdrops if_data.ifi_iqdrops
273 #define if_noproto if_data.ifi_noproto
274 #define if_lastchange if_data.ifi_lastchange
275 #define if_recvquota if_data.ifi_recvquota
276 #define if_xmitquota if_data.ifi_xmitquota
277 #define if_iflags if_data.ifi_iflags
278
279 struct mbuf;
280 struct ifaddr;
281 TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */
282 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */
283 TAILQ_HEAD(ifprefixhead, ifprefix);
284 LIST_HEAD(ifmultihead, ifmultiaddr);
285 struct tqdummy;
286 TAILQ_HEAD(tailq_head, tqdummy);
287
288 /*
289 * Forward structure declarations for function prototypes [sic].
290 */
291 struct proc;
292 struct rtentry;
293 struct socket;
294 struct ether_header;
295 struct sockaddr_dl;
296 struct ifnet_filter;
297
298 TAILQ_HEAD(ifnet_filter_head, ifnet_filter);
299 TAILQ_HEAD(ddesc_head_name, dlil_demux_desc);
300
301 /* bottom 16 bits reserved for hardware checksum */
302 #define IF_HWASSIST_CSUM_IP 0x0001 /* will csum IP */
303 #define IF_HWASSIST_CSUM_TCP 0x0002 /* will csum TCP */
304 #define IF_HWASSIST_CSUM_UDP 0x0004 /* will csum UDP */
305 #define IF_HWASSIST_CSUM_IP_FRAGS 0x0008 /* will csum IP fragments */
306 #define IF_HWASSIST_CSUM_FRAGMENT 0x0010 /* will do IP fragmentation */
307 #define IF_HWASSIST_CSUM_TCP_SUM16 0x1000 /* simple TCP Sum16 computation */
308 #define IF_HWASSIST_CSUM_MASK 0xffff
309 #define IF_HWASSIST_CSUM_FLAGS(hwassist) ((hwassist) & IF_HWASSIST_CSUM_MASK)
310
311 /* VLAN support */
312 #define IF_HWASSIST_VLAN_TAGGING 0x10000 /* supports VLAN tagging */
313 #define IF_HWASSIST_VLAN_MTU 0x20000 /* supports VLAN MTU-sized packet (for software VLAN) */
314
315 #define IFNET_RW_LOCK 1
316
317 /*
318 * Structure defining a queue for a network interface.
319 */
320 struct ifqueue {
321 void *ifq_head;
322 void *ifq_tail;
323 int ifq_len;
324 int ifq_maxlen;
325 int ifq_drops;
326 };
327
328 struct ddesc_head_str;
329 struct proto_hash_entry;
330 struct kev_msg;
331
332 /*
333 * Structure defining a network interface.
334 *
335 * (Would like to call this struct ``if'', but C isn't PL/1.)
336 */
337 struct ifnet {
338 void *if_softc; /* pointer to driver state */
339 const char *if_name; /* name, e.g. ``en'' or ``lo'' */
340 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */
341 struct ifaddrhead if_addrhead; /* linked list of addresses per if */
342 u_long if_refcnt;
343 #ifdef __KPI_INTERFACE__
344 ifnet_check_multi if_check_multi;
345 #else
346 void* if_check_multi;
347 #endif __KPI_INTERFACE__
348 int if_pcount; /* number of promiscuous listeners */
349 struct bpf_if *if_bpf; /* packet filter structure */
350 u_short if_index; /* numeric abbreviation for this if */
351 short if_unit; /* sub-unit for lower level driver */
352 short if_timer; /* time 'til if_watchdog called */
353 short if_flags; /* up/down, broadcast, etc. */
354 int if_ipending; /* interrupts pending */
355 void *if_linkmib; /* link-type-specific MIB data */
356 size_t if_linkmiblen; /* length of above data */
357 struct if_data_internal if_data;
358
359 /* New with DLIL */
360 #ifdef BSD_KERNEL_PRIVATE
361 int if_usecnt;
362 #else
363 int refcnt;
364 #endif
365 int offercnt;
366 #ifdef __KPI_INTERFACE__
367 ifnet_output_func if_output;
368 ifnet_ioctl_func if_ioctl;
369 ifnet_set_bpf_tap if_set_bpf_tap;
370 ifnet_detached_func if_free;
371 ifnet_demux_func if_demux;
372 ifnet_event_func if_event;
373 ifnet_framer_func if_framer;
374 ifnet_family_t if_family; /* ulong assigned by Apple */
375 #else
376 void* if_output;
377 void* if_ioctl;
378 void* if_set_bpf_tap;
379 void* if_free;
380 void* if_demux;
381 void* if_event;
382 void* if_framer;
383 u_long if_family; /* ulong assigned by Apple */
384 #endif
385
386 struct ifnet_filter_head if_flt_head;
387
388 /* End DLIL specific */
389
390 u_long if_delayed_detach; /* need to perform delayed detach */
391 void *if_private; /* private to interface */
392 long if_eflags; /* autoaddr, autoaddr done, etc. */
393
394 struct ifmultihead if_multiaddrs; /* multicast addresses configured */
395 int if_amcount; /* number of all-multicast requests */
396 /* procedure handles */
397 #ifdef __KPI_INTERFACE__
398 union {
399 int (*original)(struct ifnet *ifp, u_long protocol_family,
400 struct ddesc_head_str *demux_desc_head);
401 ifnet_add_proto_func kpi;
402 } if_add_proto_u;
403 ifnet_del_proto_func if_del_proto;
404 #else __KPI_INTERFACE__
405 void* if_add_proto;
406 void* if_del_proto;
407 #endif __KPI_INTERFACE__
408 struct proto_hash_entry *if_proto_hash;
409 void *if_kpi_storage;
410
411 void *unused_was_init;
412 void *unused_was_resolvemulti;
413
414 struct ifqueue if_snd;
415 u_long unused_2[1];
416 #ifdef __APPLE__
417 u_long family_cookie;
418 struct ifprefixhead if_prefixhead; /* list of prefixes per if */
419
420 #ifdef _KERN_LOCKS_H_
421 #if IFNET_RW_LOCK
422 lck_rw_t *if_lock; /* Lock to protect this interface */
423 #else
424 lck_mtx_t *if_lock; /* Lock to protect this interface */
425 #endif
426 #else
427 void *if_lock;
428 #endif
429
430 #else
431 struct ifprefixhead if_prefixhead; /* list of prefixes per if */
432 #endif /* __APPLE__ */
433 struct {
434 u_long length;
435 union {
436 u_char buffer[8];
437 u_char *ptr;
438 } u;
439 } if_broadcast;
440 };
441
442 #define if_add_proto if_add_proto_u.original
443
444 #ifndef __APPLE__
445 /* for compatibility with other BSDs */
446 #define if_addrlist if_addrhead
447 #define if_list if_link
448 #endif !__APPLE__
449
450
451 #endif /* PRIVATE */
452
453 #ifdef KERNEL_PRIVATE
454 /*
455 * Structure describing a `cloning' interface.
456 */
457 struct if_clone {
458 LIST_ENTRY(if_clone) ifc_list; /* on list of cloners */
459 const char *ifc_name; /* name of device, e.g. `vlan' */
460 size_t ifc_namelen; /* length of name */
461 int ifc_minifs; /* minimum number of interfaces */
462 int ifc_maxunit; /* maximum unit number */
463 unsigned char *ifc_units; /* bitmap to handle units */
464 int ifc_bmlen; /* bitmap length */
465
466 int (*ifc_create)(struct if_clone *, int);
467 void (*ifc_destroy)(struct ifnet *);
468 };
469
470 #define IF_CLONE_INITIALIZER(name, create, destroy, minifs, maxunit) \
471 { { 0, 0 }, name, sizeof(name) - 1, minifs, maxunit, NULL, 0, create, destroy }
472
473 /*
474 * Bit values in if_ipending
475 */
476 #define IFI_RECV 1 /* I want to receive */
477 #define IFI_XMIT 2 /* I want to transmit */
478
479 /*
480 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
481 * are queues of messages stored on ifqueue structures
482 * (defined above). Entries are added to and deleted from these structures
483 * by these macros, which should be called with ipl raised to splimp().
484 */
485 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
486 #define IF_DROP(ifq) ((ifq)->ifq_drops++)
487 #define IF_ENQUEUE(ifq, m) { \
488 (m)->m_nextpkt = 0; \
489 if ((ifq)->ifq_tail == 0) \
490 (ifq)->ifq_head = m; \
491 else \
492 ((struct mbuf*)(ifq)->ifq_tail)->m_nextpkt = m; \
493 (ifq)->ifq_tail = m; \
494 (ifq)->ifq_len++; \
495 }
496 #define IF_PREPEND(ifq, m) { \
497 (m)->m_nextpkt = (ifq)->ifq_head; \
498 if ((ifq)->ifq_tail == 0) \
499 (ifq)->ifq_tail = (m); \
500 (ifq)->ifq_head = (m); \
501 (ifq)->ifq_len++; \
502 }
503 #define IF_DEQUEUE(ifq, m) { \
504 (m) = (ifq)->ifq_head; \
505 if (m) { \
506 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
507 (ifq)->ifq_tail = 0; \
508 (m)->m_nextpkt = 0; \
509 (ifq)->ifq_len--; \
510 } \
511 }
512
513 #define IF_ENQ_DROP(ifq, m) if_enq_drop(ifq, m)
514
515 #if defined(__GNUC__) && defined(MT_HEADER)
516 static __inline int
517 if_queue_drop(struct ifqueue *ifq, __unused struct mbuf *m)
518 {
519 IF_DROP(ifq);
520 return 0;
521 }
522
523 static __inline int
524 if_enq_drop(struct ifqueue *ifq, struct mbuf *m)
525 {
526 if (IF_QFULL(ifq) &&
527 !if_queue_drop(ifq, m))
528 return 0;
529 IF_ENQUEUE(ifq, m);
530 return 1;
531 }
532 #else
533
534 #ifdef MT_HEADER
535 int if_enq_drop(struct ifqueue *, struct mbuf *);
536 #endif MT_HEADER
537
538 #endif defined(__GNUC__) && defined(MT_HEADER)
539
540 #endif /* KERNEL_PRIVATE */
541
542
543 #ifdef PRIVATE
544 /*
545 * The ifaddr structure contains information about one address
546 * of an interface. They are maintained by the different address families,
547 * are allocated and attached when an address is set, and are linked
548 * together so all addresses for an interface can be located.
549 */
550 struct ifaddr {
551 struct sockaddr *ifa_addr; /* address of interface */
552 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */
553 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */
554 struct sockaddr *ifa_netmask; /* used to determine subnet */
555 struct ifnet *ifa_ifp; /* back-pointer to interface */
556 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */
557 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */
558 (int, struct rtentry *, struct sockaddr *);
559 u_short ifa_flags; /* mostly rt_flags for cloning */
560 int ifa_refcnt;/* 32bit ref count, use ifaref, ifafree */
561 int ifa_metric; /* cost of going out this interface */
562 #ifdef notdef
563 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */
564 #endif
565 int (*ifa_claim_addr) /* check if an addr goes to this if */
566 (struct ifaddr *, const struct sockaddr *);
567 u_long ifa_debug; /* debug flags */
568 };
569 #define IFA_ROUTE RTF_UP /* route installed (0x1) */
570 #define IFA_CLONING RTF_CLONING /* (0x100) */
571 #define IFA_ATTACHED 0x1 /* ifa_debug: IFA is attached to an interface */
572
573 #endif /* PRIVATE */
574
575 #ifdef KERNEL_PRIVATE
576 /*
577 * The prefix structure contains information about one prefix
578 * of an interface. They are maintained by the different address families,
579 * are allocated and attached when an prefix or an address is set,
580 * and are linked together so all prefixes for an interface can be located.
581 */
582 struct ifprefix {
583 struct sockaddr *ifpr_prefix; /* prefix of interface */
584 struct ifnet *ifpr_ifp; /* back-pointer to interface */
585 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
586 u_char ifpr_plen; /* prefix length in bits */
587 u_char ifpr_type; /* protocol dependent prefix type */
588 };
589 #endif /* KERNEL_PRIVATE */
590
591 #ifdef PRIVATE
592 typedef void (*ifma_protospec_free_func)(void* ifma_protospec);
593
594 /*
595 * Multicast address structure. This is analogous to the ifaddr
596 * structure except that it keeps track of multicast addresses.
597 * Also, the reference count here is a count of requests for this
598 * address, not a count of pointers to this structure.
599 */
600 struct ifmultiaddr {
601 LIST_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
602 struct sockaddr *ifma_addr; /* address this membership is for */
603 struct ifmultiaddr *ifma_ll; /* link-layer translation, if any */
604 struct ifnet *ifma_ifp; /* back-pointer to interface */
605 u_int ifma_usecount; /* use count, protected by ifp's lock */
606 void *ifma_protospec; /* protocol-specific state, if any */
607 int32_t ifma_refcount; /* reference count, atomically protected */
608 ifma_protospec_free_func ifma_free; /* function called to free ifma_protospec */
609 };
610 #endif /* PRIVATE */
611
612 #ifdef KERNEL_PRIVATE
613 #define IFAREF(ifa) ifaref(ifa)
614 #define IFAFREE(ifa) ifafree(ifa)
615
616 /*
617 * To preserve kmem compatibility, we define
618 * ifnet_head to ifnet. This should be temp.
619 */
620 #define ifnet_head ifnet
621 extern struct ifnethead ifnet_head;
622 extern struct ifnet **ifindex2ifnet;
623 extern int ifqmaxlen;
624 extern struct ifnet loif[];
625 extern int if_index;
626 extern struct ifaddr **ifnet_addrs;
627 extern struct ifnet *lo_ifp;
628
629 int if_addmulti(struct ifnet *, const struct sockaddr *, struct ifmultiaddr **);
630 int if_allmulti(struct ifnet *, int);
631 void if_attach(struct ifnet *);
632 int if_delmultiaddr(struct ifmultiaddr *ifma, int locked);
633 int if_delmulti(struct ifnet *, const struct sockaddr *);
634 void if_down(struct ifnet *);
635 void if_route(struct ifnet *, int flag, int fam);
636 void if_unroute(struct ifnet *, int flag, int fam);
637 void if_up(struct ifnet *);
638 void if_updown(struct ifnet *ifp, int up);
639 /*void ifinit(void));*/ /* declared in systm.h for main( */
640 int ifioctl(struct socket *, u_long, caddr_t, struct proc *);
641 int ifioctllocked(struct socket *, u_long, caddr_t, struct proc *);
642 struct ifnet *ifunit(const char *);
643 struct ifnet *if_withname(struct sockaddr *);
644
645 void if_clone_attach(struct if_clone *);
646 void if_clone_detach(struct if_clone *);
647
648 void ifnet_lock_assert(struct ifnet *ifp, int what);
649 void ifnet_lock_shared(struct ifnet *ifp);
650 void ifnet_lock_exclusive(struct ifnet *ifp);
651 void ifnet_lock_done(struct ifnet *ifp);
652
653 void ifnet_head_lock_shared(void);
654 void ifnet_head_lock_exclusive(void);
655 void ifnet_head_done(void);
656
657 void if_attach_ifa(struct ifnet * ifp, struct ifaddr *ifa);
658 void if_detach_ifa(struct ifnet * ifp, struct ifaddr *ifa);
659
660 void ifma_reference(struct ifmultiaddr *ifma);
661 void ifma_release(struct ifmultiaddr *ifma);
662
663 struct ifaddr *ifa_ifwithaddr(const struct sockaddr *);
664 struct ifaddr *ifa_ifwithdstaddr(const struct sockaddr *);
665 struct ifaddr *ifa_ifwithnet(const struct sockaddr *);
666 struct ifaddr *ifa_ifwithroute(int, const struct sockaddr *, const struct sockaddr *);
667 struct ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *);
668 void ifafree(struct ifaddr *);
669 void ifaref(struct ifaddr *);
670
671 struct ifmultiaddr *ifmaof_ifpforaddr(const struct sockaddr *, struct ifnet *);
672
673 #ifdef BSD_KERNEL_PRIVATE
674 void if_data_internal_to_if_data(const struct if_data_internal *if_data_int,
675 struct if_data *if_data);
676 void if_data_internal_to_if_data64(const struct if_data_internal *if_data_int,
677 struct if_data64 *if_data64);
678 #endif /* BSD_KERNEL_PRIVATE */
679 #endif /* KERNEL_PRIVATE */
680 #endif /* !_NET_IF_VAR_H_ */