2 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * The contents of this file constitute Original Code as defined in and
7 * are subject to the Apple Public Source License Version 1.1 (the
8 * "License"). You may not use this file except in compliance with the
9 * License. Please obtain a copy of the License at
10 * http://www.apple.com/publicsource and read it before using this file.
12 * This Original Code and all software distributed under the License are
13 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
14 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
15 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
17 * License for the specific language governing rights and limitations
20 * @APPLE_LICENSE_HEADER_END@
23 * Copyright (c) 1982, 1986, 1990, 1993
24 * The Regents of the University of California. All rights reserved.
26 * Redistribution and use in source and binary forms, with or without
27 * modification, are permitted provided that the following conditions
29 * 1. Redistributions of source code must retain the above copyright
30 * notice, this list of conditions and the following disclaimer.
31 * 2. Redistributions in binary form must reproduce the above copyright
32 * notice, this list of conditions and the following disclaimer in the
33 * documentation and/or other materials provided with the distribution.
34 * 3. All advertising materials mentioning features or use of this software
35 * must display the following acknowledgement:
36 * This product includes software developed by the University of
37 * California, Berkeley and its contributors.
38 * 4. Neither the name of the University nor the names of its contributors
39 * may be used to endorse or promote products derived from this software
40 * without specific prior written permission.
42 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
43 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
46 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
48 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
49 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
50 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
51 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
54 * @(#)in_pcb.h 8.1 (Berkeley) 6/10/93
55 * $FreeBSD: src/sys/netinet/in_pcb.h,v 1.32.2.4 2001/08/13 16:26:17 ume Exp $
58 #ifndef _NETINET_IN_PCB_H_
59 #define _NETINET_IN_PCB_H_
60 #include <sys/appleapiopts.h>
62 #include <sys/types.h>
63 #include <sys/queue.h>
66 #include <kern/locks.h>
68 #endif /* KERNEL_PRIVATE */
70 #include <netinet6/ipsec.h> /* for IPSEC */
74 #define in6pcb inpcb /* for KAME src sync over BSD*'s */
75 #define in6p_sp inp_sp /* for KAME src sync over BSD*'s */
78 * Common structure pcb for internet protocol implementation.
79 * Here are stored pointers to local and foreign host table
80 * entries, local and foreign socket numbers, and pointers
81 * up (to a socket structure) and down (to a protocol-specific)
84 LIST_HEAD(inpcbhead
, inpcb
);
85 LIST_HEAD(inpcbporthead
, inpcbport
);
86 #endif /* KERNEL_PRIVATE */
87 typedef u_quad_t inp_gen_t
;
90 * PCB with AF_INET6 null bind'ed laddr can receive AF_INET input packet.
91 * So, AF_INET6 null laddr is also used as AF_INET null laddr,
92 * by utilize following structure. (At last, same as INRIA)
95 u_int32_t ia46_pad32
[3];
96 struct in_addr ia46_addr4
;
101 * NB: the zone allocator is type-stable EXCEPT FOR THE FIRST TWO LONGS
102 * of the structure. Therefore, it is important that the members in
103 * that position not contain any information which is required to be
109 LIST_ENTRY(inpcb
) inp_hash
; /* hash list */
110 int inp_wantcnt
; /* pcb wanted count. protected by pcb list lock */
111 int inp_state
; /* state of this pcb, in use, recycled, ready for recycling... */
112 u_short inp_fport
; /* foreign port */
113 u_short inp_lport
; /* local port */
114 LIST_ENTRY(inpcb
) inp_list
; /* list for all PCBs of this proto */
115 caddr_t inp_ppcb
; /* pointer to per-protocol pcb */
116 struct inpcbinfo
*inp_pcbinfo
; /* PCB list info */
117 struct socket
*inp_socket
; /* back pointer to socket */
118 u_char nat_owner
; /* Used to NAT TCP/UDP traffic */
119 u_long nat_cookie
; /* Cookie stored and returned to NAT */
120 LIST_ENTRY(inpcb
) inp_portlist
; /* list for this PCB's local port */
121 struct inpcbport
*inp_phd
; /* head of this list */
122 inp_gen_t inp_gencnt
; /* generation count of this instance */
123 int inp_flags
; /* generic IP/datagram flags */
126 u_char inp_vflag
; /* INP_IPV4 or INP_IPV6 */
128 u_char inp_ip_ttl
; /* time to live proto */
129 u_char inp_ip_p
; /* protocol proto */
130 /* protocol dependent part */
132 /* foreign host table entry */
133 struct in_addr_4in6 inp46_foreign
;
134 struct in6_addr inp6_foreign
;
137 /* local host table entry */
138 struct in_addr_4in6 inp46_local
;
139 struct in6_addr inp6_local
;
142 /* placeholder for routing entry */
143 struct route inp4_route
;
144 struct route_in6 inp6_route
;
147 /* type of service proto */
150 struct mbuf
*inp4_options
;
151 /* IP multicast options */
152 struct ip_moptions
*inp4_moptions
;
156 struct mbuf
*inp6_options
;
158 u_int8_t unused_uint8_1
;
159 ushort unused_uint16_1
;
160 /* IP6 options for outgoing packets */
161 struct ip6_pktopts
*inp6_outputopts
;
162 /* IP multicast options */
163 struct ip6_moptions
*inp6_moptions
;
164 /* ICMPv6 code type filter */
165 struct icmp6_filter
*inp6_icmp6filt
;
166 /* IPV6_CHECKSUM setsockopt */
168 u_short inp6_ifindex
;
172 int hash_element
; /* Array index of pcb's hash list */
173 caddr_t inp_saved_ppcb
; /* place to save pointer while cached */
174 struct inpcbpolicy
*inp_sp
;
175 #ifdef _KERN_LOCKS_H_
176 lck_mtx_t
*inpcb_mtx
; /* inpcb per-socket mutex */
180 u_long reserved
[2]; /* For future use */
183 #endif /* KERNEL_PRIVATE */
186 * The range of the generation count, as used in this implementation,
187 * is 9e19. We would have to create 300 billion connections per
188 * second for this number to roll over in a year. This seems sufficiently
189 * unlikely that we simply don't concern ourselves with that possibility.
193 * Interface exported to userland by various protocols which use
194 * inpcbs. Hack alert -- only define if struct xsocket is in scope.
198 * This is a copy of the inpcb as it shipped in Panther. This structure
199 * is filled out in a copy function. This allows the inpcb to change
200 * without breaking userland tools.
202 * CAUTION: Many fields may not be filled out. Fewer may be filled out
203 * in the future. Code defensively.
205 #ifdef KERNEL_PRIVATE
206 struct inpcb_compat
{
217 #endif /* KERNEL_PRIVATE */
218 LIST_ENTRY(inpcb
) inp_hash
; /* hash list */
219 struct in_addr reserved1
; /* APPLE reserved: inp_faddr defined in protcol indep. part */
220 struct in_addr reserved2
; /* APPLE reserved */
221 u_short inp_fport
; /* foreign port */
222 u_short inp_lport
; /* local port */
223 LIST_ENTRY(inpcb
) inp_list
; /* list for all PCBs of this proto */
224 caddr_t inp_ppcb
; /* pointer to per-protocol pcb */
225 struct inpcbinfo
*inp_pcbinfo
; /* PCB list info */
226 void* inp_socket
; /* back pointer to socket */
227 u_char nat_owner
; /* Used to NAT TCP/UDP traffic */
228 u_long nat_cookie
; /* Cookie stored and returned to NAT */
229 LIST_ENTRY(inpcb
) inp_portlist
; /* list for this PCB's local port */
230 struct inpcbport
*inp_phd
; /* head of this list */
231 inp_gen_t inp_gencnt
; /* generation count of this instance */
232 int inp_flags
; /* generic IP/datagram flags */
237 u_char inp_ip_ttl
; /* time to live proto */
238 u_char inp_ip_p
; /* protocol proto */
239 /* protocol dependent part */
241 /* foreign host table entry */
242 struct in_addr_4in6 inp46_foreign
;
243 struct in6_addr inp6_foreign
;
246 /* local host table entry */
247 struct in_addr_4in6 inp46_local
;
248 struct in6_addr inp6_local
;
251 /* placeholder for routing entry */
252 u_char inp4_route
[20];
253 u_char inp6_route
[32];
256 /* type of service proto */
259 struct mbuf
*inp4_options
;
260 /* IP multicast options */
261 struct ip_moptions
*inp4_moptions
;
266 struct mbuf
*inp6_options
;
268 u_int8_t unused_uint8_1
;
269 ushort unused_uint16_1
;
270 /* IP6 options for outgoing packets */
271 struct ip6_pktopts
*inp6_outputopts
;
272 /* IP multicast options */
273 struct ip6_moptions
*inp6_moptions
;
274 /* ICMPv6 code type filter */
275 struct icmp6_filter
*inp6_icmp6filt
;
276 /* IPV6_CHECKSUM setsockopt */
278 u_short inp6_ifindex
;
282 int hash_element
; /* Array index of pcb's hash list */
283 caddr_t inp_saved_ppcb
; /* place to save pointer while cached */
284 struct inpcbpolicy
*inp_sp
;
285 u_long reserved
[3]; /* For future use */
289 size_t xi_len
; /* length of this structure */
290 #ifdef KERNEL_PRIVATE
291 struct inpcb_compat xi_inp
;
295 struct xsocket xi_socket
;
296 u_quad_t xi_alignment_hack
;
300 size_t xig_len
; /* length of this structure */
301 u_int xig_count
; /* number of PCBs at this time */
302 inp_gen_t xig_gen
; /* generation count at this time */
303 so_gen_t xig_sogen
; /* socket generation count at this time */
307 * These defines are for use with the inpcb.
311 #define inp_faddr inp_dependfaddr.inp46_foreign.ia46_addr4
312 #define inp_laddr inp_dependladdr.inp46_local.ia46_addr4
313 #define inp_route inp_dependroute.inp4_route
314 #define inp_ip_tos inp_depend4.inp4_ip_tos
315 #define inp_options inp_depend4.inp4_options
316 #define inp_moptions inp_depend4.inp4_moptions
317 #define in6p_faddr inp_dependfaddr.inp6_foreign
318 #define in6p_laddr inp_dependladdr.inp6_local
319 #define in6p_route inp_dependroute.inp6_route
320 #define in6p_ip6_hlim inp_depend6.inp6_hlim
321 #define in6p_hops inp_depend6.inp6_hops /* default hop limit */
322 #define in6p_ip6_nxt inp_ip_p
323 #define in6p_flowinfo inp_flow
324 #define in6p_vflag inp_vflag
325 #define in6p_options inp_depend6.inp6_options
326 #define in6p_outputopts inp_depend6.inp6_outputopts
327 #define in6p_moptions inp_depend6.inp6_moptions
328 #define in6p_icmp6filt inp_depend6.inp6_icmp6filt
329 #define in6p_cksum inp_depend6.inp6_cksum
330 #define inp6_ifindex inp_depend6.inp6_ifindex
331 #define in6p_flags inp_flags /* for KAME src sync over BSD*'s */
332 #define in6p_socket inp_socket /* for KAME src sync over BSD*'s */
333 #define in6p_lport inp_lport /* for KAME src sync over BSD*'s */
334 #define in6p_fport inp_fport /* for KAME src sync over BSD*'s */
335 #define in6p_ppcb inp_ppcb /* for KAME src sync over BSD*'s */
336 #define in6p_state inp_state
337 #define in6p_wantcnt inp_wantcnt
339 #ifdef KERNEL_PRIVATE
341 LIST_ENTRY(inpcbport
) phd_hash
;
342 struct inpcbhead phd_pcblist
;
346 struct inpcbinfo
{ /* XXX documentation, prefixes */
347 struct inpcbhead
*hashbase
;
349 u_long hashsize
; /* in elements */
352 struct inpcbporthead
*porthashbase
;
354 struct inpcbhead
*listhead
;
358 void *ipi_zone
; /* zone to allocate pcbs from */
359 u_int ipi_count
; /* number of pcbs in this list */
360 u_quad_t ipi_gencnt
; /* current generation count */
363 struct socket nat_dummy_socket
; /* fake socket for NAT pcb backpointer */
364 struct inpcb
*nat_dummy_pcb
; /* fake pcb for finding NAT mutex */
366 #ifdef _KERN_LOCKS_H_
367 lck_attr_t
*mtx_attr
; /* mutex attributes */
368 lck_grp_t
*mtx_grp
; /* mutex group definition */
369 lck_grp_attr_t
*mtx_grp_attr
; /* mutex group attributes */
370 lck_rw_t
*mtx
; /* global mutex for the pcblist*/
372 void *mtx_attr
; /* mutex attributes */
373 void *mtx_grp
; /* mutex group definition */
374 void *mtx_grp_attr
; /* mutex group attributes */
375 void *mtx
; /* global mutex for the pcblist*/
380 #define INP_PCBHASH(faddr, lport, fport, mask) \
381 (((faddr) ^ ((faddr) >> 16) ^ ntohs((lport) ^ (fport))) & (mask))
382 #define INP_PCBPORTHASH(lport, mask) \
383 (ntohs((lport)) & (mask))
385 #endif /* KERNEL_PRIVATE */
387 /* flags in inp_flags: */
388 #define INP_RECVOPTS 0x01 /* receive incoming IP options */
389 #define INP_RECVRETOPTS 0x02 /* receive IP options for reply */
390 #define INP_RECVDSTADDR 0x04 /* receive IP dst address */
391 #define INP_HDRINCL 0x08 /* user supplies entire IP header */
392 #define INP_HIGHPORT 0x10 /* user wants "high" port binding */
393 #define INP_LOWPORT 0x20 /* user wants "low" port binding */
394 #define INP_ANONPORT 0x40 /* port chosen for user */
395 #define INP_RECVIF 0x80 /* receive incoming interface */
396 #define INP_MTUDISC 0x100 /* user can do MTU discovery */
398 #define INP_STRIPHDR 0x200 /* Strip headers in raw_ip, for OT support */
400 #define INP_FAITH 0x400 /* accept FAITH'ed connections */
401 #define INP_INADDR_ANY 0x800 /* local address wasn't specified */
403 #define INP_RECVTTL 0x1000
405 #define IN6P_IPV6_V6ONLY 0x008000 /* restrict AF_INET6 socket for v6 */
407 #define IN6P_PKTINFO 0x010000 /* receive IP6 dst and I/F */
408 #define IN6P_HOPLIMIT 0x020000 /* receive hoplimit */
409 #define IN6P_HOPOPTS 0x040000 /* receive hop-by-hop options */
410 #define IN6P_DSTOPTS 0x080000 /* receive dst options after rthdr */
411 #define IN6P_RTHDR 0x100000 /* receive routing header */
412 #define IN6P_RTHDRDSTOPTS 0x200000 /* receive dstoptions before rthdr */
413 #define IN6P_AUTOFLOWLABEL 0x800000 /* attach flowlabel automatically */
414 #define IN6P_BINDV6ONLY 0x10000000 /* do not grab IPv4 traffic */
416 #ifdef KERNEL_PRIVATE
417 #define INP_CONTROLOPTS (INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\
419 IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|\
420 IN6P_DSTOPTS|IN6P_RTHDR|IN6P_RTHDRDSTOPTS|\
421 IN6P_AUTOFLOWLABEL|INP_RECVTTL)
422 #define INP_UNMAPPABLEOPTS (IN6P_HOPOPTS|IN6P_DSTOPTS|IN6P_RTHDR|\
425 /* for KAME src sync over BSD*'s */
426 #define IN6P_HIGHPORT INP_HIGHPORT
427 #define IN6P_LOWPORT INP_LOWPORT
428 #define IN6P_ANONPORT INP_ANONPORT
429 #define IN6P_RECVIF INP_RECVIF
430 #define IN6P_MTUDISC INP_MTUDISC
431 #define IN6P_FAITH INP_FAITH
432 #define IN6P_CONTROLOPTS INP_CONTROLOPTS
434 * socket AF version is {newer than,or include}
435 * actual datagram AF version
438 #define INPLOOKUP_WILDCARD 1
440 #define INPCB_ALL_OWNERS 0xff
441 #define INPCB_NO_OWNER 0x0
442 #define INPCB_OWNED_BY_X 0x80
443 #define INPCB_MAX_IDS 7
444 #endif /* __APPLE__ */
446 #define sotoinpcb(so) ((struct inpcb *)(so)->so_pcb)
447 #define sotoin6pcb(so) sotoinpcb(so) /* for KAME src sync over BSD*'s */
449 #define INP_SOCKAF(so) so->so_proto->pr_domain->dom_family
451 #define INP_CHECK_SOCKAF(so, af) (INP_SOCKAF(so) == af)
454 extern int ipport_lowfirstauto
;
455 extern int ipport_lowlastauto
;
456 extern int ipport_firstauto
;
457 extern int ipport_lastauto
;
458 extern int ipport_hifirstauto
;
459 extern int ipport_hilastauto
;
461 #define INPCB_STATE_INUSE 0x1 /* freshly allocated PCB, it's in use */
462 #define INPCB_STATE_CACHED 0x2 /* this pcb is sitting in a a cache */
463 #define INPCB_STATE_DEAD 0x3 /* should treat as gone, will be garbage collected and freed */
465 #define WNT_STOPUSING 0xffff /* marked as ready to be garbaged collected, should be treated as not found */
466 #define WNT_ACQUIRE 0x1 /* that pcb is being acquired, do not recycle this time */
467 #define WNT_RELEASE 0x2 /* release acquired mode, can be garbage collected when wantcnt is null */
470 void in_pcbpurgeif0(struct inpcb
*, struct ifnet
*);
471 void in_losing(struct inpcb
*);
472 void in_rtchange(struct inpcb
*, int);
473 int in_pcballoc(struct socket
*, struct inpcbinfo
*, struct proc
*);
474 int in_pcbbind(struct inpcb
*, struct sockaddr
*, struct proc
*);
475 int in_pcbconnect(struct inpcb
*, struct sockaddr
*, struct proc
*);
476 void in_pcbdetach(struct inpcb
*);
477 void in_pcbdispose (struct inpcb
*);
478 void in_pcbdisconnect(struct inpcb
*);
479 int in_pcbinshash(struct inpcb
*, int);
480 int in_pcbladdr(struct inpcb
*, struct sockaddr
*, struct sockaddr_in
**);
482 in_pcblookup_local(struct inpcbinfo
*, struct in_addr
, u_int
, int);
484 in_pcblookup_hash(struct inpcbinfo
*,
485 struct in_addr
, u_int
, struct in_addr
, u_int
,
486 int, struct ifnet
*);
487 void in_pcbnotifyall(struct inpcbinfo
*, struct in_addr
,
488 int, void (*)(struct inpcb
*, int));
489 void in_pcbrehash(struct inpcb
*);
490 int in_setpeeraddr(struct socket
*so
, struct sockaddr
**nam
);
491 int in_setsockaddr(struct socket
*so
, struct sockaddr
**nam
);
492 int in_pcb_checkstate(struct inpcb
*pcb
, int mode
, int locked
);
495 in_pcb_grab_port (struct inpcbinfo
*pcbinfo
,
497 struct in_addr laddr
,
499 struct in_addr faddr
,
505 in_pcb_letgo_port(struct inpcbinfo
*pcbinfo
,
506 struct in_addr laddr
,
508 struct in_addr faddr
,
509 u_short fport
, u_char owner_id
);
512 in_pcb_get_owner(struct inpcbinfo
*pcbinfo
,
513 struct in_addr laddr
,
515 struct in_addr faddr
,
519 void in_pcb_nat_init(struct inpcbinfo
*pcbinfo
, int afamily
, int pfamily
,
523 in_pcb_new_share_client(struct inpcbinfo
*pcbinfo
, u_char
*owner_id
);
526 in_pcb_rem_share_client(struct inpcbinfo
*pcbinfo
, u_char owner_id
);
528 void in_pcbremlists(struct inpcb
*inp
);
529 int in_pcb_ckeckstate(struct inpcb
*, int, int);
530 void inpcb_to_compat(struct inpcb
*inp
, struct inpcb_compat
*inp_compat
);
533 #endif /* KERNEL_PRIVATE */
535 #endif /* !_NETINET_IN_PCB_H_ */