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