2 * Copyright (c) 2000-2011 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
29 * Copyright (c) 1985, 1986, 1993
30 * The Regents of the University of California. All rights reserved.
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
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.
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
60 * @(#)in_var.h 8.2 (Berkeley) 1/9/95
61 * $FreeBSD: src/sys/netinet/in_var.h,v 1.33.2.2 2001/07/17 10:50:01 ru Exp $
64 #ifndef _NETINET_IN_VAR_H_
65 #define _NETINET_IN_VAR_H_
66 #include <sys/appleapiopts.h>
68 #include <sys/queue.h>
70 #include <sys/kern_event.h>
73 #ifdef XNU_KERNEL_PRIVATE
74 #include <net/route.h>
77 * Interface address, Internet version. One of these structures
78 * is allocated for each Internet address on an interface.
79 * The ifaddr structure contains the protocol-independent part
80 * of the structure and is assumed to be first.
83 struct ifaddr ia_ifa
; /* protocol-independent info */
84 #define ia_ifp ia_ifa.ifa_ifp
85 #define ia_flags ia_ifa.ifa_flags
86 /* ia_{,sub}net{,mask} in host order */
87 u_int32_t ia_net
; /* network number of interface */
88 u_int32_t ia_netmask
; /* mask of net part */
89 u_int32_t ia_subnet
; /* subnet number, including net */
90 u_int32_t ia_subnetmask
; /* mask of subnet part */
91 struct in_addr ia_netbroadcast
; /* to recognize net broadcasts */
92 TAILQ_ENTRY(in_ifaddr
) ia_link
; /* tailq macro glue */
93 struct sockaddr_in ia_addr
; /* reserve space for interface name */
94 struct sockaddr_in ia_dstaddr
; /* reserve space for broadcast addr */
95 #define ia_broadaddr ia_dstaddr
96 struct sockaddr_in ia_sockmask
; /* reserve space for general netmask */
97 TAILQ_ENTRY(in_ifaddr
) ia_hash
; /* hash bucket entry */
100 #define ifatoia(ifa) ((struct in_ifaddr *)(void *)(ifa))
101 #endif /* XNU_KERNEL_PRIVATE */
104 char ifra_name
[IFNAMSIZ
]; /* if name, e.g. "en0" */
105 struct sockaddr_in ifra_addr
;
106 struct sockaddr_in ifra_broadaddr
;
107 #define ifra_dstaddr ifra_broadaddr
108 struct sockaddr_in ifra_mask
;
109 u_int32_t ifra_unused
; /* not used: used to be 'dlt' */
113 * Event data, internet style.
116 struct net_event_data link_data
;
117 struct in_addr ia_addr
;
118 u_int32_t ia_net
; /* network number of interface */
119 u_int32_t ia_netmask
; /* mask of net part */
120 u_int32_t ia_subnet
; /* subnet number, including net */
121 u_int32_t ia_subnetmask
; /* mask of subnet part */
122 struct in_addr ia_netbroadcast
;/* to recognize net broadcasts */
123 struct in_addr ia_dstaddr
;
126 struct kev_in_collision
{
127 struct net_event_data link_data
; /* link colliding arp was received on */
128 struct in_addr ia_ipaddr
; /* IP address we and another node are using */
129 u_char hw_len
; /* length of hardware address */
130 u_char hw_addr
[0]; /* variable length hardware address */
133 #ifdef __APPLE_API_PRIVATE
134 struct kev_in_portinuse
{
135 u_int16_t port
; /* conflicting port number in host order */
136 u_int32_t req_pid
; /* PID port requestor */
137 u_int32_t reserved
[2];
143 * Define inet event subclass and specific inet events.
146 #define KEV_INET_SUBCLASS 1
148 #define KEV_INET_NEW_ADDR 1
149 #define KEV_INET_CHANGED_ADDR 2
150 #define KEV_INET_ADDR_DELETED 3
151 #define KEV_INET_SIFDSTADDR 4
152 #define KEV_INET_SIFBRDADDR 5
153 #define KEV_INET_SIFNETMASK 6
154 #define KEV_INET_ARPCOLLISION 7 /* use kev_in_collision */
156 #ifdef __APPLE_API_PRIVATE
157 #define KEV_INET_PORTINUSE 8 /* use ken_in_portinuse */
160 #ifdef XNU_KERNEL_PRIVATE
161 #include <net/if_var.h>
162 #include <kern/locks.h>
163 #include <sys/tree.h>
165 * Given a pointer to an in_ifaddr (ifaddr),
166 * return a pointer to the addr as a sockaddr_in.
168 #define IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
169 #define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))
171 #define IN_LNAOF(in, ifa) \
172 ((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
175 * Hash table for IPv4 addresses.
177 __private_extern__
TAILQ_HEAD(in_ifaddrhead
, in_ifaddr
) in_ifaddrhead
;
178 __private_extern__
TAILQ_HEAD(in_ifaddrhashhead
, in_ifaddr
) *in_ifaddrhashtbl
;
179 __private_extern__ lck_rw_t
*in_ifaddr_rwlock
;
181 #define INADDR_HASH(x) (&in_ifaddrhashtbl[inaddr_hashval(x)])
183 extern struct ifqueue ipintrq
; /* ip packet input queue */
184 extern struct in_addr zeroin_addr
;
185 extern u_char inetctlerrmap
[];
187 extern int apple_hwcksum_tx
;
188 extern int apple_hwcksum_rx
;
191 * Macro for finding the interface (ifnet structure) corresponding to one
192 * of our IP addresses.
194 #define INADDR_TO_IFP(addr, ifp) \
195 /* struct in_addr addr; */ \
196 /* struct ifnet *ifp; */ \
198 struct in_ifaddr *ia; \
200 lck_rw_lock_shared(in_ifaddr_rwlock); \
201 TAILQ_FOREACH(ia, INADDR_HASH((addr).s_addr), ia_hash) { \
202 IFA_LOCK_SPIN(&ia->ia_ifa); \
203 if (IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) { \
204 IFA_UNLOCK(&ia->ia_ifa); \
207 IFA_UNLOCK(&ia->ia_ifa); \
209 (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
210 lck_rw_done(in_ifaddr_rwlock); \
214 * Macro for finding the internet address structure (in_ifaddr) corresponding
215 * to a given interface (ifnet structure). Caller is responsible for freeing
218 #define IFP_TO_IA(ifp, ia) \
219 /* struct ifnet *ifp; */ \
220 /* struct in_ifaddr *ia; */ \
222 lck_rw_lock_shared(in_ifaddr_rwlock); \
223 for ((ia) = TAILQ_FIRST(&in_ifaddrhead); \
224 (ia) != NULL && (ia)->ia_ifp != (ifp); \
225 (ia) = TAILQ_NEXT((ia), ia_link)) \
228 IFA_ADDREF(&(ia)->ia_ifa); \
229 lck_rw_done(in_ifaddr_rwlock); \
233 * This information should be part of the ifnet structure but we don't wish
234 * to change that - as it might break a number of things
238 * Legacy IPv4 IGMP per-link structure.
241 struct ifnet
*rti_ifp
;
242 int rti_type
; /* type of router which is querier on this interface */
243 int rti_time
; /* # of slow timeouts since last old query */
244 SLIST_ENTRY(router_info
) rti_list
;
248 * IPv4 multicast IGMP-layer source entry.
251 RB_ENTRY(ip_msource
) ims_link
; /* RB tree links */
252 in_addr_t ims_haddr
; /* host byte order */
254 uint16_t ex
; /* # of exclusive members */
255 uint16_t in
; /* # of inclusive members */
256 } ims_st
[2]; /* state at t0, t1 */
257 uint8_t ims_stp
; /* pending query */
261 * IPv4 multicast PCB-layer source entry.
264 RB_ENTRY(ip_msource
) ims_link
; /* RB tree links */
265 in_addr_t ims_haddr
; /* host byte order */
266 uint8_t imsl_st
[2]; /* state before/at commit */
269 RB_HEAD(ip_msource_tree
, ip_msource
); /* define struct ip_msource_tree */
271 RB_PROTOTYPE_SC_PREV(__private_extern__
, ip_msource_tree
, ip_msource
,
272 ims_link
, ip_msource_cmp
);
275 * IPv4 multicast PCB-layer group filter descriptor.
278 struct ip_msource_tree imf_sources
; /* source list for (S,G) */
279 u_long imf_nsrc
; /* # of source entries */
280 uint8_t imf_st
[2]; /* state before/at commit */
286 * IPv4 group descriptor.
288 * For every entry on an ifnet's if_multiaddrs list which represents
289 * an IP multicast group, there is one of these structures.
291 * If any source filters are present, then a node will exist in the RB-tree
292 * to permit fast lookup by source whenever an operation takes place.
293 * This permits pre-order traversal when we issue reports.
294 * Source filter trees are kept separately from the socket layer to
295 * greatly simplify locking.
297 * When IGMPv3 is active, inm_timer is the response to group query timer.
298 * The state-change timer inm_sctimer is separate; whenever state changes
299 * for the group the state change record is generated and transmitted,
300 * and kept if retransmissions are necessary.
302 * FUTURE: inm_link is now only used when groups are being purged
303 * on a detaching ifnet. It could be demoted to a SLIST_ENTRY, but
304 * because it is at the very start of the struct, we can't do this
305 * w/o breaking the ABI for ifmcstat.
308 decl_lck_mtx_data(, inm_lock
);
309 u_int32_t inm_refcount
; /* reference count */
310 u_int32_t inm_reqcnt
; /* request count for this address */
311 u_int32_t inm_debug
; /* see ifa_debug flags */
312 LIST_ENTRY(in_multi
) inm_link
; /* queue macro glue */
313 struct in_addr inm_addr
; /* IP multicast address, convenience */
314 struct ifnet
*inm_ifp
; /* back pointer to ifnet */
315 struct ifmultiaddr
*inm_ifma
; /* back pointer to ifmultiaddr */
316 u_int inm_timer
; /* IGMPv1/v2 group / v3 query timer */
317 u_int inm_state
; /* state of the membership */
318 void *inm_rti
; /* unused, legacy field */
320 /* New fields for IGMPv3 follow. */
321 struct igmp_ifinfo
*inm_igi
; /* IGMP info */
322 SLIST_ENTRY(in_multi
) inm_dtle
; /* detached waiting for rele */
323 SLIST_ENTRY(in_multi
) inm_nrele
; /* to-be-released by IGMP */
324 u_int32_t inm_nrelecnt
; /* deferred release count */
325 struct ip_msource_tree inm_srcs
; /* tree of sources */
326 u_long inm_nsrc
; /* # of tree entries */
328 struct ifqueue inm_scq
; /* queue of pending
329 * state-change packets */
330 struct timeval inm_lastgsrtv
; /* Time of last G-S-R query */
331 uint16_t inm_sctimer
; /* state-change timer */
332 uint16_t inm_scrv
; /* state-change rexmit count */
335 * SSM state counters which track state at T0 (the time the last
336 * state-change report's RV timer went to zero) and T1
337 * (time of pending report, i.e. now).
338 * Used for computing IGMPv3 state-change reports. Several refcounts
339 * are maintained here to optimize for common use-cases.
342 uint16_t iss_fmode
; /* IGMP filter mode */
343 uint16_t iss_asm
; /* # of ASM listeners */
344 uint16_t iss_ex
; /* # of exclusive members */
345 uint16_t iss_in
; /* # of inclusive members */
346 uint16_t iss_rec
; /* # of recorded sources */
347 } inm_st
[2]; /* state at t0, t1 */
349 void (*inm_trace
) /* callback fn for tracing refs */
350 (struct in_multi
*, int);
353 #define INM_LOCK_ASSERT_HELD(_inm) \
354 lck_mtx_assert(&(_inm)->inm_lock, LCK_MTX_ASSERT_OWNED)
356 #define INM_LOCK_ASSERT_NOTHELD(_inm) \
357 lck_mtx_assert(&(_inm)->inm_lock, LCK_MTX_ASSERT_NOTOWNED)
359 #define INM_LOCK(_inm) \
360 lck_mtx_lock(&(_inm)->inm_lock)
362 #define INM_LOCK_SPIN(_inm) \
363 lck_mtx_lock_spin(&(_inm)->inm_lock)
365 #define INM_CONVERT_LOCK(_inm) do { \
366 INM_LOCK_ASSERT_HELD(_inm); \
367 lck_mtx_convert_spin(&(_inm)->inm_lock); \
370 #define INM_UNLOCK(_inm) \
371 lck_mtx_unlock(&(_inm)->inm_lock)
373 #define INM_ADDREF(_inm) \
376 #define INM_ADDREF_LOCKED(_inm) \
379 #define INM_REMREF(_inm) \
382 #define INM_REMREF_LOCKED(_inm) \
386 SYSCTL_DECL(_net_inet_ip
);
387 SYSCTL_DECL(_net_inet_raw
);
390 extern LIST_HEAD(in_multihead
, in_multi
) in_multihead
;
393 * Structure used by macros below to remember position when stepping through
394 * all of the in_multi records.
396 struct in_multistep
{
397 struct in_multi
*i_inm
;
401 * Macro for looking up the in_multi record for a given IP multicast address
402 * on a given interface. If no matching record is found, "inm" is set null.
404 * We do this differently compared other BSD implementations; instead of
405 * walking the if_multiaddrs list at the interface and returning the
406 * ifma_protospec value of a matching entry, we search the global list
407 * of in_multi records and find it that way. Otherwise either the two
408 * structures (in_multi, ifmultiaddr) need to be ref counted both ways,
409 * which will make things too complicated, or they need to reside in the
410 * same protected domain, which they aren't.
412 * Must be called with in_multihead_lock held.
414 #define IN_LOOKUP_MULTI(addr, ifp, inm) \
415 /* struct in_addr *addr; */ \
416 /* struct ifnet *ifp; */ \
417 /* struct in_multi *inm; */ \
419 struct in_multistep _step; \
420 IN_FIRST_MULTI(_step, inm); \
421 while ((inm) != NULL) { \
422 INM_LOCK_SPIN(inm); \
423 if ((inm)->inm_ifp == (ifp) && \
424 (inm)->inm_addr.s_addr == (addr)->s_addr) { \
425 INM_ADDREF_LOCKED(inm); \
430 IN_NEXT_MULTI(_step, inm); \
435 * Macro to step through all of the in_multi records, one at a time.
436 * The current position is remembered in "step", which the caller must
437 * provide. IN_FIRST_MULTI(), below, must be called to initialize "step"
438 * and get the first record. Both macros return a NULL "inm" when there
439 * are no remaining records.
441 * Must be called with in_multihead_lock held.
443 #define IN_NEXT_MULTI(step, inm) \
444 /* struct in_multistep step; */ \
445 /* struct in_multi *inm; */ \
447 in_multihead_lock_assert(LCK_RW_ASSERT_HELD); \
448 if (((inm) = (step).i_inm) != NULL) \
449 (step).i_inm = LIST_NEXT((step).i_inm, inm_link); \
452 #define IN_FIRST_MULTI(step, inm) \
453 /* struct in_multistep step; */ \
454 /* struct in_multi *inm; */ \
456 in_multihead_lock_assert(LCK_RW_ASSERT_HELD); \
457 (step).i_inm = LIST_FIRST(&in_multihead); \
458 IN_NEXT_MULTI((step), (inm)); \
466 * Return values for imo_multi_filter().
468 #define MCAST_PASS 0 /* Pass */
469 #define MCAST_NOTGMEMBER 1 /* This host not a member of group */
470 #define MCAST_NOTSMEMBER 2 /* This host excluded source */
471 #define MCAST_MUTED 3 /* [deprecated] */
473 extern void in_ifaddr_init(void);
474 extern int imo_multi_filter(const struct ip_moptions
*, const struct ifnet
*,
475 const struct sockaddr
*, const struct sockaddr
*);
476 extern int imo_clone(struct inpcb
*, struct inpcb
*);
477 extern void inm_commit(struct in_multi
*);
478 extern void inm_clear_recorded(struct in_multi
*);
479 extern void inm_print(const struct in_multi
*);
480 extern int inm_record_source(struct in_multi
*inm
, const in_addr_t
);
481 extern void inm_release(struct in_multi
*);
482 extern void in_multi_init(void);
483 extern struct in_multi
*in_addmulti(struct in_addr
*, struct ifnet
*);
484 extern void in_delmulti(struct in_multi
*);
485 extern int in_leavegroup(struct in_multi
*, /*const*/ struct in_mfilter
*);
486 extern int in_multi_detach(struct in_multi
*);
487 extern void inm_addref(struct in_multi
*, int);
488 extern void inm_remref(struct in_multi
*, int);
489 extern void inm_purge(struct in_multi
*);
490 extern uint8_t ims_get_mode(const struct in_multi
*,
491 const struct ip_msource
*, uint8_t);
492 extern int in_control(struct socket
*, u_long
, caddr_t
, struct ifnet
*,
494 extern void in_rtqdrain(void);
495 extern struct radix_node
*in_validate(struct radix_node
*);
496 extern void ip_input(struct mbuf
*);
497 extern int in_ifadown(struct ifaddr
*ifa
, int);
498 extern void in_ifscrub(struct ifnet
*, struct in_ifaddr
*, int);
499 extern u_int32_t
inaddr_hashval(u_int32_t
);
500 extern void in_purgeaddrs(struct ifnet
*);
501 extern void imf_leave(struct in_mfilter
*);
502 extern void imf_purge(struct in_mfilter
*);
504 __private_extern__
int inp_join_group(struct inpcb
*, struct sockopt
*);
505 __private_extern__
int inp_leave_group(struct inpcb
*, struct sockopt
*);
506 __private_extern__
void in_multihead_lock_exclusive(void);
507 __private_extern__
void in_multihead_lock_shared(void);
508 __private_extern__
void in_multihead_lock_assert(int);
509 __private_extern__
void in_multihead_lock_done(void);
510 #endif /* XNU_KERNEL_PRIVATE */
513 #include <netinet6/in6_var.h>
515 #endif /* _NETINET_IN_VAR_H_ */