xref: /dragonfly/sys/netinet/in_pcb.h (revision c9f721c2)
1 /*
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 /*
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 $
85  * $DragonFly: src/sys/netinet/in_pcb.h,v 1.16 2004/08/11 02:36:22 dillon Exp $
86  */
87 
88 #ifndef _NETINET_IN_PCB_H_
89 #define _NETINET_IN_PCB_H_
90 
91 #include <sys/queue.h>
92 
93 #include <net/route.h>
94 
95 #define	in6pcb		inpcb	/* for KAME src sync over BSD*'s */
96 #define	in6p_sp		inp_sp	/* for KAME src sync over BSD*'s */
97 struct inpcbpolicy;
98 
99 /*
100  * Common structure pcb for internet protocol implementation.
101  * Here are stored pointers to local and foreign host table
102  * entries, local and foreign socket numbers, and pointers
103  * up (to a socket structure) and down (to a protocol-specific)
104  * control block.
105  */
106 LIST_HEAD(inpcbhead, inpcb);
107 LIST_HEAD(inpcbporthead, inpcbport);
108 typedef	u_quad_t	inp_gen_t;
109 
110 struct inpcontainer {
111 	struct inpcb			*ic_inp;
112 	LIST_ENTRY(inpcontainer)	ic_list;
113 };
114 LIST_HEAD(inpcontainerhead, inpcontainer);
115 
116 /*
117  * PCB with AF_INET6 null bind'ed laddr can receive AF_INET input packet.
118  * So, AF_INET6 null laddr is also used as AF_INET null laddr,
119  * by utilize following structure. (At last, same as INRIA)
120  */
121 struct in_addr_4in6 {
122 	u_int32_t	ia46_pad32[3];
123 	struct	in_addr	ia46_addr4;
124 };
125 
126 /*
127  * NOTE: ipv6 addrs should be 64-bit aligned, per RFC 2553.
128  * in_conninfo has some extra padding to accomplish this.
129  */
130 struct in_endpoints {
131 	u_int16_t	ie_fport;		/* foreign port */
132 	u_int16_t	ie_lport;		/* local port */
133 	/* protocol dependent part, local and foreign addr */
134 	union {
135 		/* foreign host table entry */
136 		struct	in_addr_4in6 ie46_foreign;
137 		struct	in6_addr ie6_foreign;
138 	} ie_dependfaddr;
139 	union {
140 		/* local host table entry */
141 		struct	in_addr_4in6 ie46_local;
142 		struct	in6_addr ie6_local;
143 	} ie_dependladdr;
144 #define	ie_faddr	ie_dependfaddr.ie46_foreign.ia46_addr4
145 #define	ie_laddr	ie_dependladdr.ie46_local.ia46_addr4
146 #define	ie6_faddr	ie_dependfaddr.ie6_foreign
147 #define	ie6_laddr	ie_dependladdr.ie6_local
148 };
149 
150 /*
151  * XXX
152  * At some point struct route should possibly change to:
153  *   struct rtentry *rt
154  *   struct in_endpoints *ie;
155  */
156 struct in_conninfo {
157 	u_int8_t	inc_flags;
158 	u_int8_t	inc_len;
159 	u_int16_t	inc_pad;	/* XXX alignment for in_endpoints */
160 	/* protocol dependent part; cached route */
161 	struct	in_endpoints inc_ie;
162 	union {
163 		/* placeholder for routing entry */
164 		struct	route inc4_route;
165 		struct	route_in6 inc6_route;
166 	} inc_dependroute;
167 };
168 #define inc_isipv6	inc_flags	/* temp compatibility */
169 #define	inc_fport	inc_ie.ie_fport
170 #define	inc_lport	inc_ie.ie_lport
171 #define	inc_faddr	inc_ie.ie_faddr
172 #define	inc_laddr	inc_ie.ie_laddr
173 #define	inc_route	inc_dependroute.inc4_route
174 #define	inc6_faddr	inc_ie.ie6_faddr
175 #define	inc6_laddr	inc_ie.ie6_laddr
176 #define	inc6_route	inc_dependroute.inc6_route
177 
178 /*
179  * NB: the zone allocator is type-stable EXCEPT FOR THE FIRST TWO LONGS
180  * of the structure.  Therefore, it is important that the members in
181  * that position not contain any information which is required to be
182  * stable.
183  */
184 struct	icmp6_filter;
185 
186 struct inpcb {
187 	LIST_ENTRY(inpcb) inp_hash; /* hash list */
188 	LIST_ENTRY(inpcb) inp_list; /* list for all PCBs of this proto */
189 	u_int32_t	inp_flow;
190 
191 	/* local and foreign ports, local and foreign addr */
192 	struct	in_conninfo inp_inc;
193 
194 	caddr_t	inp_ppcb;		/* pointer to per-protocol pcb */
195 	struct	inpcbinfo *inp_pcbinfo;	/* PCB list info */
196 	struct	inpcbinfo *inp_cpcbinfo;/* back pointer for connection table */
197 	struct	socket *inp_socket;	/* back pointer to socket */
198 					/* list for this PCB's local port */
199 	int	inp_flags;		/* generic IP/datagram flags */
200 
201 	struct	inpcbpolicy *inp_sp; /* for IPSEC */
202 	u_char	inp_vflag;
203 #define	INP_IPV4	0x1
204 #define	INP_IPV6	0x2
205 	u_char	inp_ip_ttl;		/* time to live proto */
206 	u_char	inp_ip_p;		/* protocol proto */
207 
208 	/* protocol dependent part; options */
209 	struct {
210 		u_char	inp4_ip_tos;		/* type of service proto */
211 		struct	mbuf *inp4_options;	/* IP options */
212 		struct	ip_moptions *inp4_moptions; /* IP multicast options */
213 	} inp_depend4;
214 #define inp_fport	inp_inc.inc_fport
215 #define inp_lport	inp_inc.inc_lport
216 #define	inp_faddr	inp_inc.inc_faddr
217 #define	inp_laddr	inp_inc.inc_laddr
218 #define	inp_route	inp_inc.inc_route
219 #define	inp_ip_tos	inp_depend4.inp4_ip_tos
220 #define	inp_options	inp_depend4.inp4_options
221 #define	inp_moptions	inp_depend4.inp4_moptions
222 	struct {
223 		/* IP options */
224 		struct	mbuf *inp6_options;
225 		/* IP6 options for outgoing packets */
226 		struct	ip6_pktopts *inp6_outputopts;
227 		/* IP multicast options */
228 		struct	ip6_moptions *inp6_moptions;
229 		/* ICMPv6 code type filter */
230 		struct	icmp6_filter *inp6_icmp6filt;
231 		/* IPV6_CHECKSUM setsockopt */
232 		int	inp6_cksum;
233 		u_short	inp6_ifindex;
234 		short	inp6_hops;
235 		u_int8_t	inp6_hlim;
236 	} inp_depend6;
237 	LIST_ENTRY(inpcb) inp_portlist;
238 	struct	inpcbport *inp_phd;	/* head of this list */
239 	inp_gen_t	inp_gencnt;	/* generation count of this instance */
240 #define	in6p_faddr	inp_inc.inc6_faddr
241 #define	in6p_laddr	inp_inc.inc6_laddr
242 #define	in6p_route	inp_inc.inc6_route
243 #define	in6p_ip6_hlim	inp_depend6.inp6_hlim
244 #define	in6p_hops	inp_depend6.inp6_hops	/* default hop limit */
245 #define	in6p_ip6_nxt	inp_ip_p
246 #define	in6p_flowinfo	inp_flow
247 #define	in6p_vflag	inp_vflag
248 #define	in6p_options	inp_depend6.inp6_options
249 #define	in6p_outputopts	inp_depend6.inp6_outputopts
250 #define	in6p_moptions	inp_depend6.inp6_moptions
251 #define	in6p_icmp6filt	inp_depend6.inp6_icmp6filt
252 #define	in6p_cksum	inp_depend6.inp6_cksum
253 #define	inp6_ifindex	inp_depend6.inp6_ifindex
254 #define	in6p_flags	inp_flags  /* for KAME src sync over BSD*'s */
255 #define	in6p_socket	inp_socket  /* for KAME src sync over BSD*'s */
256 #define	in6p_lport	inp_lport  /* for KAME src sync over BSD*'s */
257 #define	in6p_fport	inp_fport  /* for KAME src sync over BSD*'s */
258 #define	in6p_ppcb	inp_ppcb  /* for KAME src sync over BSD*'s */
259 };
260 /*
261  * The range of the generation count, as used in this implementation,
262  * is 9e19.  We would have to create 300 billion connections per
263  * second for this number to roll over in a year.  This seems sufficiently
264  * unlikely that we simply don't concern ourselves with that possibility.
265  */
266 
267 /*
268  * Interface exported to userland by various protocols which use
269  * inpcbs.  Hack alert -- only define if struct xsocket is in scope.
270  */
271 #ifdef _SYS_SOCKETVAR_H_
272 struct	xinpcb {
273 	size_t	xi_len;		/* length of this structure */
274 	struct	inpcb xi_inp;
275 	struct	xsocket xi_socket;
276 	u_quad_t	xi_alignment_hack;
277 };
278 
279 struct	xinpgen {
280 	size_t	xig_len;	/* length of this structure */
281 	u_int	xig_count;	/* number of PCBs at this time */
282 	inp_gen_t xig_gen;	/* generation count at this time */
283 	so_gen_t xig_sogen;	/* socket generation count at this time */
284 	int	xig_cpu;	/* cpu containing additional info */
285 };
286 #endif /* _SYS_SOCKETVAR_H_ */
287 
288 struct inpcbport {
289 	LIST_ENTRY(inpcbport) phd_hash;
290 	struct inpcbhead phd_pcblist;
291 	u_short phd_port;
292 };
293 
294 struct inpcbinfo {		/* XXX documentation, prefixes */
295 	struct	inpcbhead *hashbase;
296 	u_long	hashmask;
297 	struct	inpcbporthead *porthashbase;
298 	u_long	porthashmask;
299 	struct	inpcontainerhead *wildcardhashbase;
300 	u_long	wildcardhashmask;
301 	struct	inpcbhead pcblisthead;	/* head of queue of active pcb's */
302 	u_short	lastport;
303 	u_short	lastlow;
304 	u_short	lasthi;
305 	struct	vm_zone *ipi_zone; /* zone to allocate pcbs from */
306 	u_int	ipi_count;	/* number of pcbs in this list */
307 	u_quad_t ipi_gencnt;	/* current generation count */
308 	int	cpu;		/* related protocol thread cpu or -1 */
309 };
310 
311 
312 #define	INP_PCBCONNHASH(faddr, fport, laddr, lport, mask)		\
313     (((faddr) ^ ((faddr) >> 16) ^ (laddr) ^ ntohs((lport) ^ (fport))) & (mask))
314 
315 #define	INP_PCBPORTHASH(lport, mask)		(ntohs(lport) & (mask))
316 
317 #define	INP_PCBWILDCARDHASH(lport, mask)	(ntohs(lport) & (mask))
318 
319 /* flags in inp_flags: */
320 #define	INP_RECVOPTS		0x01	/* receive incoming IP options */
321 #define	INP_RECVRETOPTS		0x02	/* receive IP options for reply */
322 #define	INP_RECVDSTADDR		0x04	/* receive IP dst address */
323 #define	INP_HDRINCL		0x08	/* user supplies entire IP header */
324 #define	INP_HIGHPORT		0x10	/* user wants "high" port binding */
325 #define	INP_LOWPORT		0x20	/* user wants "low" port binding */
326 #define	INP_ANONPORT		0x40	/* port chosen for user */
327 #define	INP_RECVIF		0x80	/* receive incoming interface */
328 #define	INP_MTUDISC		0x100	/* user can do MTU discovery */
329 #define	INP_FAITH		0x200	/* accept FAITH'ed connections */
330 #define	INP_WILDCARD		0x400	/* wildcard match */
331 #define	INP_WILDCARD_MP		0x800	/* distributed wildcard match */
332 #define	INP_CONNECTED		0x1000	/* exact match */
333 #define	INP_WASBOUND_NOTANY	0x2000	/* was bound to non-null laddr */
334 #define INP_PLACEMARKER		0x4000	/* skip this pcb, its a placemarker */
335 
336 #define IN6P_IPV6_V6ONLY	0x008000 /* restrict AF_INET6 socket for v6 */
337 
338 #define	IN6P_PKTINFO		0x010000 /* receive IP6 dst and I/F */
339 #define	IN6P_HOPLIMIT		0x020000 /* receive hoplimit */
340 #define	IN6P_HOPOPTS		0x040000 /* receive hop-by-hop options */
341 #define	IN6P_DSTOPTS		0x080000 /* receive dst options after rthdr */
342 #define	IN6P_RTHDR		0x100000 /* receive routing header */
343 #define	IN6P_RTHDRDSTOPTS	0x200000 /* receive dstoptions before rthdr */
344 #define IN6P_AUTOFLOWLABEL	0x800000 /* attach flowlabel automatically */
345 
346 #define	INP_CONTROLOPTS		(INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\
347 					INP_RECVIF|\
348 				 IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|\
349 				 IN6P_DSTOPTS|IN6P_RTHDR|IN6P_RTHDRDSTOPTS|\
350 				 IN6P_AUTOFLOWLABEL)
351 #define	INP_UNMAPPABLEOPTS	(IN6P_HOPOPTS|IN6P_DSTOPTS|IN6P_RTHDR|\
352 				 IN6P_AUTOFLOWLABEL)
353 
354  /* for KAME src sync over BSD*'s */
355 #define	IN6P_HIGHPORT		INP_HIGHPORT
356 #define	IN6P_LOWPORT		INP_LOWPORT
357 #define	IN6P_ANONPORT		INP_ANONPORT
358 #define	IN6P_RECVIF		INP_RECVIF
359 #define	IN6P_MTUDISC		INP_MTUDISC
360 #define	IN6P_FAITH		INP_FAITH
361 #define	IN6P_CONTROLOPTS INP_CONTROLOPTS
362 	/*
363 	 * socket AF version is {newer than,or include}
364 	 * actual datagram AF version
365 	 */
366 
367 #define	INPLOOKUP_WILDCARD	1
368 #define	sotoinpcb(so)	((struct inpcb *)(so)->so_pcb)
369 #define	sotoin6pcb(so)	sotoinpcb(so) /* for KAME src sync over BSD*'s */
370 
371 #define	INP_SOCKAF(so) so->so_proto->pr_domain->dom_family
372 
373 #define	INP_CHECK_SOCKAF(so, af) 	(INP_SOCKAF(so) == af)
374 
375 #ifdef _KERNEL
376 extern int	ipport_lowfirstauto;
377 extern int	ipport_lowlastauto;
378 extern int	ipport_firstauto;
379 extern int	ipport_lastauto;
380 extern int	ipport_hifirstauto;
381 extern int	ipport_hilastauto;
382 
383 void	in_pcbpurgeif0 (struct inpcb *, struct ifnet *);
384 void	in_losing (struct inpcb *);
385 void	in_rtchange (struct inpcb *, int);
386 void	in_pcbinfo_init (struct inpcbinfo *);
387 int	in_pcballoc (struct socket *, struct inpcbinfo *);
388 int	in_pcbbind (struct inpcb *, struct sockaddr *, struct thread *);
389 int	in_pcbconnect (struct inpcb *, struct sockaddr *, struct thread *);
390 void	in_pcbdetach (struct inpcb *);
391 void	in_pcbdisconnect (struct inpcb *);
392 void	in_pcbinswildcardhash(struct inpcb *inp);
393 void	in_pcbinswildcardhash_oncpu(struct inpcb *, struct inpcbinfo *);
394 void	in_pcbinsconnhash(struct inpcb *inp);
395 int	in_pcbinsporthash (struct inpcb *);
396 int	in_pcbladdr (struct inpcb *, struct sockaddr *,
397 	    struct sockaddr_in **);
398 struct inpcb *
399 	in_pcblookup_local (struct inpcbinfo *,
400 	    struct in_addr, u_int, int);
401 struct inpcb *
402 	in_pcblookup_hash (struct inpcbinfo *,
403 			       struct in_addr, u_int, struct in_addr, u_int,
404 			       int, struct ifnet *);
405 void	in_pcbnotifyall (struct inpcbhead *, struct in_addr,
406 	    int, void (*)(struct inpcb *, int));
407 int	in_setpeeraddr (struct socket *so, struct sockaddr **nam);
408 int	in_setsockaddr (struct socket *so, struct sockaddr **nam);
409 void	in_pcbremwildcardhash(struct inpcb *inp);
410 void	in_pcbremwildcardhash_oncpu(struct inpcb *, struct inpcbinfo *);
411 void	in_pcbremconnhash(struct inpcb *inp);
412 void	in_pcbremlists (struct inpcb *inp);
413 int	prison_xinpcb (struct thread *p, struct inpcb *inp);
414 #endif /* _KERNEL */
415 
416 #endif /* !_NETINET_IN_PCB_H_ */
417