]> git.saurik.com Git - apple/xnu.git/blob - bsd/netinet/in_var.h
70a0370edd5f548201121c4f17d851cbe513e90d
[apple/xnu.git] / bsd / netinet / in_var.h
1 /*
2 * Copyright (c) 2000-2011 Apple 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) 1985, 1986, 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 * @(#)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 $
62 */
63
64 #ifndef _NETINET_IN_VAR_H_
65 #define _NETINET_IN_VAR_H_
66 #include <sys/appleapiopts.h>
67
68 #include <sys/queue.h>
69 #ifdef __APPLE__
70 #include <sys/kern_event.h>
71 #endif
72
73 #ifdef XNU_KERNEL_PRIVATE
74 #include <net/route.h>
75
76 /*
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.
81 */
82 struct in_ifaddr {
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 */
98 };
99 #endif /* XNU_KERNEL_PRIVATE */
100
101 struct in_aliasreq {
102 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
103 struct sockaddr_in ifra_addr;
104 struct sockaddr_in ifra_broadaddr;
105 #define ifra_dstaddr ifra_broadaddr
106 struct sockaddr_in ifra_mask;
107 u_int32_t ifra_unused; /* not used: used to be 'dlt' */
108 };
109
110 /*
111 * Event data, internet style.
112 */
113 struct kev_in_data {
114 struct net_event_data link_data;
115 struct in_addr ia_addr;
116 u_int32_t ia_net; /* network number of interface */
117 u_int32_t ia_netmask; /* mask of net part */
118 u_int32_t ia_subnet; /* subnet number, including net */
119 u_int32_t ia_subnetmask; /* mask of subnet part */
120 struct in_addr ia_netbroadcast;/* to recognize net broadcasts */
121 struct in_addr ia_dstaddr;
122 };
123
124 struct kev_in_collision {
125 struct net_event_data link_data; /* link colliding arp was received on */
126 struct in_addr ia_ipaddr; /* IP address we and another node are using */
127 u_char hw_len; /* length of hardware address */
128 u_char hw_addr[0]; /* variable length hardware address */
129 };
130
131 #ifdef __APPLE_API_PRIVATE
132 struct kev_in_portinuse {
133 u_int16_t port; /* conflicting port number in host order */
134 u_int32_t req_pid; /* PID port requestor */
135 u_int32_t reserved[2];
136 };
137 #endif
138
139
140 /*
141 * Define inet event subclass and specific inet events.
142 */
143
144 #define KEV_INET_SUBCLASS 1
145
146 #define KEV_INET_NEW_ADDR 1
147 #define KEV_INET_CHANGED_ADDR 2
148 #define KEV_INET_ADDR_DELETED 3
149 #define KEV_INET_SIFDSTADDR 4
150 #define KEV_INET_SIFBRDADDR 5
151 #define KEV_INET_SIFNETMASK 6
152 #define KEV_INET_ARPCOLLISION 7 /* use kev_in_collision */
153
154 #ifdef __APPLE_API_PRIVATE
155 #define KEV_INET_PORTINUSE 8 /* use ken_in_portinuse */
156 #endif
157
158 #ifdef XNU_KERNEL_PRIVATE
159 #include <net/if_var.h>
160 #include <kern/locks.h>
161 #include <sys/tree.h>
162 /*
163 * Given a pointer to an in_ifaddr (ifaddr),
164 * return a pointer to the addr as a sockaddr_in.
165 */
166 #define IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
167 #define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))
168
169 #define IN_LNAOF(in, ifa) \
170 ((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
171
172 /*
173 * Hash table for IPv4 addresses.
174 */
175 __private_extern__ TAILQ_HEAD(in_ifaddrhead, in_ifaddr) in_ifaddrhead;
176 __private_extern__ TAILQ_HEAD(in_ifaddrhashhead, in_ifaddr) *in_ifaddrhashtbl;
177 __private_extern__ lck_rw_t *in_ifaddr_rwlock;
178
179 #define INADDR_HASH(x) (&in_ifaddrhashtbl[inaddr_hashval(x)])
180
181 extern struct ifqueue ipintrq; /* ip packet input queue */
182 extern struct in_addr zeroin_addr;
183 extern u_char inetctlerrmap[];
184
185 extern int apple_hwcksum_tx;
186 extern int apple_hwcksum_rx;
187
188 /*
189 * Macro for finding the interface (ifnet structure) corresponding to one
190 * of our IP addresses.
191 */
192 #define INADDR_TO_IFP(addr, ifp) \
193 /* struct in_addr addr; */ \
194 /* struct ifnet *ifp; */ \
195 { \
196 struct in_ifaddr *ia; \
197 \
198 lck_rw_lock_shared(in_ifaddr_rwlock); \
199 TAILQ_FOREACH(ia, INADDR_HASH((addr).s_addr), ia_hash) { \
200 IFA_LOCK_SPIN(&ia->ia_ifa); \
201 if (IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) { \
202 IFA_UNLOCK(&ia->ia_ifa); \
203 break; \
204 } \
205 IFA_UNLOCK(&ia->ia_ifa); \
206 } \
207 (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
208 lck_rw_done(in_ifaddr_rwlock); \
209 }
210
211 /*
212 * Macro for finding the internet address structure (in_ifaddr) corresponding
213 * to a given interface (ifnet structure). Caller is responsible for freeing
214 * the reference.
215 */
216 #define IFP_TO_IA(ifp, ia) \
217 /* struct ifnet *ifp; */ \
218 /* struct in_ifaddr *ia; */ \
219 { \
220 lck_rw_lock_shared(in_ifaddr_rwlock); \
221 for ((ia) = TAILQ_FIRST(&in_ifaddrhead); \
222 (ia) != NULL && (ia)->ia_ifp != (ifp); \
223 (ia) = TAILQ_NEXT((ia), ia_link)) \
224 continue; \
225 if ((ia) != NULL) \
226 IFA_ADDREF(&(ia)->ia_ifa); \
227 lck_rw_done(in_ifaddr_rwlock); \
228 }
229
230 /*
231 * This information should be part of the ifnet structure but we don't wish
232 * to change that - as it might break a number of things
233 */
234
235 /*
236 * Legacy IPv4 IGMP per-link structure.
237 */
238 struct router_info {
239 struct ifnet *rti_ifp;
240 int rti_type; /* type of router which is querier on this interface */
241 int rti_time; /* # of slow timeouts since last old query */
242 SLIST_ENTRY(router_info) rti_list;
243 };
244
245 /*
246 * IPv4 multicast IGMP-layer source entry.
247 */
248 struct ip_msource {
249 RB_ENTRY(ip_msource) ims_link; /* RB tree links */
250 in_addr_t ims_haddr; /* host byte order */
251 struct ims_st {
252 uint16_t ex; /* # of exclusive members */
253 uint16_t in; /* # of inclusive members */
254 } ims_st[2]; /* state at t0, t1 */
255 uint8_t ims_stp; /* pending query */
256 };
257
258 /*
259 * IPv4 multicast PCB-layer source entry.
260 */
261 struct in_msource {
262 RB_ENTRY(ip_msource) ims_link; /* RB tree links */
263 in_addr_t ims_haddr; /* host byte order */
264 uint8_t imsl_st[2]; /* state before/at commit */
265 };
266
267 RB_HEAD(ip_msource_tree, ip_msource); /* define struct ip_msource_tree */
268
269 RB_PROTOTYPE_SC_PREV(__private_extern__, ip_msource_tree, ip_msource,
270 ims_link, ip_msource_cmp);
271
272 /*
273 * IPv4 multicast PCB-layer group filter descriptor.
274 */
275 struct in_mfilter {
276 struct ip_msource_tree imf_sources; /* source list for (S,G) */
277 u_long imf_nsrc; /* # of source entries */
278 uint8_t imf_st[2]; /* state before/at commit */
279 };
280
281 struct igmp_ifinfo;
282
283 /*
284 * IPv4 group descriptor.
285 *
286 * For every entry on an ifnet's if_multiaddrs list which represents
287 * an IP multicast group, there is one of these structures.
288 *
289 * If any source filters are present, then a node will exist in the RB-tree
290 * to permit fast lookup by source whenever an operation takes place.
291 * This permits pre-order traversal when we issue reports.
292 * Source filter trees are kept separately from the socket layer to
293 * greatly simplify locking.
294 *
295 * When IGMPv3 is active, inm_timer is the response to group query timer.
296 * The state-change timer inm_sctimer is separate; whenever state changes
297 * for the group the state change record is generated and transmitted,
298 * and kept if retransmissions are necessary.
299 *
300 * FUTURE: inm_link is now only used when groups are being purged
301 * on a detaching ifnet. It could be demoted to a SLIST_ENTRY, but
302 * because it is at the very start of the struct, we can't do this
303 * w/o breaking the ABI for ifmcstat.
304 */
305 struct in_multi {
306 decl_lck_mtx_data(, inm_lock);
307 u_int32_t inm_refcount; /* reference count */
308 u_int32_t inm_reqcnt; /* request count for this address */
309 u_int32_t inm_debug; /* see ifa_debug flags */
310 LIST_ENTRY(in_multi) inm_link; /* queue macro glue */
311 struct in_addr inm_addr; /* IP multicast address, convenience */
312 struct ifnet *inm_ifp; /* back pointer to ifnet */
313 struct ifmultiaddr *inm_ifma; /* back pointer to ifmultiaddr */
314 u_int inm_timer; /* IGMPv1/v2 group / v3 query timer */
315 u_int inm_state; /* state of the membership */
316 void *inm_rti; /* unused, legacy field */
317
318 /* New fields for IGMPv3 follow. */
319 struct igmp_ifinfo *inm_igi; /* IGMP info */
320 SLIST_ENTRY(in_multi) inm_dtle; /* detached waiting for rele */
321 SLIST_ENTRY(in_multi) inm_nrele; /* to-be-released by IGMP */
322 u_int32_t inm_nrelecnt; /* deferred release count */
323 struct ip_msource_tree inm_srcs; /* tree of sources */
324 u_long inm_nsrc; /* # of tree entries */
325
326 struct ifqueue inm_scq; /* queue of pending
327 * state-change packets */
328 struct timeval inm_lastgsrtv; /* Time of last G-S-R query */
329 uint16_t inm_sctimer; /* state-change timer */
330 uint16_t inm_scrv; /* state-change rexmit count */
331
332 /*
333 * SSM state counters which track state at T0 (the time the last
334 * state-change report's RV timer went to zero) and T1
335 * (time of pending report, i.e. now).
336 * Used for computing IGMPv3 state-change reports. Several refcounts
337 * are maintained here to optimize for common use-cases.
338 */
339 struct inm_st {
340 uint16_t iss_fmode; /* IGMP filter mode */
341 uint16_t iss_asm; /* # of ASM listeners */
342 uint16_t iss_ex; /* # of exclusive members */
343 uint16_t iss_in; /* # of inclusive members */
344 uint16_t iss_rec; /* # of recorded sources */
345 } inm_st[2]; /* state at t0, t1 */
346
347 void (*inm_trace) /* callback fn for tracing refs */
348 (struct in_multi *, int);
349 };
350
351 #define INM_LOCK_ASSERT_HELD(_inm) \
352 lck_mtx_assert(&(_inm)->inm_lock, LCK_MTX_ASSERT_OWNED)
353
354 #define INM_LOCK_ASSERT_NOTHELD(_inm) \
355 lck_mtx_assert(&(_inm)->inm_lock, LCK_MTX_ASSERT_NOTOWNED)
356
357 #define INM_LOCK(_inm) \
358 lck_mtx_lock(&(_inm)->inm_lock)
359
360 #define INM_LOCK_SPIN(_inm) \
361 lck_mtx_lock_spin(&(_inm)->inm_lock)
362
363 #define INM_CONVERT_LOCK(_inm) do { \
364 INM_LOCK_ASSERT_HELD(_inm); \
365 lck_mtx_convert_spin(&(_inm)->inm_lock); \
366 } while (0)
367
368 #define INM_UNLOCK(_inm) \
369 lck_mtx_unlock(&(_inm)->inm_lock)
370
371 #define INM_ADDREF(_inm) \
372 inm_addref(_inm, 0)
373
374 #define INM_ADDREF_LOCKED(_inm) \
375 inm_addref(_inm, 1)
376
377 #define INM_REMREF(_inm) \
378 inm_remref(_inm, 0)
379
380 #define INM_REMREF_LOCKED(_inm) \
381 inm_remref(_inm, 1)
382
383 #ifdef SYSCTL_DECL
384 SYSCTL_DECL(_net_inet_ip);
385 SYSCTL_DECL(_net_inet_raw);
386 #endif
387
388 extern LIST_HEAD(in_multihead, in_multi) in_multihead;
389
390 /*
391 * Structure used by macros below to remember position when stepping through
392 * all of the in_multi records.
393 */
394 struct in_multistep {
395 struct in_multi *i_inm;
396 };
397
398 /*
399 * Macro for looking up the in_multi record for a given IP multicast address
400 * on a given interface. If no matching record is found, "inm" is set null.
401 *
402 * We do this differently compared other BSD implementations; instead of
403 * walking the if_multiaddrs list at the interface and returning the
404 * ifma_protospec value of a matching entry, we search the global list
405 * of in_multi records and find it that way. Otherwise either the two
406 * structures (in_multi, ifmultiaddr) need to be ref counted both ways,
407 * which will make things too complicated, or they need to reside in the
408 * same protected domain, which they aren't.
409 *
410 * Must be called with in_multihead_lock held.
411 */
412 #define IN_LOOKUP_MULTI(addr, ifp, inm) \
413 /* struct in_addr *addr; */ \
414 /* struct ifnet *ifp; */ \
415 /* struct in_multi *inm; */ \
416 do { \
417 struct in_multistep _step; \
418 IN_FIRST_MULTI(_step, inm); \
419 while ((inm) != NULL) { \
420 INM_LOCK_SPIN(inm); \
421 if ((inm)->inm_ifp == (ifp) && \
422 (inm)->inm_addr.s_addr == (addr)->s_addr) { \
423 INM_ADDREF_LOCKED(inm); \
424 INM_UNLOCK(inm); \
425 break; \
426 } \
427 INM_UNLOCK(inm); \
428 IN_NEXT_MULTI(_step, inm); \
429 } \
430 } while (0)
431
432 /*
433 * Macro to step through all of the in_multi records, one at a time.
434 * The current position is remembered in "step", which the caller must
435 * provide. IN_FIRST_MULTI(), below, must be called to initialize "step"
436 * and get the first record. Both macros return a NULL "inm" when there
437 * are no remaining records.
438 *
439 * Must be called with in_multihead_lock held.
440 */
441 #define IN_NEXT_MULTI(step, inm) \
442 /* struct in_multistep step; */ \
443 /* struct in_multi *inm; */ \
444 do { \
445 in_multihead_lock_assert(LCK_RW_ASSERT_HELD); \
446 if (((inm) = (step).i_inm) != NULL) \
447 (step).i_inm = LIST_NEXT((step).i_inm, inm_link); \
448 } while (0)
449
450 #define IN_FIRST_MULTI(step, inm) \
451 /* struct in_multistep step; */ \
452 /* struct in_multi *inm; */ \
453 do { \
454 in_multihead_lock_assert(LCK_RW_ASSERT_HELD); \
455 (step).i_inm = LIST_FIRST(&in_multihead); \
456 IN_NEXT_MULTI((step), (inm)); \
457 } while (0)
458
459 struct route;
460 struct ip_moptions;
461
462 /*
463 * Return values for imo_multi_filter().
464 */
465 #define MCAST_PASS 0 /* Pass */
466 #define MCAST_NOTGMEMBER 1 /* This host not a member of group */
467 #define MCAST_NOTSMEMBER 2 /* This host excluded source */
468 #define MCAST_MUTED 3 /* [deprecated] */
469
470 extern void in_ifaddr_init(void);
471 extern int imo_multi_filter(const struct ip_moptions *, const struct ifnet *,
472 const struct sockaddr *, const struct sockaddr *);
473 extern int imo_clone(struct ip_moptions *, struct ip_moptions *);
474 extern void inm_commit(struct in_multi *);
475 extern void inm_clear_recorded(struct in_multi *);
476 extern void inm_print(const struct in_multi *);
477 extern int inm_record_source(struct in_multi *inm, const in_addr_t);
478 extern void inm_release(struct in_multi *);
479 extern void in_multi_init(void);
480 extern struct in_multi *in_addmulti(struct in_addr *, struct ifnet *);
481 extern void in_delmulti(struct in_multi *);
482 extern int in_leavegroup(struct in_multi *, /*const*/ struct in_mfilter *);
483 extern int in_multi_detach(struct in_multi *);
484 extern void inm_addref(struct in_multi *, int);
485 extern void inm_remref(struct in_multi *, int);
486 extern void inm_purge(struct in_multi *);
487 extern uint8_t ims_get_mode(const struct in_multi *,
488 const struct ip_msource *, uint8_t);
489 extern int in_control(struct socket *, u_long, caddr_t, struct ifnet *,
490 struct proc *);
491 extern void in_rtqdrain(void);
492 extern struct radix_node *in_validate(struct radix_node *);
493 extern void ip_input(struct mbuf *);
494 extern int in_ifadown(struct ifaddr *ifa, int);
495 extern void in_ifscrub(struct ifnet *, struct in_ifaddr *, int);
496 extern u_int32_t inaddr_hashval(u_int32_t);
497 extern void in_purgeaddrs(struct ifnet *);
498 extern void imf_leave(struct in_mfilter *);
499 extern void imf_purge(struct in_mfilter *);
500
501 struct inpcb;
502
503 __private_extern__ int inp_join_group(struct inpcb *, struct sockopt *);
504 __private_extern__ int inp_leave_group(struct inpcb *, struct sockopt *);
505 __private_extern__ void in_multihead_lock_exclusive(void);
506 __private_extern__ void in_multihead_lock_shared(void);
507 __private_extern__ void in_multihead_lock_assert(int);
508 __private_extern__ void in_multihead_lock_done(void);
509 #endif /* XNU_KERNEL_PRIVATE */
510
511 /* INET6 stuff */
512 #include <netinet6/in6_var.h>
513
514 #endif /* _NETINET_IN_VAR_H_ */