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$ 35 */ 36 37 #ifndef _NETINET_IN_PCB_H_ 38 #define _NETINET_IN_PCB_H_ 39 40 #include <sys/queue.h> 41 #include <sys/_lock.h> 42 #include <sys/_mutex.h> 43 44 #include <net/route.h> 45 46 #define in6pcb inpcb /* for KAME src sync over BSD*'s */ 47 #define in6p_sp inp_sp /* for KAME src sync over BSD*'s */ 48 struct inpcbpolicy; 49 50 /* 51 * Common structure pcb for internet protocol implementation. 52 * Here are stored pointers to local and foreign host table 53 * entries, local and foreign socket numbers, and pointers 54 * up (to a socket structure) and down (to a protocol-specific) 55 * control block. 56 */ 57 LIST_HEAD(inpcbhead, inpcb); 58 LIST_HEAD(inpcbporthead, inpcbport); 59 typedef u_quad_t inp_gen_t; 60 61 /* 62 * PCB with AF_INET6 null bind'ed laddr can receive AF_INET input packet. 63 * So, AF_INET6 null laddr is also used as AF_INET null laddr, 64 * by utilize following structure. (At last, same as INRIA) 65 */ 66 struct in_addr_4in6 { 67 u_int32_t ia46_pad32[3]; 68 struct in_addr ia46_addr4; 69 }; 70 71 /* 72 * NOTE: ipv6 addrs should be 64-bit aligned, per RFC 2553. 73 * in_conninfo has some extra padding to accomplish this. 74 */ 75 struct in_endpoints { 76 u_int16_t ie_fport; /* foreign port */ 77 u_int16_t ie_lport; /* local port */ 78 /* protocol dependent part, local and foreign addr */ 79 union { 80 /* foreign host table entry */ 81 struct in_addr_4in6 ie46_foreign; 82 struct in6_addr ie6_foreign; 83 } ie_dependfaddr; 84 union { 85 /* local host table entry */ 86 struct in_addr_4in6 ie46_local; 87 struct in6_addr ie6_local; 88 } ie_dependladdr; 89 #define ie_faddr ie_dependfaddr.ie46_foreign.ia46_addr4 90 #define ie_laddr ie_dependladdr.ie46_local.ia46_addr4 91 #define ie6_faddr ie_dependfaddr.ie6_foreign 92 #define ie6_laddr ie_dependladdr.ie6_local 93 }; 94 95 /* 96 * XXX 97 * At some point struct route should possibly change to: 98 * struct rtentry *rt 99 * struct in_endpoints *ie; 100 */ 101 struct in_conninfo { 102 u_int8_t inc_flags; 103 u_int8_t inc_len; 104 u_int16_t inc_pad; /* XXX alignment for in_endpoints */ 105 /* protocol dependent part; cached route */ 106 struct in_endpoints inc_ie; 107 union { 108 /* placeholder for routing entry */ 109 struct route inc4_route; 110 struct route_in6 inc6_route; 111 } inc_dependroute; 112 }; 113 #define inc_isipv6 inc_flags /* temp compatability */ 114 #define inc_fport inc_ie.ie_fport 115 #define inc_lport inc_ie.ie_lport 116 #define inc_faddr inc_ie.ie_faddr 117 #define inc_laddr inc_ie.ie_laddr 118 #define inc_route inc_dependroute.inc4_route 119 #define inc6_faddr inc_ie.ie6_faddr 120 #define inc6_laddr inc_ie.ie6_laddr 121 #define inc6_route inc_dependroute.inc6_route 122 123 struct icmp6_filter; 124 125 struct inpcb { 126 LIST_ENTRY(inpcb) inp_hash; /* hash list */ 127 LIST_ENTRY(inpcb) inp_list; /* list for all PCBs of this proto */ 128 u_int32_t inp_flow; 129 130 /* local and foreign ports, local and foreign addr */ 131 struct in_conninfo inp_inc; 132 133 caddr_t inp_ppcb; /* pointer to per-protocol pcb */ 134 struct inpcbinfo *inp_pcbinfo; /* PCB list info */ 135 struct socket *inp_socket; /* back pointer to socket */ 136 /* list for this PCB's local port */ 137 int inp_flags; /* generic IP/datagram flags */ 138 139 struct inpcbpolicy *inp_sp; /* for IPSEC */ 140 u_char inp_vflag; /* IP version flag (v4/v6) */ 141 #define INP_IPV4 0x1 142 #define INP_IPV6 0x2 143 u_char inp_ip_ttl; /* time to live proto */ 144 u_char inp_ip_p; /* protocol proto */ 145 146 /* protocol dependent part; options */ 147 struct { 148 u_char inp4_ip_tos; /* type of service proto */ 149 struct mbuf *inp4_options; /* IP options */ 150 struct ip_moptions *inp4_moptions; /* IP multicast options */ 151 } inp_depend4; 152 #define inp_fport inp_inc.inc_fport 153 #define inp_lport inp_inc.inc_lport 154 #define inp_faddr inp_inc.inc_faddr 155 #define inp_laddr inp_inc.inc_laddr 156 #define inp_route inp_inc.inc_route 157 #define inp_ip_tos inp_depend4.inp4_ip_tos 158 #define inp_options inp_depend4.inp4_options 159 #define inp_moptions inp_depend4.inp4_moptions 160 struct { 161 /* IP options */ 162 struct mbuf *inp6_options; 163 /* IP6 options for outgoing packets */ 164 struct ip6_pktopts *inp6_outputopts; 165 /* IP multicast options */ 166 struct ip6_moptions *inp6_moptions; 167 /* ICMPv6 code type filter */ 168 struct icmp6_filter *inp6_icmp6filt; 169 /* IPV6_CHECKSUM setsockopt */ 170 int inp6_cksum; 171 u_short inp6_ifindex; 172 short inp6_hops; 173 u_int8_t inp6_hlim; 174 } inp_depend6; 175 LIST_ENTRY(inpcb) inp_portlist; 176 struct inpcbport *inp_phd; /* head of this list */ 177 inp_gen_t inp_gencnt; /* generation count of this instance */ 178 struct mtx inp_mtx; 179 180 #define in6p_faddr inp_inc.inc6_faddr 181 #define in6p_laddr inp_inc.inc6_laddr 182 #define in6p_route inp_inc.inc6_route 183 #define in6p_ip6_hlim inp_depend6.inp6_hlim 184 #define in6p_hops inp_depend6.inp6_hops /* default hop limit */ 185 #define in6p_ip6_nxt inp_ip_p 186 #define in6p_flowinfo inp_flow 187 #define in6p_vflag inp_vflag 188 #define in6p_options inp_depend6.inp6_options 189 #define in6p_outputopts inp_depend6.inp6_outputopts 190 #define in6p_moptions inp_depend6.inp6_moptions 191 #define in6p_icmp6filt inp_depend6.inp6_icmp6filt 192 #define in6p_cksum inp_depend6.inp6_cksum 193 #define inp6_ifindex inp_depend6.inp6_ifindex 194 #define in6p_flags inp_flags /* for KAME src sync over BSD*'s */ 195 #define in6p_socket inp_socket /* for KAME src sync over BSD*'s */ 196 #define in6p_lport inp_lport /* for KAME src sync over BSD*'s */ 197 #define in6p_fport inp_fport /* for KAME src sync over BSD*'s */ 198 #define in6p_ppcb inp_ppcb /* for KAME src sync over BSD*'s */ 199 }; 200 /* 201 * The range of the generation count, as used in this implementation, 202 * is 9e19. We would have to create 300 billion connections per 203 * second for this number to roll over in a year. This seems sufficiently 204 * unlikely that we simply don't concern ourselves with that possibility. 205 */ 206 207 /* 208 * Interface exported to userland by various protocols which use 209 * inpcbs. Hack alert -- only define if struct xsocket is in scope. 210 */ 211 #ifdef _SYS_SOCKETVAR_H_ 212 struct xinpcb { 213 size_t xi_len; /* length of this structure */ 214 struct inpcb xi_inp; 215 struct xsocket xi_socket; 216 u_quad_t xi_alignment_hack; 217 }; 218 219 struct xinpgen { 220 size_t xig_len; /* length of this structure */ 221 u_int xig_count; /* number of PCBs at this time */ 222 inp_gen_t xig_gen; /* generation count at this time */ 223 so_gen_t xig_sogen; /* socket generation count at this time */ 224 }; 225 #endif /* _SYS_SOCKETVAR_H_ */ 226 227 struct inpcbport { 228 LIST_ENTRY(inpcbport) phd_hash; 229 struct inpcbhead phd_pcblist; 230 u_short phd_port; 231 }; 232 233 struct inpcbinfo { /* XXX documentation, prefixes */ 234 struct inpcbhead *hashbase; 235 u_long hashmask; 236 struct inpcbporthead *porthashbase; 237 u_long porthashmask; 238 struct inpcbhead *listhead; 239 u_short lastport; 240 u_short lastlow; 241 u_short lasthi; 242 struct uma_zone *ipi_zone; /* zone to allocate pcbs from */ 243 u_int ipi_count; /* number of pcbs in this list */ 244 u_quad_t ipi_gencnt; /* current generation count */ 245 struct mtx ipi_mtx; 246 }; 247 248 #define INP_LOCK_INIT(inp, d) \ 249 mtx_init(&(inp)->inp_mtx, (d), NULL, MTX_DEF | MTX_RECURSE | MTX_DUPOK) 250 #define INP_LOCK_DESTROY(inp) mtx_destroy(&(inp)->inp_mtx) 251 #define INP_LOCK(inp) mtx_lock(&(inp)->inp_mtx) 252 #define INP_UNLOCK(inp) mtx_unlock(&(inp)->inp_mtx) 253 254 #define INP_INFO_LOCK_INIT(ipi, d) \ 255 mtx_init(&(ipi)->ipi_mtx, (d), NULL, MTX_DEF | MTX_RECURSE) 256 #define INP_INFO_RLOCK(ipi) mtx_lock(&(ipi)->ipi_mtx) 257 #define INP_INFO_WLOCK(ipi) mtx_lock(&(ipi)->ipi_mtx) 258 #define INP_INFO_RUNLOCK(ipi) mtx_unlock(&(ipi)->ipi_mtx) 259 #define INP_INFO_WUNLOCK(ipi) mtx_unlock(&(ipi)->ipi_mtx) 260 261 #define INP_PCBHASH(faddr, lport, fport, mask) \ 262 (((faddr) ^ ((faddr) >> 16) ^ ntohs((lport) ^ (fport))) & (mask)) 263 #define INP_PCBPORTHASH(lport, mask) \ 264 (ntohs((lport)) & (mask)) 265 266 /* flags in inp_flags: */ 267 #define INP_RECVOPTS 0x01 /* receive incoming IP options */ 268 #define INP_RECVRETOPTS 0x02 /* receive IP options for reply */ 269 #define INP_RECVDSTADDR 0x04 /* receive IP dst address */ 270 #define INP_HDRINCL 0x08 /* user supplies entire IP header */ 271 #define INP_HIGHPORT 0x10 /* user wants "high" port binding */ 272 #define INP_LOWPORT 0x20 /* user wants "low" port binding */ 273 #define INP_ANONPORT 0x40 /* port chosen for user */ 274 #define INP_RECVIF 0x80 /* receive incoming interface */ 275 #define INP_MTUDISC 0x100 /* user can do MTU discovery */ 276 #define INP_FAITH 0x200 /* accept FAITH'ed connections */ 277 278 #define IN6P_IPV6_V6ONLY 0x008000 /* restrict AF_INET6 socket for v6 */ 279 280 #define IN6P_PKTINFO 0x010000 /* receive IP6 dst and I/F */ 281 #define IN6P_HOPLIMIT 0x020000 /* receive hoplimit */ 282 #define IN6P_HOPOPTS 0x040000 /* receive hop-by-hop options */ 283 #define IN6P_DSTOPTS 0x080000 /* receive dst options after rthdr */ 284 #define IN6P_RTHDR 0x100000 /* receive routing header */ 285 #define IN6P_RTHDRDSTOPTS 0x200000 /* receive dstoptions before rthdr */ 286 #define IN6P_AUTOFLOWLABEL 0x800000 /* attach flowlabel automatically */ 287 288 #define INP_CONTROLOPTS (INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\ 289 INP_RECVIF|\ 290 IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|\ 291 IN6P_DSTOPTS|IN6P_RTHDR|IN6P_RTHDRDSTOPTS|\ 292 IN6P_AUTOFLOWLABEL) 293 #define INP_UNMAPPABLEOPTS (IN6P_HOPOPTS|IN6P_DSTOPTS|IN6P_RTHDR|\ 294 IN6P_AUTOFLOWLABEL) 295 296 /* for KAME src sync over BSD*'s */ 297 #define IN6P_HIGHPORT INP_HIGHPORT 298 #define IN6P_LOWPORT INP_LOWPORT 299 #define IN6P_ANONPORT INP_ANONPORT 300 #define IN6P_RECVIF INP_RECVIF 301 #define IN6P_MTUDISC INP_MTUDISC 302 #define IN6P_FAITH INP_FAITH 303 #define IN6P_CONTROLOPTS INP_CONTROLOPTS 304 /* 305 * socket AF version is {newer than,or include} 306 * actual datagram AF version 307 */ 308 309 #define INPLOOKUP_WILDCARD 1 310 #define sotoinpcb(so) ((struct inpcb *)(so)->so_pcb) 311 #define sotoin6pcb(so) sotoinpcb(so) /* for KAME src sync over BSD*'s */ 312 313 #define INP_SOCKAF(so) so->so_proto->pr_domain->dom_family 314 315 #define INP_CHECK_SOCKAF(so, af) (INP_SOCKAF(so) == af) 316 317 #ifdef _KERNEL 318 extern int ipport_lowfirstauto; 319 extern int ipport_lowlastauto; 320 extern int ipport_firstauto; 321 extern int ipport_lastauto; 322 extern int ipport_hifirstauto; 323 extern int ipport_hilastauto; 324 325 void in_pcbpurgeif0(struct inpcbinfo *, struct ifnet *); 326 void in_losing(struct inpcb *); 327 struct inpcb * 328 in_rtchange(struct inpcb *, int); 329 int in_pcballoc(struct socket *, struct inpcbinfo *, struct thread *); 330 int in_pcbbind(struct inpcb *, struct sockaddr *, struct thread *); 331 int in_pcbbind_setup(struct inpcb *, struct sockaddr *, in_addr_t *, 332 u_short *, struct thread *); 333 int in_pcbconnect(struct inpcb *, struct sockaddr *, struct thread *); 334 int in_pcbconnect_setup(struct inpcb *, struct sockaddr *, in_addr_t *, 335 u_short *, in_addr_t *, u_short *, struct inpcb **, 336 struct thread *); 337 void in_pcbdetach(struct inpcb *); 338 void in_pcbdisconnect(struct inpcb *); 339 int in_pcbinshash(struct inpcb *); 340 struct inpcb * 341 in_pcblookup_local(struct inpcbinfo *, 342 struct in_addr, u_int, int); 343 struct inpcb * 344 in_pcblookup_hash(struct inpcbinfo *, struct in_addr, u_int, 345 struct in_addr, u_int, int, struct ifnet *); 346 void in_pcbnotifyall(struct inpcbinfo *pcbinfo, struct in_addr, 347 int, struct inpcb *(*)(struct inpcb *, int)); 348 void in_pcbrehash(struct inpcb *); 349 int in_setpeeraddr(struct socket *so, struct sockaddr **nam, struct inpcbinfo *pcbinfo); 350 int in_setsockaddr(struct socket *so, struct sockaddr **nam, struct inpcbinfo *pcbinfo);; 351 struct sockaddr * 352 in_sockaddr(in_port_t port, struct in_addr *addr); 353 void in_pcbremlists(struct inpcb *inp); 354 int prison_xinpcb(struct thread *td, struct inpcb *inp); 355 #endif /* _KERNEL */ 356 357 #endif /* !_NETINET_IN_PCB_H_ */ 358