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