HAMMER 60I/Many: Mirroring
[dragonfly.git] / sys / netinet / in_pcb.h
blob5c9528bf0b3ab37b6054aa2329b75ea9f3d580bc
1 /*
2 * Copyright (c) 2004 Jeffrey M. Hsu. All rights reserved.
3 * Copyright (c) 2004 The DragonFly Project. All rights reserved.
5 * This code is derived from software contributed to The DragonFly Project
6 * by Jeffrey M. Hsu.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of The DragonFly Project nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific, prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
30 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
35 * Copyright (c) 1982, 1986, 1990, 1993
36 * The Regents of the University of California. All rights reserved.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
41 * 1. Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
46 * 3. All advertising materials mentioning features or use of this software
47 * must display the following acknowledgement:
48 * This product includes software developed by the University of
49 * California, Berkeley and its contributors.
50 * 4. Neither the name of the University nor the names of its contributors
51 * may be used to endorse or promote products derived from this software
52 * without specific prior written permission.
54 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
60 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
64 * SUCH DAMAGE.
66 * @(#)in_pcb.h 8.1 (Berkeley) 6/10/93
67 * $FreeBSD: src/sys/netinet/in_pcb.h,v 1.32.2.7 2003/01/24 05:11:34 sam Exp $
68 * $DragonFly: src/sys/netinet/in_pcb.h,v 1.23 2007/04/04 06:13:26 dillon Exp $
71 #ifndef _NETINET_IN_PCB_H_
72 #define _NETINET_IN_PCB_H_
74 #ifndef _SYS_QUEUE_H_
75 #include <sys/queue.h>
76 #endif
77 #ifndef _SYS_SYSCTL_H_
78 #include <sys/sysctl.h>
79 #endif
80 #ifndef _NETINET_IN_H_
81 #include <netinet/in.h>
82 #endif
83 #ifndef _NET_ROUTE_H_
84 #include <net/route.h>
85 #endif
87 #define in6pcb inpcb /* for KAME src sync over BSD*'s */
88 #define in6p_sp inp_sp /* for KAME src sync over BSD*'s */
89 struct inpcbpolicy;
92 * Common structure pcb for internet protocol implementation.
93 * Here are stored pointers to local and foreign host table
94 * entries, local and foreign socket numbers, and pointers
95 * up (to a socket structure) and down (to a protocol-specific)
96 * control block.
98 LIST_HEAD(inpcbhead, inpcb);
99 LIST_HEAD(inpcbporthead, inpcbport);
100 typedef u_quad_t inp_gen_t;
102 struct inpcontainer {
103 struct inpcb *ic_inp;
104 LIST_ENTRY(inpcontainer) ic_list;
106 LIST_HEAD(inpcontainerhead, inpcontainer);
109 * PCB with AF_INET6 null bind'ed laddr can receive AF_INET input packet.
110 * So, AF_INET6 null laddr is also used as AF_INET null laddr,
111 * by utilize following structure. (At last, same as INRIA)
113 struct in_addr_4in6 {
114 u_int32_t ia46_pad32[3];
115 struct in_addr ia46_addr4;
119 * NOTE: ipv6 addrs should be 64-bit aligned, per RFC 2553.
120 * in_conninfo has some extra padding to accomplish this.
122 struct in_endpoints {
123 u_int16_t ie_fport; /* foreign port */
124 u_int16_t ie_lport; /* local port */
125 /* protocol dependent part, local and foreign addr */
126 union {
127 /* foreign host table entry */
128 struct in_addr_4in6 ie46_foreign;
129 struct in6_addr ie6_foreign;
130 } ie_dependfaddr;
131 union {
132 /* local host table entry */
133 struct in_addr_4in6 ie46_local;
134 struct in6_addr ie6_local;
135 } ie_dependladdr;
136 #define ie_faddr ie_dependfaddr.ie46_foreign.ia46_addr4
137 #define ie_laddr ie_dependladdr.ie46_local.ia46_addr4
138 #define ie6_faddr ie_dependfaddr.ie6_foreign
139 #define ie6_laddr ie_dependladdr.ie6_local
143 * XXX
144 * At some point struct route should possibly change to:
145 * struct rtentry *rt
146 * struct in_endpoints *ie;
148 struct in_conninfo {
149 u_int8_t inc_flags;
150 u_int8_t inc_len;
151 u_int16_t inc_pad; /* XXX alignment for in_endpoints */
152 /* protocol dependent part; cached route */
153 struct in_endpoints inc_ie;
154 union {
155 /* placeholder for routing entry */
156 struct route inc4_route;
157 struct route_in6 inc6_route;
158 } inc_dependroute;
160 #define inc_isipv6 inc_flags /* temp compatibility */
161 #define inc_fport inc_ie.ie_fport
162 #define inc_lport inc_ie.ie_lport
163 #define inc_faddr inc_ie.ie_faddr
164 #define inc_laddr inc_ie.ie_laddr
165 #define inc_route inc_dependroute.inc4_route
166 #define inc6_faddr inc_ie.ie6_faddr
167 #define inc6_laddr inc_ie.ie6_laddr
168 #define inc6_route inc_dependroute.inc6_route
171 * NB: the zone allocator is type-stable EXCEPT FOR THE FIRST TWO LONGS
172 * of the structure. Therefore, it is important that the members in
173 * that position not contain any information which is required to be
174 * stable.
176 struct icmp6_filter;
178 struct inpcb {
179 LIST_ENTRY(inpcb) inp_hash; /* hash list */
180 LIST_ENTRY(inpcb) inp_list; /* list for all PCBs of this proto */
181 u_int32_t inp_flow;
183 /* local and foreign ports, local and foreign addr */
184 struct in_conninfo inp_inc;
186 void *inp_ppcb; /* pointer to per-protocol pcb */
187 struct inpcbinfo *inp_pcbinfo; /* PCB list info */
188 struct inpcbinfo *inp_cpcbinfo;/* back pointer for connection table */
189 struct socket *inp_socket; /* back pointer to socket */
190 /* list for this PCB's local port */
191 int inp_flags; /* generic IP/datagram flags */
193 struct inpcbpolicy *inp_sp; /* for IPSEC */
194 u_char inp_vflag;
195 #define INP_IPV4 0x1
196 #define INP_IPV6 0x2
197 u_char inp_ip_ttl; /* time to live proto */
198 u_char inp_ip_p; /* protocol proto */
199 u_char inp_ip_minttl; /* minimum TTL or drop */
201 /* protocol dependent part; options */
202 struct {
203 u_char inp4_ip_tos; /* type of service proto */
204 struct mbuf *inp4_options; /* IP options */
205 struct ip_moptions *inp4_moptions; /* IP multicast options */
206 } inp_depend4;
207 #define inp_fport inp_inc.inc_fport
208 #define inp_lport inp_inc.inc_lport
209 #define inp_faddr inp_inc.inc_faddr
210 #define inp_laddr inp_inc.inc_laddr
211 #define inp_route inp_inc.inc_route
212 #define inp_ip_tos inp_depend4.inp4_ip_tos
213 #define inp_options inp_depend4.inp4_options
214 #define inp_moptions inp_depend4.inp4_moptions
215 struct {
216 /* IP options */
217 struct mbuf *inp6_options;
218 /* IP6 options for outgoing packets */
219 struct ip6_pktopts *inp6_outputopts;
220 /* IP multicast options */
221 struct ip6_moptions *inp6_moptions;
222 /* ICMPv6 code type filter */
223 struct icmp6_filter *inp6_icmp6filt;
224 /* IPV6_CHECKSUM setsockopt */
225 int inp6_cksum;
226 u_short inp6_ifindex;
227 short inp6_hops;
228 u_int8_t inp6_hlim;
229 } inp_depend6;
230 LIST_ENTRY(inpcb) inp_portlist;
231 struct inpcbport *inp_phd; /* head of this list */
232 inp_gen_t inp_gencnt; /* generation count of this instance */
233 #define in6p_faddr inp_inc.inc6_faddr
234 #define in6p_laddr inp_inc.inc6_laddr
235 #define in6p_route inp_inc.inc6_route
236 #define in6p_ip6_hlim inp_depend6.inp6_hlim
237 #define in6p_hops inp_depend6.inp6_hops /* default hop limit */
238 #define in6p_ip6_nxt inp_ip_p
239 #define in6p_flowinfo inp_flow
240 #define in6p_vflag inp_vflag
241 #define in6p_options inp_depend6.inp6_options
242 #define in6p_outputopts inp_depend6.inp6_outputopts
243 #define in6p_moptions inp_depend6.inp6_moptions
244 #define in6p_icmp6filt inp_depend6.inp6_icmp6filt
245 #define in6p_cksum inp_depend6.inp6_cksum
246 #define inp6_ifindex inp_depend6.inp6_ifindex
247 #define in6p_flags inp_flags /* for KAME src sync over BSD*'s */
248 #define in6p_socket inp_socket /* for KAME src sync over BSD*'s */
249 #define in6p_lport inp_lport /* for KAME src sync over BSD*'s */
250 #define in6p_fport inp_fport /* for KAME src sync over BSD*'s */
251 #define in6p_ppcb inp_ppcb /* for KAME src sync over BSD*'s */
254 * The range of the generation count, as used in this implementation,
255 * is 9e19. We would have to create 300 billion connections per
256 * second for this number to roll over in a year. This seems sufficiently
257 * unlikely that we simply don't concern ourselves with that possibility.
261 * Interface exported to userland by various protocols which use
262 * inpcbs. Hack alert -- only define if struct xsocket is in scope.
264 #ifdef _SYS_SOCKETVAR_H_
265 struct xinpcb {
266 size_t xi_len; /* length of this structure */
267 struct inpcb xi_inp;
268 struct xsocket xi_socket;
269 u_quad_t xi_alignment_hack;
271 #endif /* _SYS_SOCKETVAR_H_ */
273 struct inpcbport {
274 LIST_ENTRY(inpcbport) phd_hash;
275 struct inpcbhead phd_pcblist;
276 u_short phd_port;
279 struct inpcbinfo { /* XXX documentation, prefixes */
280 struct inpcbhead *hashbase;
281 u_long hashmask;
282 struct inpcbporthead *porthashbase;
283 u_long porthashmask;
284 struct inpcontainerhead *wildcardhashbase;
285 u_long wildcardhashmask;
286 struct inpcbhead pcblisthead; /* head of queue of active pcb's */
287 u_short lastport;
288 u_short lastlow;
289 u_short lasthi;
290 struct vm_zone *ipi_zone; /* zone to allocate pcbs from */
291 u_int ipi_count; /* number of pcbs in this list */
292 u_quad_t ipi_gencnt; /* current generation count */
293 int cpu; /* related protocol thread cpu or -1 */
297 #define INP_PCBCONNHASH(faddr, fport, laddr, lport, mask) \
298 (((faddr) ^ ((faddr) >> 16) ^ (laddr) ^ ntohs((lport) ^ (fport))) & (mask))
300 #define INP_PCBPORTHASH(lport, mask) (ntohs(lport) & (mask))
302 #define INP_PCBWILDCARDHASH(lport, mask) (ntohs(lport) & (mask))
304 /* flags in inp_flags: */
305 #define INP_RECVOPTS 0x01 /* receive incoming IP options */
306 #define INP_RECVRETOPTS 0x02 /* receive IP options for reply */
307 #define INP_RECVDSTADDR 0x04 /* receive IP dst address */
308 #define INP_HDRINCL 0x08 /* user supplies entire IP header */
309 #define INP_HIGHPORT 0x10 /* user wants "high" port binding */
310 #define INP_LOWPORT 0x20 /* user wants "low" port binding */
311 #define INP_ANONPORT 0x40 /* port chosen for user */
312 #define INP_RECVIF 0x80 /* receive incoming interface */
313 #define INP_MTUDISC 0x100 /* user can do MTU discovery */
314 #define INP_FAITH 0x200 /* accept FAITH'ed connections */
315 #define INP_WILDCARD 0x400 /* wildcard match */
316 #define INP_WILDCARD_MP 0x800 /* distributed wildcard match */
317 #define INP_CONNECTED 0x1000 /* exact match */
318 #define INP_WASBOUND_NOTANY 0x2000 /* was bound to non-null laddr */
319 #define INP_PLACEMARKER 0x4000 /* skip this pcb, its a placemarker */
321 #define IN6P_IPV6_V6ONLY 0x008000 /* restrict AF_INET6 socket for v6 */
323 #define IN6P_PKTINFO 0x010000 /* receive IP6 dst and I/F */
324 #define IN6P_HOPLIMIT 0x020000 /* receive hoplimit */
325 #define IN6P_HOPOPTS 0x040000 /* receive hop-by-hop options */
326 #define IN6P_DSTOPTS 0x080000 /* receive dst options after rthdr */
327 #define IN6P_RTHDR 0x100000 /* receive routing header */
328 #define IN6P_RTHDRDSTOPTS 0x200000 /* receive dstoptions before rthdr */
329 #define IN6P_AUTOFLOWLABEL 0x800000 /* attach flowlabel automatically */
331 #define INP_RECVTTL 0x80000000 /* receive incoming IP TTL */
333 #define INP_CONTROLOPTS (INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\
334 INP_RECVIF|INP_RECVTTL|\
335 IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|\
336 IN6P_DSTOPTS|IN6P_RTHDR|IN6P_RTHDRDSTOPTS|\
337 IN6P_AUTOFLOWLABEL)
338 #define INP_UNMAPPABLEOPTS (IN6P_HOPOPTS|IN6P_DSTOPTS|IN6P_RTHDR|\
339 IN6P_AUTOFLOWLABEL)
341 /* for KAME src sync over BSD*'s */
342 #define IN6P_HIGHPORT INP_HIGHPORT
343 #define IN6P_LOWPORT INP_LOWPORT
344 #define IN6P_ANONPORT INP_ANONPORT
345 #define IN6P_RECVIF INP_RECVIF
346 #define IN6P_MTUDISC INP_MTUDISC
347 #define IN6P_FAITH INP_FAITH
348 #define IN6P_CONTROLOPTS INP_CONTROLOPTS
350 * socket AF version is {newer than,or include}
351 * actual datagram AF version
354 #define INPLOOKUP_WILDCARD 1
355 #define sotoinpcb(so) ((struct inpcb *)(so)->so_pcb)
356 #define sotoin6pcb(so) sotoinpcb(so) /* for KAME src sync over BSD*'s */
358 #define INP_SOCKAF(so) so->so_proto->pr_domain->dom_family
360 #define INP_CHECK_SOCKAF(so, af) (INP_SOCKAF(so) == af)
362 #ifdef _KERNEL
363 extern int ipport_lowfirstauto;
364 extern int ipport_lowlastauto;
365 extern int ipport_firstauto;
366 extern int ipport_lastauto;
367 extern int ipport_hifirstauto;
368 extern int ipport_hilastauto;
370 void in_pcbpurgeif0 (struct inpcb *, struct ifnet *);
371 void in_losing (struct inpcb *);
372 void in_rtchange (struct inpcb *, int);
373 void in_pcbinfo_init (struct inpcbinfo *);
374 int in_pcballoc (struct socket *, struct inpcbinfo *);
375 int in_pcbbind (struct inpcb *, struct sockaddr *, struct thread *);
376 int in_pcbconnect (struct inpcb *, struct sockaddr *, struct thread *);
377 void in_pcbdetach (struct inpcb *);
378 void in_pcbdisconnect (struct inpcb *);
379 void in_pcbinswildcardhash(struct inpcb *inp);
380 void in_pcbinswildcardhash_oncpu(struct inpcb *, struct inpcbinfo *);
381 void in_pcbinsconnhash(struct inpcb *inp);
382 int in_pcbinsporthash (struct inpcb *);
383 int in_pcbladdr (struct inpcb *, struct sockaddr *,
384 struct sockaddr_in **, struct thread *);
385 struct inpcb *
386 in_pcblookup_local (struct inpcbinfo *, struct in_addr, u_int, int,
387 struct ucred *);
388 struct inpcb *
389 in_pcblookup_hash (struct inpcbinfo *,
390 struct in_addr, u_int, struct in_addr, u_int,
391 int, struct ifnet *);
392 void in_pcbnotifyall (struct inpcbhead *, struct in_addr,
393 int, void (*)(struct inpcb *, int));
394 int in_setpeeraddr (struct socket *so, struct sockaddr **nam);
395 int in_setsockaddr (struct socket *so, struct sockaddr **nam);
396 void in_pcbremwildcardhash(struct inpcb *inp);
397 void in_pcbremwildcardhash_oncpu(struct inpcb *, struct inpcbinfo *);
398 void in_pcbremconnhash(struct inpcb *inp);
399 void in_pcbremlists (struct inpcb *inp);
400 int prison_xinpcb (struct thread *p, struct inpcb *inp);
402 int in_pcblist_global(SYSCTL_HANDLER_ARGS);
403 #endif /* _KERNEL */
405 #endif /* !_NETINET_IN_PCB_H_ */