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
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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
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
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
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 $
70 #ifndef _NETINET_IN_PCB_H_
71 #define _NETINET_IN_PCB_H_
74 #include <sys/queue.h>
76 #ifndef _SYS_SYSCTL_H_
77 #include <sys/sysctl.h>
79 #ifndef _NETINET_IN_H_
80 #include <netinet/in.h>
83 #include <net/route.h>
86 #define in6pcb inpcb /* for KAME src sync over BSD*'s */
87 #define in6p_sp inp_sp /* for KAME src sync over BSD*'s */
91 * Common structure pcb for internet protocol implementation.
92 * Here are stored pointers to local and foreign host table
93 * entries, local and foreign socket numbers, and pointers
94 * up (to a socket structure) and down (to a protocol-specific)
97 LIST_HEAD(inpcbhead, inpcb);
98 LIST_HEAD(inpcbporthead, inpcbport);
99 typedef u_quad_t inp_gen_t;
101 struct inpcontainer {
102 struct inpcb *ic_inp;
103 LIST_ENTRY(inpcontainer) ic_list;
105 LIST_HEAD(inpcontainerhead, inpcontainer);
108 * PCB with AF_INET6 null bind'ed laddr can receive AF_INET input packet.
109 * So, AF_INET6 null laddr is also used as AF_INET null laddr,
110 * by utilize following structure. (At last, same as INRIA)
112 struct in_addr_4in6 {
113 u_int32_t ia46_pad32[3];
114 struct in_addr ia46_addr4;
117 union in_dependaddr {
118 struct in_addr_4in6 id46_addr;
119 struct in6_addr id6_addr;
123 * NOTE: ipv6 addrs should be 64-bit aligned, per RFC 2553.
124 * in_conninfo has some extra padding to accomplish this.
126 struct in_endpoints {
127 u_int16_t ie_fport; /* foreign port */
128 u_int16_t ie_lport; /* local port */
129 /* protocol dependent part, local and foreign addr */
130 union in_dependaddr ie_dependfaddr; /* foreign host table entry */
131 union in_dependaddr ie_dependladdr; /* local host table entry */
132 #define ie_faddr ie_dependfaddr.id46_addr.ia46_addr4
133 #define ie_laddr ie_dependladdr.id46_addr.ia46_addr4
134 #define ie6_faddr ie_dependfaddr.id6_addr
135 #define ie6_laddr ie_dependladdr.id6_addr
138 struct inp_localgroup {
139 LIST_ENTRY(inp_localgroup) il_list;
144 union in_dependaddr il_dependladdr;
145 #define il_laddr il_dependladdr.id46_addr.ia46_addr4
146 #define il6_laddr il_dependladdr.id6_addr
147 int il_inpsiz; /* size of il_inp[] */
148 int il_inpcnt; /* # of elem in il_inp[] */
149 struct inpcb *il_inp[];
151 LIST_HEAD(inp_localgrphead, inp_localgroup);
155 * At some point struct route should possibly change to:
157 * struct in_endpoints *ie;
162 u_int16_t inc_pad; /* XXX alignment for in_endpoints */
163 /* protocol dependent part; cached route */
164 struct in_endpoints inc_ie;
166 /* placeholder for routing entry */
167 struct route inc4_route;
168 struct route_in6 inc6_route;
171 #define inc_isipv6 inc_flags /* temp compatibility */
172 #define inc_fport inc_ie.ie_fport
173 #define inc_lport inc_ie.ie_lport
174 #define inc_faddr inc_ie.ie_faddr
175 #define inc_laddr inc_ie.ie_laddr
176 #define inc_route inc_dependroute.inc4_route
177 #define inc6_faddr inc_ie.ie6_faddr
178 #define inc6_laddr inc_ie.ie6_laddr
179 #define inc6_route inc_dependroute.inc6_route
182 * NB: the zone allocator is type-stable EXCEPT FOR THE FIRST TWO LONGS
183 * of the structure. Therefore, it is important that the members in
184 * that position not contain any information which is required to be
188 struct inpcbportinfo;
191 LIST_ENTRY(inpcb) inp_hash; /* hash list */
192 LIST_ENTRY(inpcb) inp_list; /* list for all PCBs of this proto */
194 int inp_lgrpindex; /* local group index */
196 /* local and foreign ports, local and foreign addr */
197 struct in_conninfo inp_inc;
199 void *inp_ppcb; /* pointer to per-protocol pcb */
200 struct inpcbinfo *inp_pcbinfo; /* PCB list info */
201 struct socket *inp_socket; /* back pointer to socket */
202 /* list for this PCB's local port */
203 int inp_flags; /* generic IP/datagram flags */
205 struct inpcbpolicy *inp_sp; /* for IPSEC */
209 u_char inp_ip_ttl; /* time to live proto */
210 u_char inp_ip_p; /* protocol proto */
211 u_char inp_ip_minttl; /* minimum TTL or drop */
213 /* protocol dependent part; options */
215 u_char inp4_ip_tos; /* type of service proto */
216 struct mbuf *inp4_options; /* IP options */
217 struct ip_moptions *inp4_moptions; /* IP multicast options */
219 #define inp_fport inp_inc.inc_fport
220 #define inp_lport inp_inc.inc_lport
221 #define inp_faddr inp_inc.inc_faddr
222 #define inp_laddr inp_inc.inc_laddr
223 #define inp_route inp_inc.inc_route
224 #define inp_ip_tos inp_depend4.inp4_ip_tos
225 #define inp_options inp_depend4.inp4_options
226 #define inp_moptions inp_depend4.inp4_moptions
229 struct mbuf *inp6_options;
230 /* IP6 options for outgoing packets */
231 struct ip6_pktopts *inp6_outputopts;
232 /* IP multicast options */
233 struct ip6_moptions *inp6_moptions;
234 /* ICMPv6 code type filter */
235 struct icmp6_filter *inp6_icmp6filt;
236 /* IPV6_CHECKSUM setsockopt */
238 u_short inp6_ifindex;
242 LIST_ENTRY(inpcb) inp_portlist;
243 struct inpcbportinfo *inp_portinfo;
244 struct inpcbport *inp_phd; /* head of this list */
245 inp_gen_t inp_gencnt; /* generation count of this instance */
246 #define in6p_faddr inp_inc.inc6_faddr
247 #define in6p_laddr inp_inc.inc6_laddr
248 #define in6p_route inp_inc.inc6_route
249 #define in6p_ip6_hlim inp_depend6.inp6_hlim
250 #define in6p_hops inp_depend6.inp6_hops /* default hop limit */
251 #define in6p_ip6_nxt inp_ip_p
252 #define in6p_flowinfo inp_flow
253 #define in6p_vflag inp_vflag
254 #define in6p_options inp_depend6.inp6_options
255 #define in6p_outputopts inp_depend6.inp6_outputopts
256 #define in6p_moptions inp_depend6.inp6_moptions
257 #define in6p_icmp6filt inp_depend6.inp6_icmp6filt
258 #define in6p_cksum inp_depend6.inp6_cksum
259 #define inp6_ifindex inp_depend6.inp6_ifindex
260 #define in6p_flags inp_flags /* for KAME src sync over BSD*'s */
261 #define in6p_socket inp_socket /* for KAME src sync over BSD*'s */
262 #define in6p_lport inp_lport /* for KAME src sync over BSD*'s */
263 #define in6p_fport inp_fport /* for KAME src sync over BSD*'s */
264 #define in6p_ppcb inp_ppcb /* for KAME src sync over BSD*'s */
269 * The range of the generation count, as used in this implementation,
270 * is 9e19. We would have to create 300 billion connections per
271 * second for this number to roll over in a year. This seems sufficiently
272 * unlikely that we simply don't concern ourselves with that possibility.
276 * Interface exported to userland by various protocols which use
277 * inpcbs. Hack alert -- only define if struct xsocket is in scope.
279 #ifdef _SYS_SOCKETVAR_H_
281 size_t xi_len; /* length of this structure */
283 struct xsocket xi_socket;
284 u_quad_t xi_alignment_hack;
286 #endif /* _SYS_SOCKETVAR_H_ */
289 LIST_ENTRY(inpcbport) phd_hash;
290 struct inpcbhead phd_pcblist;
296 struct inpcbportinfo {
297 struct lwkt_token *porttoken; /* if this inpcbportinfo is shared */
298 struct inpcbporthead *porthashbase;
306 struct inpcbinfo { /* XXX documentation, prefixes */
307 struct lwkt_token *infotoken; /* if this inpcbinfo is shared */
308 struct inpcbhead *hashbase;
311 struct inpcbportinfo *portinfo;
312 struct inpcbport *portsave; /* port allocation cache */
313 struct inpcontainerhead *wildcardhashbase;
314 u_long wildcardhashmask;
315 struct inp_localgrphead *localgrphashbase;
316 u_long localgrphashmask;
317 struct inpcbhead pcblisthead; /* head of queue of active pcb's */
318 size_t ipi_size; /* allocation size for pcbs */
319 u_int ipi_count; /* number of pcbs in this list */
320 int cpu; /* related protocol thread cpu */
321 u_quad_t ipi_gencnt; /* current generation count */
325 #define INP_PCBCONNHASH(faddr, fport, laddr, lport, mask) \
326 (((faddr) ^ ((faddr) >> 16) ^ (laddr) ^ ntohs((lport) ^ (fport))) & (mask))
328 #define INP_PCBPORTHASH(lport, mask) (ntohs(lport) & (mask))
330 #define INP_PCBWILDCARDHASH(lport, mask) (ntohs(lport) & (mask))
332 #define INP_PCBLOCALGRPHASH(lport, mask) (ntohs(lport) & (mask))
334 /* flags in inp_flags: */
335 #define INP_RECVOPTS 0x01 /* receive incoming IP options */
336 #define INP_RECVRETOPTS 0x02 /* receive IP options for reply */
337 #define INP_RECVDSTADDR 0x04 /* receive IP dst address */
338 #define INP_HDRINCL 0x08 /* user supplies entire IP header */
339 #define INP_HIGHPORT 0x10 /* user wants "high" port binding */
340 #define INP_LOWPORT 0x20 /* user wants "low" port binding */
341 #define INP_ANONPORT 0x40 /* port chosen for user */
342 #define INP_RECVIF 0x80 /* receive incoming interface */
343 #define INP_MTUDISC 0x100 /* user can do MTU discovery */
344 #define INP_FAITH 0x200 /* accept FAITH'ed connections */
345 #define INP_WILDCARD 0x400 /* wildcard match */
347 #define INP_CONNECTED 0x1000 /* exact match */
348 #define INP_FLAG_PROTO1 0x2000 /* protocol specific */
349 #define INP_PLACEMARKER 0x4000 /* skip this pcb, its a placemarker */
351 #define IN6P_IPV6_V6ONLY 0x008000 /* restrict AF_INET6 socket for v6 */
353 #define IN6P_PKTINFO 0x010000 /* receive IP6 dst and I/F */
354 #define IN6P_HOPLIMIT 0x020000 /* receive hoplimit */
355 #define IN6P_HOPOPTS 0x040000 /* receive hop-by-hop options */
356 #define IN6P_DSTOPTS 0x080000 /* receive dst options after rthdr */
357 #define IN6P_RTHDR 0x100000 /* receive routing header */
358 #define IN6P_RTHDRDSTOPTS 0x200000 /* receive dstoptions before rthdr */
359 #define IN6P_AUTOFLOWLABEL 0x800000 /* attach flowlabel automatically */
363 #define IN6P_TCLASS 0x400000 /* receive traffic class value */
364 #define IN6P_RFC2292 0x40000000 /* used RFC2292 API on the socket */
365 #define IN6P_MTU 0x80000000 /* receive path MTU */
367 /* 0x10000000 unused */
368 #define INP_ONLIST 0x20000000 /* on pcblist */
369 #define INP_RECVTTL 0x80000000 /* receive incoming IP TTL */
371 #define INP_CONTROLOPTS (INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\
372 INP_RECVIF|INP_RECVTTL|\
373 IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|\
374 IN6P_DSTOPTS|IN6P_RTHDR|IN6P_RTHDRDSTOPTS|\
375 IN6P_TCLASS|IN6P_AUTOFLOWLABEL|IN6P_RFC2292|\
378 #define INP_UNMAPPABLEOPTS (IN6P_HOPOPTS|IN6P_DSTOPTS|IN6P_RTHDR|\
379 IN6P_TCLASS|IN6P_AUTOFLOWLABEL)
381 /* for KAME src sync over BSD*'s */
382 #define IN6P_HIGHPORT INP_HIGHPORT
383 #define IN6P_LOWPORT INP_LOWPORT
384 #define IN6P_ANONPORT INP_ANONPORT
385 #define IN6P_RECVIF INP_RECVIF
386 #define IN6P_MTUDISC INP_MTUDISC
387 #define IN6P_FAITH INP_FAITH
388 #define IN6P_CONTROLOPTS INP_CONTROLOPTS
390 * socket AF version is {newer than,or include}
391 * actual datagram AF version
394 #define INPLOOKUP_WILDCARD 1
395 #define sotoinpcb(so) ((struct inpcb *)(so)->so_pcb)
396 #define sotoin6pcb(so) sotoinpcb(so) /* for KAME src sync over BSD*'s */
398 /* macros for handling bitmap of ports not to allocate dynamically */
399 #define DP_MAPBITS (sizeof(u_int32_t) * NBBY)
400 #define DP_MAPSIZE (howmany(65536, DP_MAPBITS))
401 #define DP_SET(m, p) ((m)[(p) / DP_MAPBITS] |= (1 << ((p) % DP_MAPBITS)))
402 #define DP_CLR(m, p) ((m)[(p) / DP_MAPBITS] &= ~(1 << ((p) % DP_MAPBITS)))
403 #define DP_ISSET(m, p) ((m)[(p) / DP_MAPBITS] & (1 << ((p) % DP_MAPBITS)))
405 /* default values for baddynamicports [see ip_init()] */
406 #define DEFBADDYNAMICPORTS_TCP { \
407 587, 749, 750, 751, 871, 2049, \
408 6000, 6001, 6002, 6003, 6004, 6005, 6006, 6007, 6008, 6009, 6010, \
410 #define DEFBADDYNAMICPORTS_UDP { 623, 664, 749, 750, 751, 2049, 0 }
412 struct baddynamicports {
413 u_int32_t tcp[DP_MAPSIZE];
414 u_int32_t udp[DP_MAPSIZE];
418 #define INP_SOCKAF(so) so->so_proto->pr_domain->dom_family
420 #define INP_CHECK_SOCKAF(so, af) (INP_SOCKAF(so) == af)
424 #define GET_PORT_TOKEN(portinfo) \
426 if ((portinfo)->porttoken) \
427 lwkt_gettoken((portinfo)->porttoken); \
430 #define REL_PORT_TOKEN(portinfo) \
432 if ((portinfo)->porttoken) \
433 lwkt_reltoken((portinfo)->porttoken); \
437 #define ASSERT_PORT_TOKEN_HELD(portinfo) \
439 if ((portinfo)->porttoken) \
440 ASSERT_LWKT_TOKEN_HELD((portinfo)->porttoken); \
442 #else /* !INVARIANTS */
443 #define ASSERT_PORT_TOKEN_HELD(portinfo)
444 #endif /* INVARIANTS */
446 #define GET_PCBINFO_TOKEN(pcbinfo) \
448 if ((pcbinfo)->infotoken) \
449 lwkt_gettoken((pcbinfo)->infotoken); \
452 #define REL_PCBINFO_TOKEN(pcbinfo) \
454 if ((pcbinfo)->infotoken) \
455 lwkt_reltoken((pcbinfo)->infotoken); \
459 #define ASSERT_PCBINFO_TOKEN_HELD(pcbinfo) \
461 if ((pcbinfo)->infotoken) \
462 ASSERT_LWKT_TOKEN_HELD((pcbinfo)->infotoken); \
464 #else /* !INVARIANTS */
465 #define ASSERT_PCBINFO_TOKEN_HELD(pcbinfo)
466 #endif /* INVARIANTS */
468 extern int ipport_lowfirstauto;
469 extern int ipport_lowlastauto;
470 extern int ipport_firstauto;
471 extern int ipport_lastauto;
472 extern int ipport_hifirstauto;
473 extern int ipport_hilastauto;
478 void in_pcbportrange(u_short *, u_short *, u_short, u_short);
479 void in_pcbpurgeif0 (struct inpcbinfo *, struct ifnet *);
480 void in_losing (struct inpcb *);
481 void in_rtchange (struct inpcb *, int);
482 void in_pcbinfo_init (struct inpcbinfo *, int, boolean_t);
483 void in_pcbportinfo_init (struct inpcbportinfo *, int, boolean_t, u_short);
484 int in_pcballoc (struct socket *, struct inpcbinfo *);
485 void in_pcbunlink (struct inpcb *, struct inpcbinfo *);
486 void in_pcbunlink_flags (struct inpcb *, struct inpcbinfo *, int);
487 void in_pcblink (struct inpcb *, struct inpcbinfo *);
488 void in_pcblink_flags (struct inpcb *, struct inpcbinfo *, int);
489 void in_pcbonlist (struct inpcb *);
490 void in_pcbofflist (struct inpcb *);
491 int in_pcbbind (struct inpcb *, struct sockaddr *, struct thread *);
492 int in_pcbbind_remote(struct inpcb *, const struct sockaddr *,
494 int in_pcbconnect (struct inpcb *, struct sockaddr *, struct thread *);
495 void in_pcbdetach (struct inpcb *);
496 void in_pcbdisconnect (struct inpcb *);
497 void in_pcbinswildcardhash(struct inpcb *inp);
498 void in_pcbinswildcardhash_oncpu(struct inpcb *, struct inpcbinfo *);
499 void in_pcbinsconnhash(struct inpcb *inp);
500 void in_pcbinsporthash (struct inpcbportinfo *, struct inpcb *);
501 void in_pcbinsporthash_lport (struct inpcb *);
502 int in_pcbladdr (struct inpcb *, struct sockaddr *,
503 struct sockaddr_in **, struct thread *);
504 int in_pcbladdr_find (struct inpcb *, struct sockaddr *,
505 struct sockaddr_in **, struct thread *, int);
507 in_pcblookup_local (struct inpcbportinfo *, struct in_addr, u_int, int,
510 in_pcblookup_hash (struct inpcbinfo *,
511 struct in_addr, u_int, struct in_addr, u_int,
512 boolean_t, struct ifnet *);
514 in_pcblookup_pkthash (struct inpcbinfo *,
515 struct in_addr, u_int, struct in_addr, u_int,
516 boolean_t, struct ifnet *, const struct mbuf *);
517 void in_pcbnotifyall (struct inpcbinfo *, struct in_addr,
518 int, void (*)(struct inpcb *, int));
519 int in_setpeeraddr (struct socket *so, struct sockaddr **nam);
520 void in_setpeeraddr_dispatch(union netmsg *);
521 int in_setsockaddr (struct socket *so, struct sockaddr **nam);
522 void in_setsockaddr_dispatch(netmsg_t msg);
523 int in_baddynamic(u_int16_t, u_int16_t);
524 void in_pcbremwildcardhash(struct inpcb *inp);
525 void in_pcbremwildcardhash_oncpu(struct inpcb *, struct inpcbinfo *);
526 void in_pcbremconnhash(struct inpcb *inp);
527 void in_pcbremlists (struct inpcb *inp);
528 int prison_xinpcb (struct thread *p, struct inpcb *inp);
529 void in_savefaddr (struct socket *so, const struct sockaddr *faddr);
531 in_pcblocalgroup_last(const struct inpcbinfo *, const struct inpcb *);
532 void in_pcbglobalinit(void);
534 int in_pcblist_global(SYSCTL_HANDLER_ARGS);
535 int in_pcblist_global_ncpus2(SYSCTL_HANDLER_ARGS);
538 in_pcbmarker(int cpuid);
539 struct inpcontainer *
540 in_pcbcontainer_marker(int cpuid);
544 #endif /* !_NETINET_IN_PCB_H_ */