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