1 | /* |
2 | * Copyright (c) 2000-2018 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) 1982, 1986, 1990, 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_pcb.h 8.1 (Berkeley) 6/10/93 |
61 | * $FreeBSD: src/sys/netinet/in_pcb.h,v 1.32.2.4 2001/08/13 16:26:17 ume Exp $ |
62 | */ |
63 | /* |
64 | * NOTICE: This file was modified by SPARTA, Inc. in 2007 to introduce |
65 | * support for mandatory and extensible security protections. This notice |
66 | * is included in support of clause 2.2 (b) of the Apple Public License, |
67 | * Version 2.0. |
68 | */ |
69 | |
70 | #ifndef _NETINET_IN_PCB_H_ |
71 | #define _NETINET_IN_PCB_H_ |
72 | #include <sys/appleapiopts.h> |
73 | |
74 | #include <sys/types.h> |
75 | #include <sys/queue.h> |
76 | #ifdef BSD_KERNEL_PRIVATE |
77 | #include <sys/bitstring.h> |
78 | #include <sys/tree.h> |
79 | #include <kern/locks.h> |
80 | #include <kern/zalloc.h> |
81 | #include <netinet/in_stat.h> |
82 | #endif /* BSD_KERNEL_PRIVATE */ |
83 | |
84 | #if IPSEC |
85 | #include <netinet6/ipsec.h> /* for IPSEC */ |
86 | #endif /* IPSEC */ |
87 | |
88 | #if NECP |
89 | #include <net/necp.h> |
90 | #endif |
91 | |
92 | |
93 | #ifdef BSD_KERNEL_PRIVATE |
94 | /* |
95 | * struct inpcb is the common protocol control block structure used in most |
96 | * IP transport protocols. |
97 | * |
98 | * Pointers to local and foreign host table entries, local and foreign socket |
99 | * numbers, and pointers up (to a socket structure) and down (to a |
100 | * protocol-specific control block) are stored here. |
101 | */ |
102 | LIST_HEAD(inpcbhead, inpcb); |
103 | LIST_HEAD(inpcbporthead, inpcbport); |
104 | #endif /* BSD_KERNEL_PRIVATE */ |
105 | typedef u_quad_t inp_gen_t; |
106 | |
107 | /* |
108 | * PCB with AF_INET6 null bind'ed laddr can receive AF_INET input packet. |
109 | * So, AF_INET6 null laddr is also used as AF_INET null laddr, by utilizing |
110 | * the following structure. |
111 | */ |
112 | struct in_addr_4in6 { |
113 | u_int32_t ia46_pad32[3]; |
114 | struct in_addr ia46_addr4; |
115 | }; |
116 | |
117 | #ifdef BSD_KERNEL_PRIVATE |
118 | /* |
119 | * NB: the zone allocator is type-stable EXCEPT FOR THE FIRST TWO LONGS |
120 | * of the structure. Therefore, it is important that the members in |
121 | * that position not contain any information which is required to be |
122 | * stable. |
123 | */ |
124 | struct icmp6_filter; |
125 | #if CONFIG_MACF_NET |
126 | struct label; |
127 | #endif |
128 | struct ifnet; |
129 | |
130 | struct inp_stat { |
131 | u_int64_t rxpackets; |
132 | u_int64_t rxbytes; |
133 | u_int64_t txpackets; |
134 | u_int64_t txbytes; |
135 | }; |
136 | |
137 | /* |
138 | * struct inpcb captures the network layer state for TCP, UDP and raw IPv6 |
139 | * and IPv6 sockets. In the case of TCP, further per-connection state is |
140 | * hung off of inp_ppcb most of the time. |
141 | */ |
142 | struct inpcb { |
143 | decl_lck_mtx_data(, inpcb_mtx); /* inpcb per-socket mutex */ |
144 | LIST_ENTRY(inpcb) inp_hash; /* hash list */ |
145 | LIST_ENTRY(inpcb) inp_list; /* list for all PCBs of this proto */ |
146 | void *inp_ppcb; /* pointer to per-protocol pcb */ |
147 | struct inpcbinfo *inp_pcbinfo; /* PCB list info */ |
148 | struct socket *inp_socket; /* back pointer to socket */ |
149 | LIST_ENTRY(inpcb) inp_portlist; /* list for this PCB's local port */ |
150 | RB_ENTRY(inpcb) infc_link; /* link for flowhash RB tree */ |
151 | struct inpcbport *inp_phd; /* head of this list */ |
152 | inp_gen_t inp_gencnt; /* generation count of this instance */ |
153 | int inp_hash_element; /* array index of pcb's hash list */ |
154 | int inp_wantcnt; /* wanted count; atomically updated */ |
155 | int inp_state; /* state (INUSE/CACHED/DEAD) */ |
156 | u_short inp_fport; /* foreign port */ |
157 | u_short inp_lport; /* local port */ |
158 | u_int32_t inp_flags; /* generic IP/datagram flags */ |
159 | u_int32_t inp_flags2; /* generic IP/datagram flags #2 */ |
160 | u_int32_t inp_flow; /* IPv6 flow information */ |
161 | |
162 | u_char inp_sndinprog_cnt; /* outstanding send operations */ |
163 | u_char inp_vflag; /* INP_IPV4 or INP_IPV6 */ |
164 | |
165 | u_char inp_ip_ttl; /* time to live proto */ |
166 | u_char inp_ip_p; /* protocol proto */ |
167 | |
168 | struct ifnet *inp_boundifp; /* interface for INP_BOUND_IF */ |
169 | struct ifnet *inp_last_outifp; /* last known outgoing interface */ |
170 | u_int32_t inp_flowhash; /* flow hash */ |
171 | |
172 | /* Protocol-dependent part */ |
173 | union { |
174 | /* foreign host table entry */ |
175 | struct in_addr_4in6 inp46_foreign; |
176 | struct in6_addr inp6_foreign; |
177 | } inp_dependfaddr; |
178 | union { |
179 | /* local host table entry */ |
180 | struct in_addr_4in6 inp46_local; |
181 | struct in6_addr inp6_local; |
182 | } inp_dependladdr; |
183 | union { |
184 | /* placeholder for routing entry */ |
185 | struct route inp4_route; |
186 | struct route_in6 inp6_route; |
187 | } inp_dependroute; |
188 | struct { |
189 | /* type of service proto */ |
190 | u_char inp4_ip_tos; |
191 | /* IP options */ |
192 | struct mbuf *inp4_options; |
193 | /* IP multicast options */ |
194 | struct ip_moptions *inp4_moptions; |
195 | } inp_depend4; |
196 | struct { |
197 | /* IP options */ |
198 | struct mbuf *inp6_options; |
199 | /* IP6 options for outgoing packets */ |
200 | struct ip6_pktopts *inp6_outputopts; |
201 | /* IP multicast options */ |
202 | struct ip6_moptions *inp6_moptions; |
203 | /* ICMPv6 code type filter */ |
204 | struct icmp6_filter *inp6_icmp6filt; |
205 | /* IPV6_CHECKSUM setsockopt */ |
206 | int inp6_cksum; |
207 | short inp6_hops; |
208 | } inp_depend6; |
209 | |
210 | caddr_t inp_saved_ppcb; /* place to save pointer while cached */ |
211 | #if CONFIG_MACF_NET |
212 | struct label *inp_label; /* MAC label */ |
213 | #endif |
214 | #if IPSEC |
215 | struct inpcbpolicy *inp_sp; /* for IPSec */ |
216 | #endif /* IPSEC */ |
217 | #if NECP |
218 | struct { |
219 | char *inp_domain; |
220 | char *inp_account; |
221 | } inp_necp_attributes; |
222 | struct necp_inpcb_result inp_policyresult; |
223 | uuid_t necp_client_uuid; |
224 | necp_client_flow_cb necp_cb; |
225 | #endif |
226 | u_char *inp_keepalive_data; /* for keepalive offload */ |
227 | u_int8_t inp_keepalive_datalen; /* keepalive data length */ |
228 | u_int8_t inp_keepalive_type; /* type of application */ |
229 | u_int16_t inp_keepalive_interval; /* keepalive interval */ |
230 | uint32_t inp_nstat_refcnt __attribute__((aligned(4))); |
231 | struct inp_stat *inp_stat; |
232 | struct inp_stat *inp_cstat; /* cellular data */ |
233 | struct inp_stat *inp_wstat; /* Wi-Fi data */ |
234 | struct inp_stat *inp_Wstat; /* Wired data */ |
235 | u_int8_t inp_stat_store[sizeof (struct inp_stat) + sizeof (u_int64_t)]; |
236 | u_int8_t inp_cstat_store[sizeof (struct inp_stat) + sizeof (u_int64_t)]; |
237 | u_int8_t inp_wstat_store[sizeof (struct inp_stat) + sizeof (u_int64_t)]; |
238 | u_int8_t inp_Wstat_store[sizeof (struct inp_stat) + sizeof (u_int64_t)]; |
239 | activity_bitmap_t inp_nw_activity; |
240 | u_int64_t inp_start_timestamp; |
241 | }; |
242 | |
243 | #define INP_ADD_STAT(_inp, _cnt_cellular, _cnt_wifi, _cnt_wired, _a, _n)\ |
244 | do { \ |
245 | locked_add_64(&((_inp)->inp_stat->_a), (_n)); \ |
246 | if (_cnt_cellular) \ |
247 | locked_add_64(&((_inp)->inp_cstat->_a), (_n)); \ |
248 | if (_cnt_wifi) \ |
249 | locked_add_64(&((_inp)->inp_wstat->_a), (_n)); \ |
250 | if (_cnt_wired) \ |
251 | locked_add_64(&((_inp)->inp_Wstat->_a), (_n)); \ |
252 | } while (0); |
253 | #endif /* BSD_KERNEL_PRIVATE */ |
254 | |
255 | /* |
256 | * Interface exported to userland by various protocols which use |
257 | * inpcbs. Hack alert -- only define if struct xsocket is in scope. |
258 | */ |
259 | #pragma pack(4) |
260 | |
261 | #if defined(__LP64__) |
262 | struct _inpcb_list_entry { |
263 | u_int32_t le_next; |
264 | u_int32_t le_prev; |
265 | }; |
266 | #define _INPCB_PTR(x) u_int32_t |
267 | #define _INPCB_LIST_ENTRY(x) struct _inpcb_list_entry |
268 | #else /* !__LP64__ */ |
269 | #define _INPCB_PTR(x) x |
270 | #define _INPCB_LIST_ENTRY(x) LIST_ENTRY(x) |
271 | #endif /* !__LP64__ */ |
272 | |
273 | #ifdef XNU_KERNEL_PRIVATE |
274 | /* |
275 | * This is a copy of the inpcb as it shipped in Panther. This structure |
276 | * is filled out in a copy function. This allows the inpcb to change |
277 | * without breaking userland tools. |
278 | * |
279 | * CAUTION: Many fields may not be filled out. Fewer may be filled out |
280 | * in the future. Code defensively. |
281 | */ |
282 | struct inpcb_compat { |
283 | #else |
284 | struct inpcbinfo; |
285 | struct inpcbport; |
286 | struct mbuf; |
287 | struct ip6_pktopts; |
288 | struct ip6_moptions; |
289 | struct icmp6_filter; |
290 | struct inpcbpolicy; |
291 | |
292 | struct inpcb { |
293 | #endif /* KERNEL_PRIVATE */ |
294 | _INPCB_LIST_ENTRY(inpcb) inp_hash; /* hash list */ |
295 | struct in_addr reserved1; /* reserved */ |
296 | struct in_addr reserved2; /* reserved */ |
297 | u_short inp_fport; /* foreign port */ |
298 | u_short inp_lport; /* local port */ |
299 | _INPCB_LIST_ENTRY(inpcb) inp_list; /* list for all peer PCBs */ |
300 | _INPCB_PTR(caddr_t) inp_ppcb; /* per-protocol pcb */ |
301 | _INPCB_PTR(struct inpcbinfo *) inp_pcbinfo; /* PCB list info */ |
302 | _INPCB_PTR(void *) inp_socket; /* back pointer to socket */ |
303 | u_char nat_owner; /* Used to NAT TCP/UDP traffic */ |
304 | u_int32_t nat_cookie; /* Cookie stored and returned to NAT */ |
305 | _INPCB_LIST_ENTRY(inpcb) inp_portlist; /* this PCB's local port list */ |
306 | _INPCB_PTR(struct inpcbport *) inp_phd; /* head of this list */ |
307 | inp_gen_t inp_gencnt; /* generation count of this instance */ |
308 | int inp_flags; /* generic IP/datagram flags */ |
309 | u_int32_t inp_flow; |
310 | |
311 | u_char inp_vflag; |
312 | |
313 | u_char inp_ip_ttl; /* time to live proto */ |
314 | u_char inp_ip_p; /* protocol proto */ |
315 | /* protocol dependent part */ |
316 | union { |
317 | /* foreign host table entry */ |
318 | struct in_addr_4in6 inp46_foreign; |
319 | struct in6_addr inp6_foreign; |
320 | } inp_dependfaddr; |
321 | union { |
322 | /* local host table entry */ |
323 | struct in_addr_4in6 inp46_local; |
324 | struct in6_addr inp6_local; |
325 | } inp_dependladdr; |
326 | union { |
327 | /* placeholder for routing entry */ |
328 | u_char inp4_route[20]; |
329 | u_char inp6_route[32]; |
330 | } inp_dependroute; |
331 | struct { |
332 | /* type of service proto */ |
333 | u_char inp4_ip_tos; |
334 | /* IP options */ |
335 | _INPCB_PTR(struct mbuf *) inp4_options; |
336 | /* IP multicast options */ |
337 | _INPCB_PTR(struct ip_moptions *) inp4_moptions; |
338 | } inp_depend4; |
339 | |
340 | struct { |
341 | /* IP options */ |
342 | _INPCB_PTR(struct mbuf *) inp6_options; |
343 | u_int8_t inp6_hlim; |
344 | u_int8_t unused_uint8_1; |
345 | ushort unused_uint16_1; |
346 | /* IP6 options for outgoing packets */ |
347 | _INPCB_PTR(struct ip6_pktopts *) inp6_outputopts; |
348 | /* IP multicast options */ |
349 | _INPCB_PTR(struct ip6_moptions *) inp6_moptions; |
350 | /* ICMPv6 code type filter */ |
351 | _INPCB_PTR(struct icmp6_filter *) inp6_icmp6filt; |
352 | /* IPV6_CHECKSUM setsockopt */ |
353 | int inp6_cksum; |
354 | u_short inp6_ifindex; |
355 | short inp6_hops; |
356 | } inp_depend6; |
357 | |
358 | int hash_element; /* Array index of pcb's hash list */ |
359 | _INPCB_PTR(caddr_t) inp_saved_ppcb; /* pointer while cached */ |
360 | _INPCB_PTR(struct inpcbpolicy *) inp_sp; |
361 | u_int32_t reserved[3]; /* reserved */ |
362 | }; |
363 | |
364 | struct xinpcb { |
365 | u_int32_t xi_len; /* length of this structure */ |
366 | #ifdef XNU_KERNEL_PRIVATE |
367 | struct inpcb_compat xi_inp; |
368 | #else |
369 | struct inpcb xi_inp; |
370 | #endif |
371 | struct xsocket xi_socket; |
372 | u_quad_t xi_alignment_hack; |
373 | }; |
374 | |
375 | #if !CONFIG_EMBEDDED |
376 | struct inpcb64_list_entry { |
377 | u_int64_t le_next; |
378 | u_int64_t le_prev; |
379 | }; |
380 | |
381 | struct xinpcb64 { |
382 | u_int64_t xi_len; /* length of this structure */ |
383 | u_int64_t xi_inpp; |
384 | u_short inp_fport; /* foreign port */ |
385 | u_short inp_lport; /* local port */ |
386 | struct inpcb64_list_entry inp_list; /* list for all PCBs */ |
387 | u_int64_t inp_ppcb; /* ptr to per-protocol PCB */ |
388 | u_int64_t inp_pcbinfo; /* PCB list info */ |
389 | struct inpcb64_list_entry inp_portlist; /* this PCB's local port list */ |
390 | u_int64_t inp_phd; /* head of this list */ |
391 | inp_gen_t inp_gencnt; /* current generation count */ |
392 | int inp_flags; /* generic IP/datagram flags */ |
393 | u_int32_t inp_flow; |
394 | u_char inp_vflag; |
395 | u_char inp_ip_ttl; /* time to live */ |
396 | u_char inp_ip_p; /* protocol */ |
397 | union { /* foreign host table entry */ |
398 | struct in_addr_4in6 inp46_foreign; |
399 | struct in6_addr inp6_foreign; |
400 | } inp_dependfaddr; |
401 | union { /* local host table entry */ |
402 | struct in_addr_4in6 inp46_local; |
403 | struct in6_addr inp6_local; |
404 | } inp_dependladdr; |
405 | struct { |
406 | u_char inp4_ip_tos; /* type of service */ |
407 | } inp_depend4; |
408 | struct { |
409 | u_int8_t inp6_hlim; |
410 | int inp6_cksum; |
411 | u_short inp6_ifindex; |
412 | short inp6_hops; |
413 | } inp_depend6; |
414 | struct xsocket64 xi_socket; |
415 | u_quad_t xi_alignment_hack; |
416 | }; |
417 | #endif /* !CONFIG_EMBEDDED */ |
418 | |
419 | #ifdef PRIVATE |
420 | struct xinpcb_list_entry { |
421 | u_int64_t le_next; |
422 | u_int64_t le_prev; |
423 | }; |
424 | |
425 | struct xinpcb_n { |
426 | u_int32_t xi_len; /* length of this structure */ |
427 | u_int32_t xi_kind; /* XSO_INPCB */ |
428 | u_int64_t xi_inpp; |
429 | u_short inp_fport; /* foreign port */ |
430 | u_short inp_lport; /* local port */ |
431 | u_int64_t inp_ppcb; /* pointer to per-protocol pcb */ |
432 | inp_gen_t inp_gencnt; /* generation count of this instance */ |
433 | int inp_flags; /* generic IP/datagram flags */ |
434 | u_int32_t inp_flow; |
435 | u_char inp_vflag; |
436 | u_char inp_ip_ttl; /* time to live */ |
437 | u_char inp_ip_p; /* protocol */ |
438 | union { /* foreign host table entry */ |
439 | struct in_addr_4in6 inp46_foreign; |
440 | struct in6_addr inp6_foreign; |
441 | } inp_dependfaddr; |
442 | union { /* local host table entry */ |
443 | struct in_addr_4in6 inp46_local; |
444 | struct in6_addr inp6_local; |
445 | } inp_dependladdr; |
446 | struct { |
447 | u_char inp4_ip_tos; /* type of service */ |
448 | } inp_depend4; |
449 | struct { |
450 | u_int8_t inp6_hlim; |
451 | int inp6_cksum; |
452 | u_short inp6_ifindex; |
453 | short inp6_hops; |
454 | } inp_depend6; |
455 | u_int32_t inp_flowhash; |
456 | u_int32_t inp_flags2; |
457 | }; |
458 | #endif /* PRIVATE */ |
459 | |
460 | struct xinpgen { |
461 | u_int32_t xig_len; /* length of this structure */ |
462 | u_int xig_count; /* number of PCBs at this time */ |
463 | inp_gen_t xig_gen; /* generation count at this time */ |
464 | so_gen_t xig_sogen; /* current socket generation count */ |
465 | }; |
466 | |
467 | #pragma pack() |
468 | |
469 | /* |
470 | * These defines are for use with the inpcb. |
471 | */ |
472 | #define INP_IPV4 0x1 |
473 | #define INP_IPV6 0x2 |
474 | #define inp_faddr inp_dependfaddr.inp46_foreign.ia46_addr4 |
475 | #define inp_laddr inp_dependladdr.inp46_local.ia46_addr4 |
476 | #define in6p_faddr inp_dependfaddr.inp6_foreign |
477 | #define in6p_laddr inp_dependladdr.inp6_local |
478 | |
479 | #ifdef BSD_KERNEL_PRIVATE |
480 | #define inp_route inp_dependroute.inp4_route |
481 | #define inp_ip_tos inp_depend4.inp4_ip_tos |
482 | #define inp_options inp_depend4.inp4_options |
483 | #define inp_moptions inp_depend4.inp4_moptions |
484 | #define in6p_route inp_dependroute.inp6_route |
485 | #define in6p_ip6_hlim inp_depend6.inp6_hlim |
486 | #define in6p_hops inp_depend6.inp6_hops /* default hop limit */ |
487 | #define in6p_ip6_nxt inp_ip_p |
488 | #define in6p_vflag inp_vflag |
489 | #define in6p_options inp_depend6.inp6_options |
490 | #define in6p_outputopts inp_depend6.inp6_outputopts |
491 | #define in6p_moptions inp_depend6.inp6_moptions |
492 | #define in6p_icmp6filt inp_depend6.inp6_icmp6filt |
493 | #define in6p_cksum inp_depend6.inp6_cksum |
494 | #define in6p_ifindex inp_depend6.inp6_ifindex |
495 | #define in6p_flags inp_flags |
496 | #define in6p_flags2 inp_flags2 |
497 | #define in6p_socket inp_socket |
498 | #define in6p_lport inp_lport |
499 | #define in6p_fport inp_fport |
500 | #define in6p_ppcb inp_ppcb |
501 | #define in6p_state inp_state |
502 | #define in6p_wantcnt inp_wantcnt |
503 | #define in6p_last_outifp inp_last_outifp |
504 | #define in6pcb inpcb |
505 | #if IPSEC |
506 | #define in6p_sp inp_sp |
507 | #endif /* IPSEC */ |
508 | #define INP_INC_IFNET_STAT(_inp_, _stat_) { \ |
509 | if ((_inp_)->inp_last_outifp != NULL) { \ |
510 | if ((_inp_)->inp_vflag & INP_IPV6) { \ |
511 | (_inp_)->inp_last_outifp->if_ipv6_stat->_stat_++;\ |
512 | } else { \ |
513 | (_inp_)->inp_last_outifp->if_ipv4_stat->_stat_++;\ |
514 | }\ |
515 | }\ |
516 | } |
517 | |
518 | struct inpcbport { |
519 | LIST_ENTRY(inpcbport) phd_hash; |
520 | struct inpcbhead phd_pcblist; |
521 | u_short phd_port; |
522 | }; |
523 | |
524 | struct intimercount { |
525 | u_int32_t intimer_lazy; /* lazy requests for timer scheduling */ |
526 | u_int32_t intimer_fast; /* fast requests, can be coalesced */ |
527 | u_int32_t intimer_nodelay; /* fast requests, never coalesced */ |
528 | }; |
529 | |
530 | typedef void (*inpcb_timer_func_t)(struct inpcbinfo *); |
531 | |
532 | /* |
533 | * Global data structure for each high-level protocol (UDP, TCP, ...) in both |
534 | * IPv4 and IPv6. Holds inpcb lists and information for managing them. Each |
535 | * pcbinfo is protected by a RW lock: ipi_lock. |
536 | * |
537 | * All INPCB pcbinfo entries are linked together via ipi_entry. |
538 | */ |
539 | struct inpcbinfo { |
540 | /* |
541 | * Glue to all PCB infos, as well as garbage collector and |
542 | * timer callbacks, protected by inpcb_lock. Callout request |
543 | * counts are atomically updated. |
544 | */ |
545 | TAILQ_ENTRY(inpcbinfo) ipi_entry; |
546 | inpcb_timer_func_t ipi_gc; |
547 | inpcb_timer_func_t ipi_timer; |
548 | struct intimercount ipi_gc_req; |
549 | struct intimercount ipi_timer_req; |
550 | |
551 | /* |
552 | * Per-protocol lock protecting pcb list, pcb count, etc. |
553 | */ |
554 | lck_rw_t *ipi_lock; |
555 | |
556 | /* |
557 | * List and count of pcbs on the protocol. |
558 | */ |
559 | struct inpcbhead *ipi_listhead; |
560 | uint32_t ipi_count; |
561 | |
562 | /* |
563 | * Count of pcbs marked with INP2_TIMEWAIT flag. |
564 | */ |
565 | uint32_t ipi_twcount; |
566 | |
567 | /* |
568 | * Generation count -- incremented each time a connection is |
569 | * allocated or freed. |
570 | */ |
571 | uint64_t ipi_gencnt; |
572 | |
573 | /* |
574 | * Fields associated with port lookup and allocation. |
575 | */ |
576 | uint16_t ipi_lastport; |
577 | uint16_t ipi_lastlow; |
578 | uint16_t ipi_lasthi; |
579 | |
580 | /* |
581 | * Zone from which inpcbs are allocated for this protocol. |
582 | */ |
583 | struct zone *ipi_zone; |
584 | |
585 | /* |
586 | * Per-protocol hash of pcbs, hashed by local and foreign |
587 | * addresses and port numbers. |
588 | */ |
589 | struct inpcbhead *ipi_hashbase; |
590 | u_long ipi_hashmask; |
591 | |
592 | /* |
593 | * Per-protocol hash of pcbs, hashed by only local port number. |
594 | */ |
595 | struct inpcbporthead *ipi_porthashbase; |
596 | u_long ipi_porthashmask; |
597 | |
598 | /* |
599 | * Misc. |
600 | */ |
601 | lck_attr_t *ipi_lock_attr; |
602 | lck_grp_t *ipi_lock_grp; |
603 | lck_grp_attr_t *ipi_lock_grp_attr; |
604 | |
605 | #define INPCBINFO_UPDATE_MSS 0x1 |
606 | #define INPCBINFO_HANDLE_LQM_ABORT 0x2 |
607 | u_int32_t ipi_flags; |
608 | }; |
609 | |
610 | #define INP_PCBHASH(faddr, lport, fport, mask) \ |
611 | (((faddr) ^ ((faddr) >> 16) ^ ntohs((lport) ^ (fport))) & (mask)) |
612 | #define INP_PCBPORTHASH(lport, mask) \ |
613 | (ntohs((lport)) & (mask)) |
614 | |
615 | #define INP_IS_FLOW_CONTROLLED(_inp_) \ |
616 | ((_inp_)->inp_flags & INP_FLOW_CONTROLLED) |
617 | #define INP_IS_FLOW_SUSPENDED(_inp_) \ |
618 | (((_inp_)->inp_flags & INP_FLOW_SUSPENDED) || \ |
619 | ((_inp_)->inp_socket->so_flags & SOF_SUSPENDED)) |
620 | #define INP_WAIT_FOR_IF_FEEDBACK(_inp_) \ |
621 | (((_inp_)->inp_flags & (INP_FLOW_CONTROLLED | INP_FLOW_SUSPENDED)) != 0) |
622 | |
623 | #define INP_NO_CELLULAR(_inp) \ |
624 | ((_inp)->inp_flags & INP_NO_IFT_CELLULAR) |
625 | #define INP_NO_EXPENSIVE(_inp) \ |
626 | ((_inp)->inp_flags2 & INP2_NO_IFF_EXPENSIVE) |
627 | #define INP_AWDL_UNRESTRICTED(_inp) \ |
628 | ((_inp)->inp_flags2 & INP2_AWDL_UNRESTRICTED) |
629 | #define INP_INTCOPROC_ALLOWED(_inp) \ |
630 | ((_inp)->inp_flags2 & INP2_INTCOPROC_ALLOWED) |
631 | |
632 | #endif /* BSD_KERNEL_PRIVATE */ |
633 | |
634 | /* |
635 | * Flags for inp_flags. |
636 | * |
637 | * Some of these are publicly defined for legacy reasons, as they are |
638 | * (unfortunately) used by certain applications to determine, at compile |
639 | * time, whether or not the OS supports certain features. |
640 | */ |
641 | #ifdef BSD_KERNEL_PRIVATE |
642 | #define INP_RECVOPTS 0x00000001 /* receive incoming IP options */ |
643 | #define INP_RECVRETOPTS 0x00000002 /* receive IP options for reply */ |
644 | #define INP_RECVDSTADDR 0x00000004 /* receive IP dst address */ |
645 | #define INP_HDRINCL 0x00000008 /* user supplies entire IP header */ |
646 | #define INP_HIGHPORT 0x00000010 /* user wants "high" port binding */ |
647 | #define INP_LOWPORT 0x00000020 /* user wants "low" port binding */ |
648 | #endif /* BSD_KERNEL_PRIVATE */ |
649 | |
650 | #define INP_ANONPORT 0x00000040 /* port chosen for user */ |
651 | |
652 | #ifdef BSD_KERNEL_PRIVATE |
653 | #define INP_RECVIF 0x00000080 /* receive incoming interface */ |
654 | #define INP_MTUDISC 0x00000100 /* unused */ |
655 | #define INP_STRIPHDR 0x00000200 /* strip hdrs in raw_ip (for OT) */ |
656 | #define INP_RECV_ANYIF 0x00000400 /* don't restrict inbound iface */ |
657 | #define INP_INADDR_ANY 0x00000800 /* local address wasn't specified */ |
658 | #define INP_IN6ADDR_ANY INP_INADDR_ANY |
659 | #define INP_RECVTTL 0x00001000 /* receive incoming IP TTL */ |
660 | #define INP_UDP_NOCKSUM 0x00002000 /* turn off outbound UDP checksum */ |
661 | #define INP_BOUND_IF 0x00004000 /* bind socket to an interface */ |
662 | #endif /* BSD_KERNEL_PRIVATE */ |
663 | |
664 | #define IN6P_IPV6_V6ONLY 0x00008000 /* restrict AF_INET6 socket for v6 */ |
665 | |
666 | #ifdef BSD_KERNEL_PRIVATE |
667 | #define IN6P_PKTINFO 0x00010000 /* receive IP6 dst and I/F */ |
668 | #define IN6P_HOPLIMIT 0x00020000 /* receive hoplimit */ |
669 | #define IN6P_HOPOPTS 0x00040000 /* receive hop-by-hop options */ |
670 | #define IN6P_DSTOPTS 0x00080000 /* receive dst options after rthdr */ |
671 | #define IN6P_RTHDR 0x00100000 /* receive routing header */ |
672 | #define IN6P_RTHDRDSTOPTS 0x00200000 /* receive dstoptions before rthdr */ |
673 | #define IN6P_TCLASS 0x00400000 /* receive traffic class value */ |
674 | #define INP_RECVTOS IN6P_TCLASS /* receive incoming IP TOS */ |
675 | #define IN6P_AUTOFLOWLABEL 0x00800000 /* attach flowlabel automatically */ |
676 | #endif /* BSD_KERNEL_PRIVATE */ |
677 | |
678 | #define IN6P_BINDV6ONLY 0x01000000 /* do not grab IPv4 traffic */ |
679 | |
680 | #ifdef BSD_KERNEL_PRIVATE |
681 | #define IN6P_RFC2292 0x02000000 /* used RFC2292 API on the socket */ |
682 | #define IN6P_MTU 0x04000000 /* receive path MTU */ |
683 | #define INP_PKTINFO 0x08000000 /* rcv and snd PKTINFO for IPv4 */ |
684 | #define INP_FLOW_SUSPENDED 0x10000000 /* flow suspended */ |
685 | #define INP_NO_IFT_CELLULAR 0x20000000 /* do not use cellular interface */ |
686 | #define INP_FLOW_CONTROLLED 0x40000000 /* flow controlled */ |
687 | #define INP_FC_FEEDBACK 0x80000000 /* got interface flow adv feedback */ |
688 | |
689 | #define INP_CONTROLOPTS \ |
690 | (INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|INP_RECVIF|INP_RECVTTL| \ |
691 | INP_PKTINFO|IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|IN6P_DSTOPTS| \ |
692 | IN6P_RTHDR|IN6P_RTHDRDSTOPTS|IN6P_TCLASS|IN6P_RFC2292|IN6P_MTU) |
693 | |
694 | #define INP_UNMAPPABLEOPTS \ |
695 | (IN6P_HOPOPTS|IN6P_DSTOPTS|IN6P_RTHDR|IN6P_AUTOFLOWLABEL) |
696 | |
697 | /* |
698 | * Flags for inp_flags2. |
699 | * |
700 | * Overflowed INP flags; use INP2 prefix to avoid misuse. |
701 | */ |
702 | #define INP2_TIMEWAIT 0x00000001 /* in TIMEWAIT */ |
703 | #define INP2_IN_FCTREE 0x00000002 /* in inp_fc_tree */ |
704 | #define INP2_WANT_APP_POLICY 0x00000004 /* necp app policy check is desired */ |
705 | #define INP2_NO_IFF_EXPENSIVE 0x00000008 /* do not use expensive interface */ |
706 | #define INP2_INHASHLIST 0x00000010 /* pcb is in inp_hash list */ |
707 | #define INP2_AWDL_UNRESTRICTED 0x00000020 /* AWDL restricted mode allowed */ |
708 | #define INP2_KEEPALIVE_OFFLOAD 0x00000040 /* Enable UDP or TCP keepalive offload */ |
709 | #define INP2_INTCOPROC_ALLOWED 0x00000080 /* Allow communication via internal co-processor interfaces */ |
710 | #define INP2_CONNECT_IN_PROGRESS 0x00000100 /* A connect call is in progress, so binds are intermediate steps */ |
711 | #define INP2_CLAT46_FLOW 0x00000200 /* The flow is going to use CLAT46 path */ |
712 | |
713 | /* |
714 | * Flags passed to in_pcblookup*() functions. |
715 | */ |
716 | #define INPLOOKUP_WILDCARD 1 |
717 | |
718 | #define sotoinpcb(so) ((struct inpcb *)(so)->so_pcb) |
719 | #define sotoin6pcb(so) sotoinpcb(so) |
720 | |
721 | struct sysctl_req; |
722 | |
723 | extern int ipport_lowfirstauto; |
724 | extern int ipport_lowlastauto; |
725 | extern int ipport_firstauto; |
726 | extern int ipport_lastauto; |
727 | extern int ipport_hifirstauto; |
728 | extern int ipport_hilastauto; |
729 | |
730 | /* freshly allocated PCB, it's in use */ |
731 | #define INPCB_STATE_INUSE 0x1 |
732 | /* this pcb is sitting in a a cache */ |
733 | #define INPCB_STATE_CACHED 0x2 |
734 | /* should treat as gone, will be garbage collected and freed */ |
735 | #define INPCB_STATE_DEAD 0x3 |
736 | |
737 | /* marked as ready to be garbaged collected, should be treated as not found */ |
738 | #define WNT_STOPUSING 0xffff |
739 | /* that pcb is being acquired, do not recycle this time */ |
740 | #define WNT_ACQUIRE 0x1 |
741 | /* release acquired mode, can be garbage collected when wantcnt is null */ |
742 | #define WNT_RELEASE 0x2 |
743 | |
744 | extern void in_pcbinit(void); |
745 | extern void in_pcbinfo_attach(struct inpcbinfo *); |
746 | extern int in_pcbinfo_detach(struct inpcbinfo *); |
747 | |
748 | /* type of timer to be scheduled by inpcb_gc_sched and inpcb_timer_sched */ |
749 | enum { |
750 | INPCB_TIMER_LAZY = 0x1, |
751 | INPCB_TIMER_FAST, |
752 | INPCB_TIMER_NODELAY |
753 | }; |
754 | extern void inpcb_gc_sched(struct inpcbinfo *, u_int32_t type); |
755 | extern void inpcb_timer_sched(struct inpcbinfo *, u_int32_t type); |
756 | |
757 | extern void in_losing(struct inpcb *); |
758 | extern void in_rtchange(struct inpcb *, int); |
759 | extern int in_pcballoc(struct socket *, struct inpcbinfo *, struct proc *); |
760 | extern int in_pcbbind(struct inpcb *, struct sockaddr *, struct proc *); |
761 | extern int in_pcbconnect(struct inpcb *, struct sockaddr *, struct proc *, |
762 | unsigned int, struct ifnet **); |
763 | extern void in_pcbdetach(struct inpcb *); |
764 | extern void in_pcbdispose(struct inpcb *); |
765 | extern void in_pcbdisconnect(struct inpcb *); |
766 | extern int in_pcbinshash(struct inpcb *, int); |
767 | extern int in_pcbladdr(struct inpcb *, struct sockaddr *, struct in_addr *, |
768 | unsigned int, struct ifnet **, int); |
769 | extern struct inpcb *in_pcblookup_local(struct inpcbinfo *, struct in_addr, |
770 | u_int, int); |
771 | extern struct inpcb *in_pcblookup_local_and_cleanup(struct inpcbinfo *, |
772 | struct in_addr, u_int, int); |
773 | extern struct inpcb *in_pcblookup_hash(struct inpcbinfo *, struct in_addr, |
774 | u_int, struct in_addr, u_int, int, struct ifnet *); |
775 | extern int in_pcblookup_hash_exists(struct inpcbinfo *, struct in_addr, |
776 | u_int, struct in_addr, u_int, int, uid_t *, gid_t *, struct ifnet *); |
777 | extern void in_pcbnotifyall(struct inpcbinfo *, struct in_addr, int, |
778 | void (*)(struct inpcb *, int)); |
779 | extern void in_pcbrehash(struct inpcb *); |
780 | extern int in_getpeeraddr(struct socket *, struct sockaddr **); |
781 | extern int in_getsockaddr(struct socket *, struct sockaddr **); |
782 | extern int in_getsockaddr_s(struct socket *, struct sockaddr_in *); |
783 | extern int in_pcb_checkstate(struct inpcb *, int, int); |
784 | extern void in_pcbremlists(struct inpcb *); |
785 | extern void inpcb_to_compat(struct inpcb *, struct inpcb_compat *); |
786 | #if !CONFIG_EMBEDDED |
787 | extern void inpcb_to_xinpcb64(struct inpcb *, struct xinpcb64 *); |
788 | #endif |
789 | |
790 | extern int get_pcblist_n(short, struct sysctl_req *, struct inpcbinfo *); |
791 | #define INPCB_GET_PORTS_USED_WILDCARDOK 0x01 |
792 | #define INPCB_GET_PORTS_USED_NOWAKEUPOK 0x02 |
793 | #define INPCB_GET_PORTS_USED_RECVANYIFONLY 0x04 |
794 | #define INPCB_GET_PORTS_USED_EXTBGIDLEONLY 0x08 |
795 | #define INPCB_GET_PORTS_USED_ACTIVEONLY 0x10 |
796 | |
797 | extern void inpcb_get_ports_used(u_int32_t, int, u_int32_t, bitstr_t *, |
798 | struct inpcbinfo *); |
799 | #define INPCB_OPPORTUNISTIC_THROTTLEON 0x0001 |
800 | #define INPCB_OPPORTUNISTIC_SETCMD 0x0002 |
801 | extern uint32_t inpcb_count_opportunistic(unsigned int, struct inpcbinfo *, |
802 | u_int32_t); |
803 | extern uint32_t inpcb_find_anypcb_byaddr(struct ifaddr *, struct inpcbinfo *); |
804 | extern void inp_route_copyout(struct inpcb *, struct route *); |
805 | extern void inp_route_copyin(struct inpcb *, struct route *); |
806 | extern int inp_bindif(struct inpcb *, unsigned int, struct ifnet **); |
807 | extern void inp_set_nocellular(struct inpcb *); |
808 | extern void inp_clear_nocellular(struct inpcb *); |
809 | extern void inp_set_noexpensive(struct inpcb *); |
810 | extern void inp_set_awdl_unrestricted(struct inpcb *); |
811 | extern boolean_t inp_get_awdl_unrestricted(struct inpcb *); |
812 | extern void inp_clear_awdl_unrestricted(struct inpcb *); |
813 | extern void inp_set_intcoproc_allowed(struct inpcb *); |
814 | extern boolean_t inp_get_intcoproc_allowed(struct inpcb *); |
815 | extern void inp_clear_intcoproc_allowed(struct inpcb *); |
816 | #if NECP |
817 | extern void inp_update_necp_policy(struct inpcb *, struct sockaddr *, struct sockaddr *, u_int); |
818 | extern void inp_set_want_app_policy(struct inpcb *); |
819 | extern void inp_clear_want_app_policy(struct inpcb *); |
820 | #endif /* NECP */ |
821 | extern u_int32_t inp_calc_flowhash(struct inpcb *); |
822 | extern void inp_reset_fc_state(struct inpcb *); |
823 | extern int inp_set_fc_state(struct inpcb *, int advcode); |
824 | extern void inp_fc_unthrottle_tcp(struct inpcb *); |
825 | extern void inp_flowadv(uint32_t); |
826 | extern int inp_flush(struct inpcb *, int); |
827 | extern int inp_findinpcb_procinfo(struct inpcbinfo *, uint32_t, struct so_procinfo *); |
828 | extern void inp_get_soprocinfo(struct inpcb *, struct so_procinfo *); |
829 | extern int inp_update_policy(struct inpcb *); |
830 | extern boolean_t inp_restricted_recv(struct inpcb *, struct ifnet *); |
831 | extern boolean_t inp_restricted_send(struct inpcb *, struct ifnet *); |
832 | extern void inp_incr_sndbytes_total(struct socket *, int); |
833 | extern void inp_decr_sndbytes_total(struct socket *, int); |
834 | extern void inp_count_sndbytes(struct inpcb *, u_int32_t); |
835 | extern void inp_incr_sndbytes_unsent(struct socket *, int32_t); |
836 | extern void inp_decr_sndbytes_unsent(struct socket *, int32_t); |
837 | extern int32_t inp_get_sndbytes_allunsent(struct socket *, u_int32_t); |
838 | extern void inp_decr_sndbytes_allunsent(struct socket *, u_int32_t); |
839 | extern void inp_set_activity_bitmap(struct inpcb *inp); |
840 | extern void inp_get_activity_bitmap(struct inpcb *inp, activity_bitmap_t *b); |
841 | #endif /* BSD_KERNEL_PRIVATE */ |
842 | #ifdef KERNEL_PRIVATE |
843 | /* exported for PPP */ |
844 | extern void inp_clear_INP_INADDR_ANY(struct socket *); |
845 | #endif /* KERNEL_PRIVATE */ |
846 | #endif /* !_NETINET_IN_PCB_H_ */ |
847 | |